WPF 本地化的最佳做法
WPF 本地化的最佳做法
- 资源文件
-
- 英文资源文件 en-US.xaml
- 中文资源文件 zh-CN.xaml
- 资源使用
-
- App.xaml
- 主界面布局
- cs代码
- App.config
- 辅助类
-
- 语言切换操作类
- 资源 binding 解析类
- 实现效果
应用程序本地化有很多种方式，选择合适的才是最好的。这里只讨论一种方式，动态资源（DynamicResource） 这种方式可是在不重启应用程序的情况下进行资源的切换，不论是语言切换，还是更上层的主题切换。想要运行时切换不同的资源就必须使用 动态资源（DynamicResource） 这种方式。
图片是可以使用资源字典进行动态 binding 的 不要被误导了
资源文件
确保不同语言环境中资源 Key 是同一个，且对用的资源类型是相同的。
在资源比较多的情况下，可以通过格式化的命名方式来规避 Key 冲突。
资源文件的属性可以设置成：
生成操作：内容
复制到输出目录：如果较新则复制
上面的操作可以在不重新编译程序的情况下编辑语言资源并应用。
如果不想让别人更改语言资源则
生成操作：页
复制到输出目录：不复制
英文资源文件 en-US.xaml
<ResourceDictionary
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:sys="clr-namespace:System;assembly=mscorlib">
<sys:String x:Key="WindowsTitle">MainWindowsys:String>
<ImageSource x:Key="icon">pack://SiteOfOrigin:,,,/Icons/en-USicon.pngImageSource>
<sys:String x:Key="LanguageButton">LanguageButtonsys:String>
<sys:String x:Key="LockTime-OneMinute">1 Minutesys:String>
<sys:String x:Key="LockTime-FiveMinute">5 Minutesys:String>
<sys:String x:Key="LockTime-TenMinute">10 Minutesys:String>
<sys:String x:Key="LockTime-FifteenMinute">15 Minutesys:String>
<sys:String x:Key="LockTime-ThirtyMinute">30 Minutesys:String>
<sys:String x:Key="LockTime-OneHour">1 Hoursys:String>
<sys:String x:Key="LockTime-TwoHour">2 Hoursys:String>
<sys:String x:Key="LockTime-ThreeHour">3 Hoursys:String>
<sys:String x:Key="LockTime-Never">Neversys:String>
ResourceDictionary>
中文资源文件 zh-CN.xaml
<ResourceDictionary
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:sys="clr-namespace:System;assembly=mscorlib">
<sys:String x:Key="WindowsTitle">主窗口sys:String>
<ImageSource x:Key="icon">pack://SiteOfOrigin:,,,/Icons/zh-CNicon.pngImageSource>
<sys:String x:Key="LanguageButton">语言按钮sys:String>
<sys:String x:Key="LockTime-OneMinute">1 分钟sys:String>
<sys:String x:Key="LockTime-FiveMinute">5 分钟sys:String>
<sys:String x:Key="LockTime-TenMinute">10 分钟sys:String>
<sys:String x:Key="LockTime-FifteenMinute">15 分钟sys:String>
<sys:String x:Key="LockTime-ThirtyMinute">30 分钟sys:String>
<sys:String x:Key="LockTime-OneHour">1 小时sys:String>
<sys:String x:Key="LockTime-TwoHour">2 小时sys:String>
<sys:String x:Key="LockTime-ThreeHour">3 小时sys:String>
<sys:String x:Key="LockTime-Never">永不sys:String>
ResourceDictionary>
资源使用
App.xaml
设置默认语言资源，用于在设计阶段预览，并利用 VS 智能提示资源的 Key 防止 Key编写出错。
<Application
x:Class="Localization.Core.App"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="clr-namespace:Localization.Core"
StartupUri="MainWindow.xaml">
<Application.Resources>
<ResourceDictionary>
<ResourceDictionary.MergedDictionaries>
<ResourceDictionary Source="/I18nResources/en-US.xaml" />
ResourceDictionary.MergedDictionaries>
ResourceDictionary>
Application.Resources>
Application>
主界面布局
<Window
x:Class="Localization.Core.MainWindow"
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:local="clr-namespace:Localization.Core"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:operate="clr-namespace:Localization.Core.Operates"
Title="{DynamicResource WindowsTitle}"
Width="800"
Height="450"
Icon="{DynamicResource icon}"
mc:Ignorable="d">
<Grid>
<Grid.RowDefinitions>
<RowDefinition Height="Auto" />
<RowDefinition />
Grid.RowDefinitions>
<ComboBox
x:Name="comLan"
Width="{Binding SizeToContent.Width}"
Height="{Binding SizeToContent.Width}"
HorizontalAlignment="Center"
VerticalAlignment="Center"
SelectedValuePath="Tag"
SelectionChanged="ComboBox_SelectionChanged">
<ComboBoxItem Content="中文" Tag="zh-CN" />
<ComboBoxItem Content="English" Tag="en-US" />
ComboBox>
<StackPanel Grid.Row="1">
<Button
Margin="0,50,0,0"
HorizontalAlignment="Center"
VerticalAlignment="Center"
Content="{DynamicResource LanguageButton}" />
<ComboBox
x:Name="cmTime"
Width="120"
Margin="20"
VerticalAlignment="Center">
<ComboBox.ItemTemplate>
<DataTemplate>
<TextBlock Text="{operate:ResourceBinding Key}" />
DataTemplate>
ComboBox.ItemTemplate>
ComboBox>
StackPanel>
Grid>
Window>
cs代码
public partial class MainWindow : Window
{
ObservableCollection<KeyValuePair<string, int>>? TimeList { get; set; }
public MainWindow()
{
InitializeComponent();
var lan = Thread.CurrentThread.CurrentCulture.Name;
comLan.SelectedValue = lan;
Loaded += MainWindow_Loaded;
}
private void MainWindow_Loaded(object sender, RoutedEventArgs e)
{
TimeList = new ObservableCollection<KeyValuePair<string, int>>()
{
new KeyValuePair<string, int>("LockTime-OneMinute", 1),
new KeyValuePair<string, int>("LockTime-FiveMinute", 5),
new KeyValuePair<string, int>("LockTime-TenMinute", 10),
new KeyValuePair<string, int>("LockTime-FifteenMinute", 15),
new KeyValuePair<string, int>("LockTime-ThirtyMinute", 30),
new KeyValuePair<string, int>("LockTime-OneHour", 60),
new KeyValuePair<string, int>("LockTime-TwoHour", 120),
new KeyValuePair<string, int>("LockTime-ThreeHour", 180),
new KeyValuePair<string, int>("LockTime-Never", 0),
};
cmTime.ItemsSource = TimeList;
cmTime.SelectedValue = TimeList[0];
}
private void ComboBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
if (e.AddedItems is null) return;
LanguageOperate.SetLanguage((e.AddedItems[0] as ComboBoxItem)!.Tag.ToString()!);
}
}
App.config
language配置项用于保存用户选择的语言类型
<configuration>
<appSettings>
<add key="language" value=""/>
appSettings>
configuration>
辅助类
语言切换操作类
检查方法入参，有值则切换到指定的资源，无值则读取配置文件中的值，若配置文件中仍无值，则获取当前线程运行的语言环境，切换到与语言环境相匹配的资源，如果没有找到与之匹配的资源则不做操作。
切换资源之后，将配置文件中的language的 value 改为当前所选的语言保存并刷新配置文件，直到下次更改。
重写
Application类的OnStartup方法，在OnStartup中调用SetLanguage方法以实现应用程序启动对语言环境的判别。
/// 资源 binding 解析类
ComBox 控件通常是通过 ItemSource 进行绑定，默认情况下是无法对绑定的资源进行翻译的。
通过继承MarkupExtension类 重写ProvideValue方法来实现，item 绑定 资源的 Key 的解析。
/// 实现效果
