背景概述

世界经济日益全球化的同时,一个应用程序需要在全球范围内使用势在必然。传统的程序设计方法将可翻译信息如菜单按钮的标签,提示信息,帮助文档等文字信息硬编码在程序代码中,不能很好的适应全球化发展,程序的扩展性差,维护成本高。一个能支持全球化的应用程序,必须实现单一可执行的程序,动态地使用资源(Single Source Single Executable),图1 是两种模型的对比图。

图 1. 传统的程序模型和支持全球化程序模型

对于一个能支持全球化的应用程序来说:

一方面需要考虑的是用户的语言环境(我们称作 Language Locale):这里主要就是指翻译,在不同的国家用他们自己的语言正确运作软件,让客户感觉这个产品是为他们而设计的;

另一方面就是用户的文化环境(我们称作 Culture Locale):主要处理的是多元文化的支持,包括货币、日历、时间、日期、排序、界面方向性(Bi-directional) 等符合各个国家自己习惯的显示方式。

图2 概述了如何使得一个应用程序(C/S 或者 B/S)支持全球化和本地化。

图 2. 全球化应用程序

本文结合项目实践,总结了 web 应用程序中 Java,JSP,Dojo 和 HTML 四种不同语言是如何管理 Resource Bundle 的,实现单一可执行程序动态读取资源文件,从而支持全球化和本地化。主要从三个方面来阐述:资源文件存储和命名规则;用户语言区域信息的读取;如何取得对应语言的资源文件中的键值。

Java 程序中的 Resource Bundle 管理

ResourceBundle 是一个机制,主要用来根据用户的语言环境展示不同的界面文字给用户,让用户感觉这个应用程序为我而定制。

然而 Java 中的 ResourceBundle 是一个类,包含在标准的 Java 发行版中。图3总结了 Java 程序中 ResourceBundle 的管理机制。

图 3. Java 程序 Resource Bundle 管理流程

Java 程序中资源文件的存储和命名

在一个多模块的 Java 应用程序中,一般每个模块都有自己独立的资源文件(也叫 Resource Bundles),Resource Bundle 一般存储在对应模块的 src/resources/bundles/java/ 目录下面。通常的命名规则是:模块名_语言_国家 .properties({moduleName}_{language}_{country}.properties)。对应资源文件中的每一个 key,一般都是小写字母开头,用下划线表示这个 key 在程序中的层级结构,并且按照字母顺序排序,便于管理和查找,如清单1所示的例子。

清单 1. Java properties 文件示例

  1. 英文Properties 文件:
  2. helloKey=Hello!
  3. goodMorningKey=Good Morning!
  4. goodEveningKey=Good Evening!
  5. 日语Properties 文件:
  6. helloKey=\u3053\u3093\u306b\u3061\u306f!
  7. goodMorningKey=\u304a\u306f\u3088\u3046!
  8. goodEveningKey=\u3053\u3093\u3070\u3093\u306f!

Java 程序对资源文件的回滚机制:当对应翻译的资源文件不存在时,将使用"默认"的资源文件(通常为英文),图 4 是 Java 资源文件的组织方式。

图 4. Java 资源文件组织方式

Java 中用户语言环境(Locale)和资源文件的读取

根据用户使用的区域信息来决定从哪个 Resource Bundle 里面读取对应的 key 值。Java 语言通过 java.util.Locale 类来表示区域,一个 Locale 实例就代表了一个特定的区域。在实际的项目中,通常将读取资源文件包装成一个类,方便后续代码的重用和管理,如清单 2 的示例所示。

清单 2. Java 中 ResourceBundleService 使用

  1. public class LocalizedPropertyResources extends MessageResources {
  2. private static final String MODULE_NAME = "resourceBundle.module.name";
  3. public String getProperty(String key, Object... parameters) {
  4. Locale locale = getUserLocale();
  5. String value = getProperty(key, locale, parameters);
  6. Return value;
  7. }
  8. public String getProperty(String key, Locale locale, Object... parameters) {
  9. ResourceBundle resourceBundle = ResourceBundle.getBundle(MODULE_NAME, locale);
  10. String value resourceBundle.getString(key, parameters);
  11. return value;
  12. }
  13. }

JSP 中的 Resource Bundle 管理

