本地化入门

1. 前言

WPF的本地化是个很普遍的功力,我做过的WPF程序大部分都实现了本地化(不管最终有没有应用)。平常本地化有以下几点需求:

  • 在先后启动时依据CultureInfo.CurrentUICulture或配备项显示对应语言的UI。
  • 在程序运行时得以动态切换UI语言(无需重启程序)。
  • 成立对应不同语言的安装包。
  • 经过下载语言包实现多种语言的本地化。

个中只有首先点是必需的。
第二点最好也足以兑现,很多时候切换语言只为了看看某个专业术语在西班牙语中的原文是哪些,或者暂时打印个英文报表,平常利用或者用中文,用户不想为了这点重启程序。
其三点和第四点尽管很普遍,但自我从来没实现过,毕竟文字资源(有时还有微量图片)占用的空中不会太多,大部分WPF程序都未曾大到需要考虑安装包大小,所有语言的资源总体打包进一个安装包就足以了。

WPF本地化技术很干练,也有二种方案,微软在MSDN给出了详实的牵线WPF
全球化和本地化概述
.aspx),还有一份古老的文档WPF
Localization
Guidance
,整整66页,里面详细介绍了各类WPF本地化的体制。

本文只介绍二种实现以上第1、2点急需的方案。

2. 接纳资源词典

2.1 基本原理

对WPF开发者来说,资源词典肯定不会陌生。可是在资源词典里使用string可能相比较少。

<Window x:Class="LocalizationDemoWpf.Window1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:LocalizationDemoWpf"
        mc:Ignorable="d" 
        xmlns:system="clr-namespace:System;assembly=mscorlib"
        Title="Window1" Height="300" Width="300">
    <Window.Resources>
        <system:String x:Key="Chinese">中文</system:String>
    </Window.Resources>
    <Grid>
        <TextBlock Text="{DynamicResource Chinese}"/>
    </Grid>
</Window>

如以上代码所示,在XAML中定义string资源需要先引入xmlns:system="clr-namespace:System;assembly=mscorlib"命名空间,之后再使用DynamicResource引用这个资源。不要拔取StaticResource,这样没法完成动态切换语言。

要采纳资源词典实现本地化,需要先成立所需语言的xaml,我在DEMO中开创了en-us.xaml和zh-cn.xaml几个资源词典,里面的蕴藏的资源结构同样(指数量和Key一样):

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
                    xmlns:system="clr-namespace:System;assembly=mscorlib"
                    xmlns:local="clr-namespace:LocalizationDemoWpf">
    <system:String x:Key="SwitchLanguage">切换语言</system:String>
    <system:String x:Key="Chinese">中文</system:String>
    <system:String x:Key="English">英文</system:String>
    <system:String x:Key="Username">用户名</system:String>
    <system:String x:Key="Sex">性别</system:String>
    <system:String x:Key="Address">地址</system:String>
    <SolidColorBrush x:Key="Background" Color="#88FF0000"/>
</ResourceDictionary>

在程序启动时遵照CultureInfo.CurrentUICulture或配备项接纳相应的资源词典,使用MergedDictionaries的章程加载到程序的资源会聚中:

var culture = ReadCultureFromConfig();
var cultureInfo = new System.Globalization.CultureInfo(culture);
Thread.CurrentThread.CurrentUICulture = cultureInfo;
Thread.CurrentThread.CurrentCulture = cultureInfo;


ResourceDictionary dictionary = new ResourceDictionary { Source = new Uri($@"Resources\{culture}.xaml", UriKind.RelativeOrAbsolute) };
Application.Current.Resources.MergedDictionaries[0] = dictionary;

如此本地化的职能就水到渠成了。

2.2 动态切换语言

事实上上述方案已落实了动态切换语言。
XAML资源的引用原则是就地原则,这么些附近不仅指VisualTree上的附近,还指时间上的就近。后添加进资源词典的资源将替换从前的同名资源。使用DynamicResource而不是StaticResource,就是为着在资源被轮换时能实时变更UI的显得。

2.3 设计时协助

VisualStudio的XAML设计时扶助对开发WPF程序至关首要,对本地化来说,设计时协助至关首要含有3有些:

  • 在编写XAML时能够得到资源的智能感知
  • 有完整的筹划视图
  • 在不同语言之间切换

使用资源词典实现本地化,只需在App.xaml中联合对应的资源词典即可拿到完整的计划时补助。

<Application x:Class="LocalizationDemoWpf.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:local="clr-namespace:LocalizationDemoWpf"
             xmlns:resource="clr-namespace:LocalizationDemoWpf.Resource;assembly=LocalizationDemoWpf.Resource"
             StartupUri="MainWindow.xaml">
    <Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <ResourceDictionary Source="/LocalizationDemoWpf;component/Resources/zh-cn.xaml"/>
                <!--<ResourceDictionary Source="/LocalizationDemoWpf;component/Resources/en-us.xaml"/>-->
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
</Application>

