【WinRT】使用 T4 模板简化字符串的本地化

在 WinRT 中，对控件、甚至图片资源的本地化都是极其方便的，之前我在博客中也介绍过如何本地化应用名称：http://www.cnblogs.com/h82258652/p/4292157.html

关于 WinRT 中的本地化，CodeProject 上有一篇十分值得大家一看的文章：http://www.codeproject.com/Articles/862152/Localization-in-Windows-Universal-Apps

大家可以去仔细学习一下。

以前的本地化：

说回重点，如果有 Winform、WPF、Windows Phone Silverlight 本地化经验的都知道，打开 Resources.resx 文件，然后填写键值对就可以了（其它语言则在添加相应的 resx 文件，例如美国的就添加 Resources.en-US.resx）。这种方法最大的优点就是，填写的键会生成相应的属性，例如我在 resx 中填写了一个 China 的键，则 resx 文件会生成一个相应的 cs 文件，并且包含这么一段：

然后我们就可以使用：resx的名字.China 来使用相应的本地化的字符串了。

现在 Windows Runtime 的本地化：

在 WinRT 中，本地化很多东西都变得方便了，唯独就是字符串的本地化变麻烦了，资源文件不再给我们生成强类型的属性来访问字符串了，要我们自己来手动写代码来获取每一个键对应的值。

例如我们也在 WinRT 的资源文件——resw 里填写一个 China 的键：

那么在 cs 代码中访问这个 China 就是：

一两个键还好，手动写一下，问题我们的程序不可能就只有那么点需要本地化的字符串，少则几十个，多则上百上千。而且手动编写的话，还会存在拼写错误的情况，最主要的是，根本没法重构！！

解决方案：

那么必然就需要使用一种自动化的，生成代码的技术，这里我们选择 T4 模板来解决这个问题。

首先，我们先来研究下，究竟 resw 是如何存放我们编写好的数据呢？用记事本或者其它文本编辑器打开 resw。

可以看出，本质是一个 XML 文件，并且我们可以轻易看到，我们填写的键值存放在 data 节点中。

假设我们知道这个 resw 文件的路径的话，我们可以编写出如下代码：

        XmlDocument document = new XmlDocument();
        document.Load(reswPath);

        // 获取 resw 文件中的 data 节点。
        XmlNodeList dataNodes = document.GetElementsByTagName("data");
        foreach(var temp in dataNodes)
        {
            XmlElement dataNode = temp as XmlElement;
            if(dataNode != null)
            {
                string value = dataNode.GetAttribute("name");
                // key 中包含 ‘.’ 的作为控件的多语言化，不处理。
                if(value.Contains(".") == false)
                {
                    names.Add(value);
                }
            }
        }

其中 names 变量用于存放 resw 中的键。

需要注意的是，键中包含 ‘.’ 的键是用于控件的本地化的，所以这些键我们跳过。（因为 ‘.’ 也不能包含在属性名中）

接下来就是如何获得这些 resw 的路径了。

这里我们往上想一步，获得当前工程的路径，然后搜索 resw 文件不就行了吗？

在获取当前工程的路径时，我们需要用到 T4 的语法，这里我编写成帮助函数。（注意：T4 的帮助函数必须放到 T4 文件的最后）

<#+
    // 获取当前 T4 模板所在的工程的目录。
    public string GetProjectPath()
    {
        return Host.ResolveAssemblyReference("$(ProjectDir)");
    }
#>

这里有一点要注意，由于使用到 Host 属性，所以需要把 T4 文件前面的 hostspecific 修改为 true。

然后搜索 resw 就很简单了：

    string projectPath = GetProjectPath();

    string stringsPath = Path.Combine(projectPath, "Strings");
    string[] reswPaths;

    // 当前项目存在 Strings 文件夹。
    if(Directory.Exists(stringsPath))
    {
        // 获取 Strings 文件夹下所有的 resw 文件的路径。
        reswPaths = Directory.GetFiles(stringsPath, "*.resw", SearchOption.AllDirectories);
    }
    else
    {
        reswPaths = new string[0];
    }