资源文件管理:JSP 是基于 Java 技术,所以 Java 中的 ResourceBundle 机制也可以应用于 JSP,同样以 .properties 形式存储资源文件,资源文件的命名规则、资源文件的存储结构,key 的命名规则等都可以遵循 Java 程序中的 Resource Bundle 管理机制。

用户语言环境的设定:HTTP 协议通过 Accept-Language 请求头将本地化信息从浏览器传递至服务器, JSTL fmt 库中的定制标记又会利用这些方法来自动地确定用户的语言环境,从而相应地调整它们的输出。同时用户也可以通过 来设置用户语言环境。

对于 JSP 中资源文件的读取有以下三种情况:

1、使用 fmt 消息标签:JSP 标准标签库(JSP Standard Tag Library,JSTL)中的 fmt标签支持通过资源文件(ResourceBundle)对文本内容进行本地化,该功能可以对一个特定的语言请求作出相应的响应,它使用了 J2SE 的 ResourceBundle 来保持各种翻译过的语言编码。另外用来设置地区,比如,这等于设定了语言和国家代码。默认 JPS 将读取 Accept-Language 信息。还可以指定 ResourceBundle,比如: 。一旦设定了 locale(地区)或 ResourceBundle,就可以使用 来把原文进行相应的转化,同时还可以使用< fmt:requestEncoding/>来设定请求的字符编码。如清单3 示例所示:

清单 3. JSTL fmt 标签示例

  1. //myTest.jsp
  2. <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
  3. <html>
  4. <head>
  5. <title>JSTL fmt: Localized tag testing</title>
  6. </head>
  7. <body>
  8. <fmt:requestEncoding value="UTF-8" />
  9. <fmt:setLocale value="zh_TW"/>
  10. <fmt:setTimeZone value= "GMT+8" scope="request"/>
  11. <fmt:bundle basename="src.resources.bundles.java.menu ">
  12. <fmt:message key="OK"/><br/>
  13. <fmt:message key="CANCEL"/><br/>
  14. </fmt:bundle>
  15. //也可以通过下面的方式获取资源文件
  16. <fmt:setBundle basename="src.resources.bundles.java.menu"    var="resources"/>
  17. <fmt:message key="OK"/><br/>
  18. <fmt:message key="CANCEL"/><br/>
  19. </body>
  20. </html>

2、被 Spring 管理的 JSP,通常 JSP 中有这样的 taglig"",这种情况下可以使用 Spring message 标签。

  1. <%@ taglib prefix="spring" uri="http://www.springframework.org/tags" %>
  2. <spring:message code="common_button_ok"/>

3、对于由 Struts 操作类提供的JSP,可以使用 Struts bean 消息标签:

  1. <%@ taglib uri="/tags/struts-bean" prefix="bean" %>
  2. <bean:message key=" common_button_ok "/>

Dojo 中的 Resource Bundle 管理

Dojo 是一个 JavaScript 库,提供了一个有用的工具来创建丰富的 Web 客户端界面。同时 Dojo 也提供了 API 支持全球化功能,如翻译资源包,函数的格式化和解析日期、数字和货币,Dojo 对全球化的支持主要基于 CLDR (Common Locale Data Repository) 和 ICU 的使用。 这一小节总结了 Dojo 中资源文件的管理,用户区域信息(locale)和资源文件的读取,如图5所示。

图 5. Dojo 中资源文件管理

Dojo 中资源文件的存储和命名

UTF-8 是 Dojo 程序编码的先决条件,Dojo 脚本一般将使用 HTML,JSP,Servlet,js等编写,所以这些文件必须以 UTF-8 编码。Dojo 用 JSON 格式来组织资源文件,首先在 /nls 目录下有一个主资源文件(一般是英文),主资源文件中定义了支持的区域,区域的值设置为 true 或者 false,如清单4所示。

清单 4. Dojo 主资源文件的定义

  1. define({
  2. root: {
  3. OK: "Ok",
  4. CANCEL: "Cancel",
  5. OK_CANCEL: "${OK}, ${CANCEL}"
  6. },
  7. "ko": true,
  8. "ja": true,
  9. "ru": false,
  10. "zh-cn": true
  11. });