图片 1

那段XAML只是为了加强设计时体验,没有也能透过编译。

2.4 在代码里拜访资源

在代码中走访资源比较费心,需要精通资源的称谓,而且没有智能感知,假设资源词典由第三方类库提供就会更麻烦。

var message = TryFindResource("SwitchLanguage") as string;
if (string.IsNullOrWhiteSpace(message) == false)
    MessageBox.Show(message);

2.5 在代码里替换资源

private void OnReplaceString(object sender, RoutedEventArgs e)
{
    _totalReplace++;
    string content = "Replace " + _totalReplace;
    Resources["StringToReplace"] = content;
}

如上所示,在代码中替换资源非凡简短,不过这种简易也拉动了资源不可控的题目。

2.6 在先后集以内共享资源

上边有提过,在得到第三方类库中某个资源相当烦劳,不仅如此,连得到第三方类库中的资源词典名称都卓殊麻烦。我提议在类库中定义如下的类,能够给开发者提供一些有益:

public static class Resources
{
    public static Uri EnglishResourceUri { get; } =
        new Uri("/LocalizationDemoWpf.Resource;component/Resource.en-us.xaml", UriKind.RelativeOrAbsolute);

    public static Uri ChineseResourceUri { get; } =
        new Uri("/LocalizationDemoWpf.Resource;component/Resource.zh-cn.xaml", UriKind.RelativeOrAbsolute);
}

2.7 总结

资源词典是兑现本地化的一种很广阔的主意,它有如下优点:

  • 简言之易用,而且便于领悟。
  • XAML语法简单。
  • 资源可以是除string以外的品类,如SolidColorBrush。

但这种模式的欠缺也不在少数:

  • 难以管理,一旦资源过多,重名、互相覆盖、智能感知列表过长等题材将极大地影响开发,就连保证不同语言间资源词典里的资源数量同样都很麻烦。
  • 在先后集以内难以共享,引用很简短,但出于并未智能感知将很难使用,而且不同程序集以内的资源同名更难以跟踪。

除此以外,在动态切换语言上还留存有的问题。下边这段XAML就没法完成动态切换语言:

<DataGrid Grid.Row="1" Margin="5">
    <DataGrid.Columns>
        <DataGridTextColumn Header="{DynamicResource Username}"/>
        <DataGridTextColumn Header="{DynamicResource Sex}"/>
        <DataGridTextColumn Header="{DynamicResource Address}" Width="*"/>
    </DataGrid.Columns>
</DataGrid>

在DataGridColumn的Header上做动态切换语言,需要写成DataTemplate的法子:

<DataGrid Grid.Row="2" Margin="5">
    <DataGrid.Columns>
        <DataGridTextColumn >
            <DataGridTextColumn.HeaderTemplate>
                <DataTemplate >
                    <TextBlock Text="{DynamicResource Username}"/
                </DataTemplate>
            </DataGridTextColumn.HeaderTemplate>
        </DataGridTextColumn>
        <DataGridTextColumn >
            <DataGridTextColumn.HeaderTemplate>
                <DataTemplate >
                    <TextBlock Text="{DynamicResource Sex}"/>
                </DataTemplate>
            </DataGridTextColumn.HeaderTemplate>
        </DataGridTextColumn>
        <DataGridTextColumn Width="*">
            <DataGridTextColumn.HeaderTemplate>
                <DataTemplate >
                    <TextBlock Text="{DynamicResource Address}"/>
                </DataTemplate>
            </DataGridTextColumn.HeaderTemplate>
        </DataGridTextColumn>
    </DataGrid.Columns>
</DataGrid>

3. 利用Resx资源文件

3.1 基本原理

比起资源词典,我更欣赏使用Resx资源文件,然则这种格局语法复杂一些,而且也有众多小问题。
在VisualStudio中开创后缀名为resx的资源文件并开拓,可在偏下UI编辑资源文件的值(将访问修饰符改为public用起来方便些):
图片 2

在改动资源文件的值后PublicResXFileCodeGenerator将自行创造对应的类并为每一个键值添加如下代码:

/// <summary>
///   查找类似 Address 的本地化字符串。
/// </summary>
public static string Address {
    get {
        return ResourceManager.GetString("Address", resourceCulture);
    }
}

下一场将这么些资源文件复制粘贴一份,将名称改为“原名+.+对应的言语+.resx”的格式,并且将里面的值翻译成对应语言如下:
图片 3

在UI上使用x:Static绑定到对应的资源:

<DataGridTextColumn Header="{x:Static local:Labels.Username}"/>

如此大旨的本地化就到位了。很多控件库都是使用这种措施做本地化。除了字符串,resx资源文件还辅助除字符串以外的资源,如图片、音频等。
图片 4