这里进行了路径拼接是因为生成程序的目录下，也会有由于 VS 调试生成的 resw 文件，这里我们是不需要的，而且这样搜索的效率会高一点。我们仅仅需要 Strings 文件夹下的 resw。

需要的基本都准备好了，最后一个大难题就是，我们想生成的 cs 的命名空间跟当前项目相同。关于这一点，博客园好像找不到，最后在 stackoverflow 上找到了一个差不多的答案。修改符合我们需求后，我们将获取命名空间的也封装成帮助函数：

    // 获取当前 T4 模板所在的工程的默认命名空间。
    public string GetProjectDefaultNamespace()
    {
        IServiceProvider serviceProvider = (IServiceProvider)this.Host;
        EnvDTE.DTE dte = (EnvDTE.DTE)serviceProvider.GetService(typeof(EnvDTE.DTE));
        EnvDTE.Project project = (EnvDTE.Project)dte.Solution.FindProjectItem(this.Host.TemplateFile).ContainingProject;
        return project.Properties.Item("DefaultNamespace").Value.ToString();
    }

最后附上完整代码：

<#@ template debug="false" hostspecific="true" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ assembly name="System.Xml" #>
<#@ assembly name="EnvDTE" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Xml" #>
<#@ output extension=".cs" #>

<#
    // 用于存放所有 resw 的 key。
    HashSet<string> names = new HashSet<string>();
    string projectPath = GetProjectPath();

    string stringsPath = Path.Combine(projectPath, "Strings");
    string[] reswPaths;

    // 当前项目存在 Strings 文件夹。
    if(Directory.Exists(stringsPath))
    {
        // 获取 Strings 文件夹下所有的 resw 文件的路径。
        reswPaths = Directory.GetFiles(stringsPath, "*.resw", SearchOption.AllDirectories);
    }
    else
    {
        reswPaths = new string[0];
    }
    
    foreach(string reswPath in reswPaths)
    {
        XmlDocument document = new XmlDocument();
        document.Load(reswPath);

        // 获取 resw 文件中的 data 节点。
        XmlNodeList dataNodes = document.GetElementsByTagName("data");
        foreach(var temp in dataNodes)
        {
            XmlElement dataNode = temp as XmlElement;
            if(dataNode != null)
            {
                string value = dataNode.GetAttribute("name");
                // key 中包含 ‘.’ 的作为控件的多语言化，不处理。
                if(value.Contains(".") == false)
                {
                    names.Add(value);
                }
            }
        }
    }
#>
<#
    if(names.Count > 0)
    {
        #>
using Windows.ApplicationModel.Resources;

namespace <# Write(GetProjectDefaultNamespace());#>
{
    public class LocalizedStrings
    {
        private readonly static ResourceLoader Loader = new ResourceLoader();
        
        <#
            foreach(string name in names)
            {
                if(string.IsNullOrWhiteSpace(name))
                {
                    continue;
                }

                // 将 key 的第一个字母大写，作为属性名。
                string propertyName = name[0].ToString().ToUpper() + name.Substring(1);
                #>
                public static string <#=propertyName#>
        {
            get
            {
                return Loader.GetString("<#=name#>"); 
            }
        }
                <#
            }
        #>
    }
}
        <#
    }
#>
<#+
    // 获取当前 T4 模板所在的工程的目录。
    public string GetProjectPath()
    {
        return Host.ResolveAssemblyReference("$(ProjectDir)");
    }

    // 获取当前 T4 模板所在的工程的默认命名空间。
    public string GetProjectDefaultNamespace()
    {
        IServiceProvider serviceProvider = (IServiceProvider)this.Host;
        EnvDTE.DTE dte = (EnvDTE.DTE)serviceProvider.GetService(typeof(EnvDTE.DTE));
        EnvDTE.Project project = (EnvDTE.Project)dte.Solution.FindProjectItem(this.Host.TemplateFile).ContainingProject;
        return project.Properties.Item("DefaultNamespace").Value.ToString();
    }
#>

其中 <#=variable#> 为输出变量的值，学习过 Asp.net 的园友应该会很熟悉的了。

最后效果：

 