翻译的资源文件应放在/ nls / 目录中,目录的命名需要符合下面的规范:

  • 目录的名称必须要全部小写
  • 用横线(而不是下划线)分割语言和国家,比如 zh-cn,zh-tw 等,如清单5所示。

清单 5. 翻译资源文件的目录结构

  1. /src/web/js/nls/menu.js       ... 主资源文件,用于默认的消息显示
  2. /src/web/js/nls/ko/menu.js    ... 韩语的翻译文件
  3. /ja/menu.js    ... 日语的翻译文件
  4. /ru/menu.js    ...俄语的翻译文件
  5. /zh-cn/menu.js  ...简中的翻译文件
  6. ...

Dojo 资源文件的回滚机制为:在 / nls 目录的根目录下如果检测到区域设置,但 nls 目录中不存在特定于区域设置的资源,则将使用主包;当主资源文件中某个语言设置为 false 时,即使该语言的资源文件存在,也将使用主包。

Dojo 中用户语言环境(Locale)和资源文件的读取

Dojo 和 Java 以相同的方式支持用户区域信息,但 Dojo 和 Java 实现之间存在微小差异。

  • "Dojo 和 Java 对区域设置命名约定有一些区别,Dojo 使用" - "(连字符)作为连接语言代码,国家代码和变体的分隔符,而 Java 使用"_"(下划线)。例如,Java 中的 "zh_CN" 与 Dojo 中的 "zh-cn" 相似。
  • 像 Java 中的默认用户语言区域一样,Dojo 有一个全局变量 dojo.locale 用来存储默认 locale 值,但是我们不能直接修改 dojo.locale,可以通过 dojoConfig.locale 来对 dojo.locale 做初始化工作。
  • 如果 dojoConfig.locale 未定义,Dojo 使用浏览器的显示语言作为用户区域设置。另外 dojoConfig.locale 的设定需要在加载 dojo.js 之前,这样设置的 dojoConfig.locale 才会起效果。如清单 6 是一个示例将用户的 locale 信息保存在 sessionScope,然后传递给 dojoConfig。

清单 6. 将用户 locale 保存在 sessionScope 传递给 dojoConfig

  1. var dojoConfig = {
  2. async: 'sync',
  3. baseUrl: '',
  4. locale: '${sessionScope.userLanguageLocale}',
  5. bindEncoding: "utf-8",
  6. };

userLanguageLocale:是应用程序中用户所设定的 locale,每个应用程序可能不太一样。

Dojo 中有两种方式读取资源文件:

方式 1:又叫 AMD 方式,通过 dojo/i18n! 这个插件加载资源文件,首先检测 dojoConifg.locale 是否设置,如果设置了就读取 dojoConfig.locale,否则就会使用浏览器的显示语言读取对应的翻译资源文件。清单 7 是 dojo/i18n! 的使用示例。

清单 7. Dojo/i18n!使用示例

  1. ...
  2. <script src="dojo-release-1.9.1/dojo/dojo.js" data-dojo-config="async: true, parseOnLoad: true></script>
  3. <script>
  4. require(["dojo/string", "dojo/i18n!js/nls/menu"],
  5. function(string, resources){
  6. var strOk = resources.OK;
  7. alert(strOk);
  8. });
  9. </script>
  10. ...

方式 2: 使用 dojo.requireLocalization 加载资源文件,dojo.i18n.getLocalization 读取资源文件,这个是旧的资源加载方式,新的 Dojo 版本都将采用 AMD 的方式,不过这种方式用户可以指定 locale 信息,缺省 locale 的时候,采用和 AMD 同样的 locale 解析方式。清单8 是一个示例。

清单 8. Dojo. requireLocalization 使用示例

  1. <script src="dojo-release-1.9.1/dojo/dojo.js" data-dojo-config="async: true, parseOnLoad: true></script>
  2. <script>
  3. dojo.require("dojo.i18n");
  4. dojo.requireLocalization("js", "menu");
  5. var resources = dojo.i18n.getLocalization("js", "menu", locale);
  6. //或者省去 locale 参数,var resources = dojo.i18n.getLocalization("js", "menu")
  7. alert(resources.OK);
  8. </script>
  9. ...

HTML 中的 Resource Bundle 管理