而是这个方案只兑现了最核心的本地化,而且最大的题目是只匡助直接动用字符串,不补助TypeConverter,甚至也不帮助除字符串以外的另外XAML内置类型.aspx)(即Boolea,Char,Decimal,Single,Double,Int16,Int32,Int64,提姆eSpan,Uri,Byte,Array等项目)。例如利用Label.resx中名为Background值为
#880000FF 的字符串为Grid.Background实现本地化:

Labels.designer.resx

/// <summary>
///   查找类似 #880000FF 的本地化字符串。
/// </summary>
public static string Background {
    get {
        return ResourceManager.GetString("Background", resourceCulture);
    }
}

MainWindow.xaml

<Grid  Background="{x:Static local:Labels.Background}"/>

运转时报错:ArgumentException:
“#88FF0000”不是性质“Background”的有效值。

诸如此类资源文件的实用性大优惠扣。当然,这多少个方案也不帮助动态切换语言。

3.2 动态切换语言

Silverlight.aspx)中已没有了x:Static的绑定形式,改为利用Binding实现本地化,这样固然语法复杂一些,但更为实用。WPF当然也可以动用这种方法。

率先, 成立一个类包装资源文件生成的类(在那几个Demo中是Labels):

public class ApplicationResources
{
    public ApplicationResources()
    {
        Labels = new Labels();
    }

    public Labels Labels { get; set; }
}

下一场在App.xaml司令员以此类作为资源充分到资源汇集中,为了将来使用的语法简单些,我通常将Key取得很简单:

<Application x:Class="LocalizationDemoWpfUsingResource.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:local="clr-namespace:LocalizationDemoWpfUsingResource"
             StartupUri="MainWindow.xaml">
    <Application.Resources>
        <local:ApplicationResources x:Key="R"  />
    </Application.Resources>
</Application>

最终在XAML中如此绑定:

<DataGridTextColumn Header="{Binding Labels.Username, Source={StaticResource R}}"/>

这样语法复杂一些,但也有诸多便宜:

  • 支撑TypeConverter,这样就足以行使除String以外的此外品类。
  • 支撑Binding的任何功效,如IValueConverter。

辛劳的是,WPF似乎不是很欣赏这种办法,VisualStudio会指示那种不当,毕竟资源文件中的属性都是static属性,不是实例成员。幸运的是编译三回这种错误指示就会磨灭。
图片 5

将调用形式改为Binding未来就可以实现动态切换语言了。由于UI通过Binding获取资源文件的始末,可以通过INotifyPropertyChanged通告UI更新。将ApplicationResources
改造一下:

public class ApplicationResources : INotifyPropertyChanged
{
    public static ApplicationResources Current { get; private set; }

    public ApplicationResources()
    {
        Current = this;
        Labels = new Labels();
    }

    public Labels Labels { get; set; }



    public event PropertyChangedEventHandler PropertyChanged;

    public  void ChangeCulture(System.Globalization.CultureInfo cultureInfo)
    {
        Thread.CurrentThread.CurrentUICulture = cultureInfo;
        Thread.CurrentThread.CurrentCulture = cultureInfo;
        Labels.Culture = cultureInfo;

        if (Current != null)
            Current.RaiseProoertyChanged();
    }

    public void RaiseProoertyChanged()
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(""));
    }
}

后天可以概括地切换语言了。

var culture = ReadCultureFromConfig();
var cultureInfo = new System.Globalization.CultureInfo(culture);
ApplicationResources.Current.ChangeCulture(cultureInfo);

3.3 设计时帮助

兑现本地化的一个很劳顿的工作是怎么在统筹视图看到各种语言下的职能。在行使资源词典的方案中是经过在App.xaml中集合对应的资源词典:

<ResourceDictionary.MergedDictionaries>
    <ResourceDictionary Source="/LocalizationDemoWpf;component/Resources/zh-cn.xaml"/>
    <!--<ResourceDictionary Source="/LocalizationDemoWpf;component/Resources/en-us.xaml"/>-->
</ResourceDictionary.MergedDictionaries>

在资源文件的方案中,需要在ApplicationResources中添加一个特性:

private string _language;

/// <summary>
/// 获取或设置 Language 的值
/// </summary>
public string Language
{
    get { return _language; }
    set
    {
        if (_language == value)
            return;

        _language = value;
        var cultureInfo = new CultureInfo(value);
        Thread.CurrentThread.CurrentUICulture = cultureInfo;
        Thread.CurrentThread.CurrentCulture = cultureInfo;
        Labels.Culture = cultureInfo;

        RaiseProoertyChanged();
    }
}

未来在App.xaml中就可以通过改变这么些特性来改变规划时的UI的言语,在VS2017中连编译都不需要就可以转移规划视图的言语。