除了 T4 生成出来的没格式化这点比较蛋疼之外，其它一切问题都被 T4 解决好了，使用 LocalizedStrings.China 就可以访问到 China 这个键对应的值了。以后修改完 resw 之后，重新生成一下项目就可以更新 LocalizedStrings 了。

后记：

今天有空，再调整了下 T4 的格式，生成的代码的格式终于没问题了。

<#@ template debug="false" hostspecific="true" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ assembly name="System.Xml" #>
<#@ assembly name="EnvDTE" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Xml" #>
<#@ output extension=".cs" #>
<#
    // 用于存放所有 resw 的 key。
    HashSet<string> names = new HashSet<string>();
    string projectPath = GetProjectPath();

    string stringsPath = Path.Combine(projectPath, "Strings");
    string[] reswPaths;

    // 当前项目存在 Strings 文件夹。
    if(Directory.Exists(stringsPath))
    {
        // 获取 Strings 文件夹下所有的 resw 文件的路径。
        reswPaths = Directory.GetFiles(stringsPath, "*.resw", SearchOption.AllDirectories);
    }
    else
    {
        reswPaths = new string[0];
    }
    
    foreach(string reswPath in reswPaths)
    {
        XmlDocument document = new XmlDocument();
        document.Load(reswPath);

        // 获取 resw 文件中的 data 节点。
        XmlNodeList dataNodes = document.GetElementsByTagName("data");
        foreach(var temp in dataNodes)
        {
            XmlElement dataNode = temp as XmlElement;
            if(dataNode != null)
            {
                string value = dataNode.GetAttribute("name");
                // key 中包含 ‘.’ 的作为控件的多语言化，不处理。
                if(value.Contains(".") == false)
                {
                    names.Add(value);
                }
            }
        }
    }
#>
<#
    if(names.Count > 0)
    {
#>
using Windows.ApplicationModel.Resources;

namespace <# WriteLine(GetProjectDefaultNamespace());#>
{
    public class LocalizedStrings
    {
        private readonly static ResourceLoader Loader = new ResourceLoader();
<#
            foreach(string name in names)
            {
                if(string.IsNullOrWhiteSpace(name))
                {
                    continue;
                }

                // 将 key 的第一个字母大写，作为属性名。
                string propertyName = name[0].ToString().ToUpper() + name.Substring(1);
#>

        public static string <#=propertyName#>
        {
            get
            {
                return Loader.GetString("<#=name#>"); 
            }
        }
<#
            }
#>
    }
}
<#
    }
#>
<#+
    // 获取当前 T4 模板所在的工程的目录。
    public string GetProjectPath()
    {
        return Host.ResolveAssemblyReference("$(ProjectDir)");
    }

    // 获取当前 T4 模板所在的工程的默认命名空间。
    public string GetProjectDefaultNamespace()
    {
        IServiceProvider serviceProvider = (IServiceProvider)this.Host;
        EnvDTE.DTE dte = (EnvDTE.DTE)serviceProvider.GetService(typeof(EnvDTE.DTE));
        EnvDTE.Project project = (EnvDTE.Project)dte.Solution.FindProjectItem(this.Host.TemplateFile).ContainingProject;
        return project.Properties.Item("DefaultNamespace").Value.ToString();
    }
#>

关键在于要将<##>这些控制块顶端对齐，也就是<#前面的空格在之前的版本被输出了，所以不好控制输出的格式。

2015年5月29日补充：

之前的方案没法支持多个 resw，只能支持 Resources.resw。resw 改成别的名字就不可以用了。

顺便获取默认命名空间有直接的 API，之前没装插件，没有智能感知所以不知道。。。

<#@ template debug="false" hostspecific="true" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ assembly name="System.Xml" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Xml" #>
<#@ output extension=".cs" #>
<#
    bool hadOutput = false;

    HashSet<KeyName> resourceKeys = new HashSet<KeyName>();// 存放 key 和对应的 resw 的名字。

    foreach (var reswPath in GetAllReswPath())
    {
        string name = GetReswName(reswPath);
        var keys = GetReswKeys(reswPath).ToList();

        for (int i = 0; i < keys.Count; i++)
        {
            var key = keys[i];

            if (string.IsNullOrWhiteSpace(key))
            {
                continue;
            }

            KeyName keyName = KeyName.Create(key, name);
            resourceKeys.Add(keyName);
        }
    }
