Asp.Net Core MVC项目实现多语言实例(Globalization/Localization)
正好最近手上在给一个razor mvc项目实现一个多语言功能,叫globalization也好,localization也好,whatever。最终要实现的效果呢,就是一键切换全站语言,并且开发的时候只需要写一套页面。
下面进入正题
首先,我们要创建一个cultureconfigurer类,用于管理本地化资源,完成“翻译”环节:
这里我用了静态类,然后在mvc项目startup的时候执行init()方法,其实有点蠢,当然你们也可以先写一个接口然后用依赖注入成单例。
using system.collections.generic; using system.io; using system.reflection; using newtonsoft.json; namespace localization { public enum culture { cn, en } public static class cultureconfigurer { private static dictionary<string, string> _endictionary; private static dictionary<string, string> _cndictionary; public static void init() { var assembly = assembly.load(new assemblyname("localization")); var resourcenames = assembly.getmanifestresourcenames(); foreach (var resourcename in resourcenames) { if (resourcename.endswith("en-us.json") || resourcename.endswith("zh-cn.json")) { using (var stream = assembly.getmanifestresourcestream(resourcename)) { if (stream != null) { using (streamreader reader = new streamreader(stream)) { var content = reader.readtoend(); dictionary<string, string> localizationdictionary = jsonconvert.deserializeobject<dictionary<string, string>>(content); if (resourcename.endswith("en-us.json")) { _endictionary = localizationdictionary; } else { _cndictionary = localizationdictionary; } } } } } } } public static string getvalue(string key, culture culture) { switch (culture) { case (culture.cn): { if (_cndictionary.containskey(key)) { return _cndictionary[key]; } else { return $"[{key}]"; } } case (culture.en): { if (_endictionary.containskey(key)) { return _endictionary[key]; } else { return $"[{key}]"; } } default: { return $"[{key}]"; } } } } }
这里需要注意几点:
1. enum类culture用于代表要实现的语言,这里我只是简单的实现了中文和英文(其他我也不懂),对应的cultureconfigurer类就有中文和英文两个dictionary
2. 使用了assembly.load加载了程序集,参数为你自己的程序集名称,我这里就随便写了一个
3. 资源文件我选择了json文件,也是为了方便js中调用,当然你也可以用xml或者任何你想要用的格式,只需要调整解析方法,把文件内容加载到对应的dictionary中就可以了
4. 看到getvalue方法,相信大家都已经明白了,其实就是多语言不管是什么语言,都用某个词做key,然后调用这个方法“翻译”成当前语言的词。比如以“open”作为key,那么中文dictionary中就应该有一个keyvaluepair是"open":"打开",而相应的英文中应该有一个"open":"open",那么culture为中文时,显示就是“打开”,英文就是“open”。
5. 资源文件可以创建在程序集中的任何位置,如果你的项目有project.json文件,那么就在buildoptions里面添加,注意根据自己的文件位置修改路径
"embed": { "include": [ "localization/sourcefiles/*.json" ] }
如果是vs2017,是csproj文件,那么右击要添加的资源文件,选择“属性”,配置改为“所有配置”,配置属性的高级中“生成操作”修改为“嵌入的资源”,如下图:
到这里,我们已经写好了实现本地化的核心类,下面要解决如何在页面上显示的问题:
在mvc项目中新建一个类myrazorpage
using system; using microsoft.aspnetcore.mvc.razor; using localization; namespace mvc.views { public abstract class myrazorpage<tmodel> : razorpage<tmodel> { public virtual string l(string source) { var value = context.request.cookies["__culture"]; culture c; if (string.isnullorempty(value) || !enum.tryparse(value, out c)) { c = culture.cn; } return cultureconfigurer.getvalue(source, c); } } }
注意这个类是一个抽象类,继承了razorpage<tmodel>。然后在views文件夹下找到_viewimports.cshtml文件,在里面添加一行“@inherits mvc.views.myrazorpage<tmodel>”,这样你的所有razorpage就会继承myrazorpage这个类,也就是说你可以在myrazorpage里写自己想要用的方法,在cshtml里就可以直接调用啦。这里我写了一个l方法,调用了cultureconfigurer的getvalue方法。那么,在页面上需要翻译的文字就只要写成@l("open")这样的就可以啦。
可以看到,我是将用户语言保存在cookie中的,这里大家可以有各自的实现方法。我的实现方法很简单,用户切换语言的时候就访问一个接口,修改了代表语言的cookie,然后刷新页面就可以了。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。