<local:ApplicationResources x:Key="R"  Language="zh-CN"/>

图片 6

3.4 在代码里拜访资源

在代码里拜访资源文件的资源充分简易:

MessageBox.Show(Labels.SwitchLanguage);

3.5 在代码里替换资源

资源文件要贯彻这些需要就一些都糟糕玩了,至少自己没有在事实上工作中做过。最大的难题是资源文件生成的类中的属性是静态属性,而且只有getter方法:

public static string StringToReplace {
    get {
        return ResourceManager.GetString("StringToReplace", resourceCulture);
    }
}

我们也可以创建一个派生类,强行替换对应的性能:

public class ExtendLabels : Labels
{
    /// <summary>
    /// 获取或设置 StringToReplace 的值
    /// </summary>
    public new string StringToReplace { get; set; }
}

下一场替换ApplicationResources中的Labels,并且触发PropertyChanged。不过这样会刷新所有UI上的字符串等资源,只为了替换一个字符资源代价有点大,幸好一般的话并不会太耗费性能。

private void OnReplaceString(object sender, RoutedEventArgs e)
{
    _totalReplace++;
    string content = Labels.StringToReplace + " " + _totalReplace;
    if (_extendLabels == null)
        _extendLabels = new ExtendLabels();

    _extendLabels.StringToReplace = content;
    ApplicationResources.Current.Labels = _extendLabels;
    ApplicationResources.Current.RaiseProoertyChanged();
}

3.6 在程序集以内共享资源

只需要将资源文件的走访修饰符改为public,无需任何操作就足以便宜地在程序集以内共享资源。
图片 7

3.7 管理资源文件

比起资源词典,资源文件还有一个很大的优势就是容易管理。Demo中唯有一个名字Labels的资源文件,实际项目中可以按效用或模块分别创设相应的资源文件,解决了资源词典重名、相互覆盖、智能感知列表过长等题材。此外我引进应用VS的壮大程序ResXManager管理所有资源文件。
图片 8

它可以在一个UI里管理所有语言的资源文件,极大地便民了资源文件的利用。
图片 9

3.8 ReSharper支持

对Resx资源文件,Re夏普er也提供了出色的支撑。

当需要为某个资源修改Key时,可以按“资源文件名称”+”.”+”Key”来全局替换,平常这样已经足足放心。ReSharper更进一步,它提供了重命名效率。假如要将Labels的资源English重名为为Englishs,可以先在Labels.Designer.cs重命名,然后利用“Apply
rename refactoring”选项:
图片 10

此刻所有引用,包括XAML都已利用新的称呼:
图片 11

只是最终仍需协调入手在资源文件编辑器中修改Key。

除此之外,假若在XAML中行使了不当的Key,ReSharper也有不当提醒:
图片 12

在少数场所,ReShaper还可采取“Move To Resource”功能:
图片 13
图片 14

3.9 总结

利用Resx资源文件贯彻地点化有如下优点:

  • 资源管理有利于。
  • 容易在代码中动用。
  • 容易在先后集以内共享。
  • 支撑TypeConverter,这样就足以应用除String以外的另外项目。
  • 支撑Binding的任何效能,如IValueConverter。
  • 兼容性好,Silverlight及之后的XAML技术都足以动用。
  • 其三方工具辅助。
  • 扶助图片、音频等资源。

缺点如下:

  • XAML语法相对复杂。
  • 不可能直接采纳于TypeConverter不帮忙的类别,例如LinearGradientBrush。

尽管如此无法直接匡助LinearGradientBrush,但也不是一点一滴没有主意,只是复杂了众多,如分别对LinearGradientBrush的GradientStop做本地化:

<LinearGradientBrush EndPoint="0.5,1" StartPoint="0.5,0">
    <GradientStop Color="Black" Offset="0"/>
    <GradientStop Color="{Binding Source={StaticResource R},Path=Labels.Background}" Offset="1"/>
</LinearGradientBrush>

4. 结语

这篇著作只介绍了本地化的入门知识,其余还有许多本地化的中心境想,如验证消息中的本地化没有涉及。此外,本地化还足以使用x:Uid模式或WPFLocalizeExtension等措施实现,这里就不详细介绍。
WPF
全球化和本地化概述
.aspx)里有介绍部分本地化的特级做法,如UI上相应接纳相对布局而非相对布局、字体选拔等,这里不再累赘。

急需专注的是上述二种方案都不适用于CLR属性,这也是为什么自己一直强调UIElement的性能最好是依赖属性的原由之一。

如有错漏请指出。

5. 参考

WPF
全球化和本地化概述
.aspx)
Silverlight
部署和本地化
.aspx)
WPFLocalizationExtension
WPF Localization Guidance
XAML
Resources

CultureInfo
.aspx)
Supported
languages

6. 源码

LocalizationDemo

相关文章