HTML 中的硬编码(Hard Code)通常分为两种情况:一种情况是 HTML 页面不涉及任何编程逻辑,这时候可以翻译整个 HTML 文件(这种方式在开发过程中不需要特殊处理),或者将 HTML 变更为 JSP,这样就可以利用 JSP 中 fmt 标签将 Hard Code 提取出来,如清单 9 示例所示。

清单 9. HTML 更改为 JSP

  1. //Index.html
  2. <html>
  3. <head>
  4. <script language="JavaScript">
  5. window.location = "/login.do";
  6. </script>
  7. <title> Welcome Page </title>
  8. </head>
  9. <body>
  10. </body>
  11. </html>
  12. //将 Index.html 更改为 Index.jsp,这样就可以利用 JSP 中 fmt 标签
  13. <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
  14. <%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>
  15. <html>
  16. <head>
  17. <script language="JavaScript">
  18. </script>
  19. <title> <fmt:message key="common_welcome" /></ title>
  20. </head>
  21. <body>
  22. </body>
  23. </html>
  24. //test.properties
  25. Common_welcome=Welcome Page

//将 Index.html 更改为 Index.jsp,这样就可以利用 JSP 中 fmt 标签

另外一种情况是 HTML 作为 Dojo widget 模板文件,这种情况下可以使用 dojo API 的 i18n 库来处理硬编码消息,其处理方式和 Dojo 很类似,模板 HTML 文件中使用的 Key 需要在 Widget 的 js 文件中定义和获取。下面将通过示例介绍 HTML 作为 Dojo 模板文件时,如何抽取当中的 hard code 信息。通常分三个步骤完成模板 HTML 文件中的字符串抽取。

第一步: 将 HTML 中的字符串放到一个资源文件如 message.js 中,资源文件的组织方式和 Dojo 是一样的;

第二步: 在 Dojo widget 的 js 文件中使用 Dojo Resource Bundle 获取资源文件,定义变量获取对应的Key值;

第三步: 在HTML模板文件中使用 Dojo .js 文件中定义的变量。如清单 10 所示。

清单 10. HTML 作为 Dojo Widget 模板

  1. Test.html
  2. <div dojoAttachPoint="testNode" style="display:inline">
  3. <table style="position: relative; margin: 20px 0 0 120px; padding: 0;">
  4. <tr>
  5. <td style="text-align: right;">Username:</td> //原来的 hard code
  6. <td style="text-align: right;">${usernameLabel}</td> //Resource out 之后的变量引用
  7. ….
  8. </tr>
  9. </div>
  10. Test.js
  11. dojo.requireLocalization("js", "message");
  12. dojo.declare("Test") {
  13. templatePath: dojo.moduleUrl("common", " /html/Test.html"),
  14. usernameLabel: "",
  15. postMixInProperties: function(){
  16. this.inherited(arguments);
  17. var resources = dojo.i18n.getLocalization("js", "message");
  18. this.usernameLabel = resources.labels.username; //获取资源文件
  19. }
  20. }

清单 11. HTML 中特殊硬编码处理

  1. // Hard Code
  2. <html>
  3. <body>
  4. <select id="Product">
  5. <option>Is Not</option>
  6. <option>Is</option>
  7. </select>
  8. </body>
  9. </html>
  10. //处理后的 HTML
  11. <html>
  12. <body>
  13. <select id="Product">
  14. <option value="Is Not"> ${ Label.IS_NOT}</option>
  15. <option value="Is">${Label.IS}</option>
  16. </select>
  17. </body>
  18. </html>

总结

本文总结了如何存储 web 应用程序中使用不同框架时的资源文件及其命名规则,如何取得资源文件中的键值。希望这篇文章能为正在开发国际化 Web 应用程序的读者提供一定的参考价值。

本文作者:佚名

来源:51CTO