#>
<#
    if (resourceKeys.Any())
    {
#>
using Windows.ApplicationModel.Resources;

namespace <#= GetNamespace() #>
{
    public static partial class LocalizedStrings
    {
<#
    }
#>
<#
    foreach (var keyName in resourceKeys)
    {
        string key = keyName.Key;
        string name = keyName.Name;
        
        // 将 key 的第一个字母大写，作为属性名。
        string propertyName = key[0].ToString().ToUpper() + key.Substring(1);
                
        // ResourceLoader 的 key，如果为 "Resources"，则可以省略。
        string resourceName = string.Equals(name, "Resources", StringComparison.OrdinalIgnoreCase) ? string.Empty : (""" + name + """);

        // 不是第一个属性，添加换行。
        if (hadOutput == true)
        {
            WriteLine(string.Empty);
        }
#>
        public static string <#= propertyName #>
        {
            get
            {
                return ResourceLoader.GetForCurrentView(<#= resourceName #>).GetString("<#= key #>");
            }
        }
<#
        hadOutput = true;        
    }
#>
<#
    if (resourceKeys.Any())
    {
#>
    }
}
<#
    }
#>
<#+ 
    /// <summary>
    /// 获取当前项目的默认命名空间。
    /// </summary>
    /// <returns>当前项目的默认命名空间。</returns>
    private string GetNamespace()
    {
        return this.Host.ResolveParameterValue("directiveId", "namespaceDirectiveProcessor", "namespaceHint");
    }

    /// <summary>
    /// 获取当前项目的绝对路径。
    /// </summary>
    /// <returns>当前项目的绝对路径。</returns>
    private string GetProjectPath()
    {
        return this.Host.ResolveAssemblyReference("$(ProjectDir)");
    }

    /// <summary>
    /// 获取 Strings 文件夹内的所有 resw 的绝对路径。
    /// </summary>
    /// <returns>Strings 文件夹内的所有 resw 的绝对路径。如果没有，则返回空集合。</returns>
    private IEnumerable<string> GetAllReswPath()
    {
        string projectPath = GetProjectPath();
        string stringsPath = Path.Combine(projectPath, "Strings");
        
        // 当前项目存在 Strings 文件夹。
        if (Directory.Exists(stringsPath))
        {
            // 获取 Strings 文件夹下所有的 resw 文件的路径。
            return Directory.GetFiles(stringsPath, "*.resw", SearchOption.AllDirectories);
        }
        else
        {
            return Enumerable.Empty<string>();
        }
    }

    /// <summary>
    /// 获取 resw 的文件名。
    /// </summary>
    /// <returns>resw 的文件名。</returns>
    private string GetReswName(string reswPath)
    {
        return Path.GetFileNameWithoutExtension(reswPath);
    }

    /// <summary>
    /// 获取 resw 内的所有键的名称。
    /// </summary>
    /// <returns>resw 内所有键的名称，不包含用于本地化控件属性的键。</returns>
    private IEnumerable<string> GetReswKeys(string reswPath)
    {
        XmlDocument document = new XmlDocument();
        document.Load(reswPath);

        // 获取 resw 文件中的 data 节点。
        XmlNodeList dataNodes = document.GetElementsByTagName("data");
        foreach(var temp in dataNodes)
        {
            XmlElement dataNode = temp as XmlElement;
            if (dataNode != null)
            {
                string key = dataNode.GetAttribute("name");
                // key 中包含 ‘.’ 的作为控件的多语言化，不处理。
                if (key.Contains(".") == false)
                {
                    yield return key;
                }
            }
        }
    }

    // 辅助结构体
    private struct KeyName
    {
        internal string Key
        {
            get;
            set;
        }

        internal string Name
        {
            get;
            set;
        }

        internal static KeyName Create(string key, string name)
        {
            return new KeyName()
                {
                    Key = key,
                    Name = name
                };
        }
    }
 #>