.NET MVC4 實訓記錄之五（訪問自定義資源文件）

　　.Net平台下工作好幾年了，資源文件么，大多數使用的是.resx文件。它是個好東西，很容易上手，工作效率高，性能穩定。使用.resx文件，會在編譯期動態生成已文件名命名的靜態類，因此它的訪問速度當然是最快的。但是它也有個最大的缺點，就是修改資源文件后，項目必須重新編譯，否則修改的資源不能被識別。這對於維護期的工作來講，非常麻煩。尤其是已經上線的項目，即使是修改一個title的顯示，也需要停掉項目。由於本人做了好幾年的維護，應該是從工作到現在，一直沒有間斷過的做維護項目，因此深受其害！必須找到一個方案，規避掉這個令人頭疼的問題。

　　好了，鋪墊的夠多了，進入正題：使用自定義XML文件作為資源，完成本地化、國際化（該篇參考Artech的如何讓ASP.NET默認的資源編程方式支持非.ResX資源存儲）。

　　首先，我們需要一個資源訪問接口，IResourceManager。它提供一組返回資源內容的方法簽名：

    /// <summary>
    /// 資源訪問接口
    /// </summary>
    public interface IResourceManager
    {
        /// <summary>
        /// 從資源文件中獲取資源
        /// </summary>
        /// <param name="name">資源名稱</param>
        /// <returns></returns>
        string GetString(string name);

        /// <summary>
        /// 從資源文件中獲取資源
        /// </summary>
        /// <param name="name">資源名稱</param>
        /// <param name="culture">區域語言設置</param>
        /// <returns></returns>
        string GetString(string name, CultureInfo culture);

　　接下來實現這個接口（注意，我們還需要實現System.Resources.ResourceManager，因為這個類提供了“回溯”訪問資源的功能，這對我們是非常有用的）

    public class XmlResourceManager : System.Resources.ResourceManager, IResourceManager
    {
        #region Constants
        
        private const string _CACHE_KEY = "_RESOURCES_CACHE_KEY_{0}_{1}";
        private const string extension = ".xml";

        #endregion


        #region Variables

        private string baseName;
        
        #endregion


        #region Properties

        /// <summary>
        /// 資源文件路徑
        /// </summary>
        public string Directory { get; private set; }
        
        /// <summary>
        /// 資源文件基類名（不包含國家區域碼）。
        /// 覆蓋基類的實現
        /// </summary>
        public override string BaseName
        {
            get { return baseName; }
        }

        /// <summary>
        /// 資源節點名稱
        /// </summary>
        public string NodeName { get; private set; }

        #endregion


        #region Constructor

        [Microsoft.Practices.Unity.InjectionConstructor]
        public XmlResourceManager(string directory, string baseName, string nodeName)
        {
            this.Directory = System.Web.HttpRuntime.AppDomainAppPath + directory;
            this.baseName = baseName;
            this.NodeName = nodeName;

            base.IgnoreCase = true;     //資源獲取時忽略大小寫
        }

        #endregion


        #region Functions

        /// <summary>
        /// 獲取資源文件名
        /// </summary>
        /// <param name="culture">國家區域碼</param>
        /// <returns></returns>
        protected override string GetResourceFileName(CultureInfo culture)
        {
            string fileName = string.Format("{0}.{1}.{2}", this.baseName, culture, extension.TrimStart('.'));
            string path = Path.Combine(this.Directory, fileName);
            if (File.Exists(path))
            {
                return path;
            }
            return Path.Combine(this.Directory, string.Format("{0}.{1}", baseName, extension.TrimStart('.')));
        }


        /// <summary>
        /// 獲取特定語言環境下的資源集合
        /// 該方法使用了服務端高速緩存，以避免頻繁的IO訪問。
        /// </summary>
        /// <param name="culture">國家區域碼</param>
        /// <param name="createIfNotExists">是否主動創建</param>
        /// <param name="tryParents">是否返回父級資源</param>
        /// <returns></returns>
        protected override ResourceSet InternalGetResourceSet(CultureInfo culture, bool createIfNotExists, bool tryParents)
        {
            string cacheKey = string.Format(_CACHE_KEY, BaseName, culture.LCID);      //緩存鍵值
            XmlResourceSet resourceSet = CacheHelper.GetCache(cacheKey) as XmlResourceSet;      //從緩存中獲取當前資源
            if (resourceSet == null)
            {
                string fileName = this.GetResourceFileName(culture);
                resourceSet = new XmlResourceSet(fileName, NodeName, "key", "value");
                CacheHelper.SetCache(cacheKey, resourceSet, new System.Web.Caching.CacheDependency(fileName));  //將資源加入緩存中
            }
            return resourceSet;
        }

        #endregion
    }

　　在這個資源訪問的實現中，我使用了服務端高速緩存。原因是我們想要使得修改的資源能夠直接被識別，就必須在訪問資源的時候，去文件中查找。這樣的話每個資源的訪問都需要一次IO消耗。這樣性能損失太大，真的就得不償失了。因此使用依賴於資源文件的高速緩存，已確保只有在資源文件發生變化時，才進行IO讀取。（其實，也可以考慮在運行期間，創建單例的資源訪問器，讓資源訪問權的枚舉器枚舉時，檢測一個緩存變量（該變量依賴於資源文件），當資源文件發生變化時，枚舉器重新讀取資源，已實現如上同樣的效果。這個我們以后有空再一起探討。）該實現中，我也加入了Unity的構造注入方式，讓我們的資源文件可配置。

　　另外，InternalGetResourceSet方法還存在一些問題，就是可能會重復緩存同一個資源文件。例如，我們的資源文件有Resource.en-US.xml, 和Resource.xml，這時會生成三個緩存，將Resource.xml文件緩存了兩次。這都是“回溯”惹的禍。在我的第一個版本源碼公布時，我會修復這個問題。

　　接下來，我們要實現資源的Set、Reader和Writer，用於資源文件的讀寫。

　　XmlResourceReader:

    public class XmlResourceReader : IResourceReader
    {
        #region Properties

        public string FileName { get; private set; }

        public string NodeName { get; private set; }
        
        public string KeyAttr { get; private set; }
        
        public string ValueAttr { get; private set; }

        #endregion

        #region Constructors

        public XmlResourceReader(string fileName, string nodeName, string keyAttr, string valueAttr)
        {
            NodeName = nodeName;
            FileName = fileName;
            KeyAttr = keyAttr;
            ValueAttr = valueAttr;
        }

        #endregion

        #region Enumerator

        public IDictionaryEnumerator GetEnumerator()
        {
            Dictionary<string, string> set = new Dictionary<string, string>();

            XmlDocument doc = new XmlDocument();
            doc.Load(FileName);

            //將資源以鍵值對的方式存儲到字典中。
            foreach (XmlNode item in doc.GetElementsByTagName(NodeName))
            {
                set.Add(item.Attributes[KeyAttr].Value, item.Attributes[ValueAttr].Value);
            }

            return set.GetEnumerator();
        }

        /// <summary>
        /// 枚舉器
        /// </summary>
        /// <returns></returns>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        #endregion
        
        public void Dispose() { }

        public void Close() { }
    }

　　XmlResourceWriter:

    public interface IXmlResourceWriter : IResourceWriter
    {
        void AddResource(string nodeName, IDictionary<string, string> attributes);
        void AddResource(XmlResourceItem resource);
    }

    public class XmlResourceWriter : IXmlResourceWriter
    {
        public XmlDocument Document { get; private set; }
        private string fileName;
        private XmlElement root;

        public XmlResourceWriter(string fileName)
        {
            this.fileName = fileName;
            this.Document = new XmlDocument();
            this.Document.AppendChild(this.Document.CreateXmlDeclaration("1.0", "utf-8", null));
            this.root = this.Document.CreateElement("resources");
            this.Document.AppendChild(this.root);
        }

        public XmlResourceWriter(string fileName, string root)
        {
            this.fileName = fileName;
            this.Document = new XmlDocument();
            this.Document.AppendChild(this.Document.CreateXmlDeclaration("1.0", "utf-8", null));
            this.root = this.Document.CreateElement(root);
            this.Document.AppendChild(this.root);
        }

        public void AddResource(string nodeName, IDictionary<string, string> attributes)
        {
            var node = this.Document.CreateElement(nodeName);
            attributes.AsParallel().ForAll(p => node.SetAttribute(p.Key, p.Value));
            this.root.AppendChild(node);
        }

        public void AddResource(XmlResourceItem resource)
        {
            AddResource(resource.NodeName, resource.Attributes);
        }

        public void AddResource(string name, byte[] value)
        {
            throw new NotImplementedException();
        }

        public void AddResource(string name, object value)
        {
            throw new NotImplementedException();
        }

        public void AddResource(string name, string value)
        {
            throw new NotImplementedException();
        }

        public void Generate()
        {
            using (XmlWriter writer = new XmlTextWriter(this.fileName, Encoding.UTF8))
            {
                this.Document.Save(writer);
            }
        }
        public void Dispose() { }
        public void Close() { }        
    }

　　XmlResourceSet：

    public class XmlResourceSet : ResourceSet
    {
        public XmlResourceSet(string fileName, string nodeName, string keyAttr, string valueAttr)
        {
            this.Reader = new XmlResourceReader(fileName, nodeName, keyAttr, valueAttr);
            this.Table = new Hashtable();
            this.ReadResources();
        }
        
        public override Type GetDefaultReader()
        {
            return typeof(XmlResourceReader);
        }
        public override Type GetDefaultWriter()
        {
            return typeof(XmlResourceWriter);
        }
    }

　　在此，我有個疑問，希望有人能回答：為什么我每次通過Writer修改資源文件后，自問文件中沒有換行，都是一行到底呢？

　　OK，我們的XML訪問模塊的所有成員都到齊了。另外，我在自己的WebApp中增加了全局資源訪問類型Resource：

    public class Resource
    {
        public static string GetDisplay(string key, string culture = "")
        {
            var display = ((AppUnityDependencyResolver)System.Web.Mvc.DependencyResolver.Current).GetService(typeof(IResourceManager), "Display") as IResourceManager;
            if (string.IsNullOrWhiteSpace(culture))
                return display.GetString(key);
            else
                return display.GetString(key, new System.Globalization.CultureInfo(culture));
        }

        public static string GetMessage(string key, string culture = "")
        {
            var display = ((AppUnityDependencyResolver)System.Web.Mvc.DependencyResolver.Current).GetService(typeof(IResourceManager), "Message") as IResourceManager;
            return display.GetString(key);
        }

        public static string GetTitle()
        {
            var routes = HttpContext.Current.Request.RequestContext.RouteData.Values;
            var key = string.Format("{0}.{1}.title", routes["controller"], routes["action"]);
            return GetDisplay(key);
        }
    }

　　注意到我的Resource類有三個靜態方法，GetDisplay、GetMessage和GetTitle。由於我的源碼中，字段名稱和提示信息是在不同的資源文件中的，因此我寫了兩個靜態方法，第一個是獲取字段名稱的，第二個是獲取用戶自定義提示信息的。而第三個是獲取頁面標題的，它依賴於當前執行的Action。

　　現在，看看資源文件：

　　ResourceDisplay.en-US.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <resource key="home.index.title" value="Home Page" />
  <resource key="usermanage.index.title" value="User Management"/>
  <resource key="setting.index.title" value="Settings"/>

  <resource key="UserProfile.UserName" value="English User Name"/>
  <resource key="UserProfile.UserCode" value="English User Code"/>
</resources>

　　ResourceDisplay.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <resource key="home.index.title" value="Home Page" />
  <resource key="usermanage.index.title" value="User Management"/>
  <resource key="setting.index.title" value="Settings"/>

  <resource key="UserProfile.UserName" value="Basic User Name"/>
  <resource key="UserProfile.UserCode" value="Basic User Code"/>
  <resource key="UserProfile.Email" value="Basic User Email Address"/>
</resources>

　　接下來是在WebApp中使用資源文件了。

　　在AccountController中添加EditUser方法：

        [HttpGet]
        public ActionResult EditUser(int? id)
        {
            if (id.HasValue == false)
            {
                return View(new UserProfile());
            }
            else
            {
                var model = UserService.GetSingle<UserProfile>(id);
                return View(model);
            }
        }

　　對應的視圖文件內容：

@model Framework.DomainModels.UserProfile

@{
    ViewBag.Title = "EditUser";
}

<h2>EditUser</h2>
@using (Html.BeginForm())
{
    <p>@Resource.GetDisplay("UserProfile.UserName")</p>
    <p>@Html.TextBoxFor(p=> p.UserName)</p>
    <p>@Resource.GetDisplay("UserProfile.UserCode")</p>
    <p>@Html.TextBoxFor(p=> p.UserCode)</p>
    <p>@Resource.GetDisplay("UserProfile.Email")</p>
    <p>@Html.TextBoxFor(p=> p.Email)</p>
}

　　運行項目，輸入http://localhost:****/Account/EditUser

　　

　　看看前兩個字段顯示的內容是在ResourceDisplay.en-US.xml中定義的，而第三個字段是在ResourceDisplay.xml中定義的（這就是所謂的“回溯”）。

　　這樣就完了嗎？當然沒有，高潮來了......

　　不要停止debug，打開資源文件ResourceDisplay.en-US.xml，刪除我們對UserProfile.UserCode的定義，刷新頁面看看（在此我就不截圖了）。接下來，隨便改改ResourceDisplay.en-US.xml中UserName的定義，刷新頁面再瞧瞧，是否立刻應用？

　　這樣，我們前面預想的不進行編譯，直接應用資源文件的修改就實現了。

　　對了，還有一個GetTitle()，我們打開_Layout.cshtml，做如下修改：

<title>@Resource.GetTitle() - My ASP.NET MVC Application</title>

　　再次在資源文件中添加一行

<resource key="Account.EditUser.title" value="User Edit"/>

　　仍然刷新頁面，注意上圖中紅線位置，是不是對應的Title信息已經顯示？

　　劇透：下一篇，我們會借助Metadata實現字段資源的自動顯示，也就是說，我們不需要類似<p>@Resource.GetDisplay("UserProfile.UserName")</p>這樣的顯示調用，而改用<p>@Html.LabelFor(p=>p.UserName)</p>去顯示字段的資源。