Web应用程序中Resource Bundle技术概述相关推荐

  1. azure web应用部署_Java Web应用程序中的Azure AD SSO,ADFS SSO配置

    azure web应用部署 Azure AD单点登录 (Azure AD SSO) The Single Sign-On feature is getting popular among develo ...

  2. 在Web应用程序中使用Canvas API

    更多HTML 5文章请查阅HTML 6在线网站http://www.html5online.com.cn 本文概述 本文介绍如何在一个Web应用程序中利用HTML 5中的Canvas API创建.编辑 ...

  3. DotNetCore Web应用程序中的Session管理

    原文来自互联网,由长沙DotNET技术社区编译.如译文侵犯您的署名权或版权,请联系小编,小编将在24小时内删除.限于译者的能力有限,个别语句翻译略显生硬,还请见谅. 作者简介:Jon(Jonathan ...

  4. DotNetCore Web应用程序中的Cookie管理

    原文来自互联网,由长沙DotNET技术社区编译.如译文侵犯您的署名权或版权,请联系小编,小编将在24小时内删除.限于译者的能力有限,个别语句翻译略显生硬,还请见谅. 作者简介:Jon(Jonathan ...

  5. threadlocal线程_线程故事:Web应用程序中的ThreadLocal

    threadlocal线程 本周,我花了一些合理的时间来消除Web应用程序中的所有ThreadLocal变量. 原因是他们造成了类加载器泄漏,我们不能再适当地取消部署我们的应用程序. 取消部署应用程序 ...

  6. 在Spring MVC Web应用程序中添加社交登录:集成测试

    我已经写了关于为使用Spring Social 1.1.0的应用程序编写单元测试的挑战,并为此提供了一种解决方案 . 尽管单元测试很有价值,但是它并不能真正告诉我们我们的应用程序是否正常运行. 这就是 ...

  7. 线程故事:Web应用程序中的ThreadLocal

    本周,我花了一些合理的时间来消除Web应用程序中的所有ThreadLocal变量. 原因是他们造成了类加载器泄漏,我们不能再适当地取消部署我们的应用程序. 取消部署应用程序后,当GC根目录继续引用应用 ...

  8. java面试题8 牛客:在Web应用程序中,( )负责将HTTP请求转换为HttpServletRequest对象

    在Web应用程序中,(    )负责将HTTP请求转换为HttpServletRequest对象 A Servlet对象 B HTTP服务器 C Web容器 D JSP网页 首先我们来看看web程序的 ...

  9. Spring Boot Web应用程序中注册 Servlet 的方法实例

    Spring Boot Web应用程序中注册 Servlet 的方法实例 本文实例工程源代码:https://github.com/KotlinSpringBoot/demo1_add_servlet ...

  10. Web应用程序中(VS2005+SP1)添加App_Code(转)

    Web应用程序中(VS2005+SP1)添加App_Code 在Web应用程序中不能通过右键项目-〉"添加"-〉"添加ASP.NET文件夹"方式添加 .因为We ...

最新文章

  1. 【Python基础】在pandas中利用hdf5高效存储数据
  2. boost::owner_less相关的测试程序
  3. 时间相减得到小时数 java_【高中数学】错位相减公式求差比数列的和
  4. Linux 上安装 SQL Server
  5. 最长公共子序列Python解法
  6. android webview framework,android – Webview导致ANR
  7. 聊聊gcc参数中的-I, -L和-l
  8. oracle中dbms_并发和由于DBMS中的并发导致的问题
  9. ansible-playbook Roles include
  10. plsql dev中Dynamic Performance Tables not accessible分析解决(转载)
  11. 使用python+机器学习方法进行情感分析(详细步骤)
  12. #39;git merge#39;和#39;git rebase#39;有什么区别?
  13. Spring AOP 实现用户权限验证
  14. 使用Microsoft R Server进行机器学习和模型发布(2)
  15. 卡尔曼滤波算法-Kalman filter
  16. 用C++可编程管线渲染obj模型
  17. Word文件没有保存怎么找回来?恢复文件
  18. 25篇最新CV领域综述性论文速递!涵盖15个方向:目标检测/图像处理/姿态估计/医学影像/人脸识别等方向...
  19. WSO2一般使用教程
  20. Python 3,4行代码实现去除图片背景色,从此告别PS!!

热门文章

  1. Object-c 协议@protocol(@required、@optional)
  2. MYSQL file types redo log
  3. 每日一九度之题目1021:统计字符
  4. scp 跨机远程拷贝
  5. Labview 中的类
  6. Hadoop 2.2.0 在centos6.2 64位下的安装--分布式模式
  7. Psychology
  8. BZOJ 3676 回文串(回文树)题解
  9. HTML,CSS基础十大重点问题
  10. springboot格式化时间