閱讀806 返回首頁    go 技術社區[雲棲]

Web應用程序中Resource Bundle技術概述

背景概述

世界經濟日益全球化的同時，一個應用程序需要在全球範圍內使用勢在必然。傳統的程序設計方法將可翻譯信息如菜單按鈕的標簽，提示信息，幫助文檔等文字信息硬編碼在程序代碼中，不能很好的適應全球化發展，程序的擴展性差，維護成本高。一個能支持全球化的應用程序，必須實現單一可執行的程序，動態地使用資源(Single Source Single Executable)，圖1 是兩種模型的對比圖。

圖 1. 傳統的程序模型和支持全球化程序模型

Web應用程序中Resource Bundle技術概述

Web應用程序中Resource Bundle技術概述

對於一個能支持全球化的應用程序來說：

一方麵需要考慮的是用戶的語言環境(我們稱作 Language Locale)：這裏主要就是指翻譯，在不同的國家用他們自己的語言正確運作軟件，讓客戶感覺這個產品是為他們而設計的;

另一方麵就是用戶的文化環境(我們稱作 Culture Locale)：主要處理的是多元文化的支持，包括貨幣、日曆、時間、日期、排序、界麵方向性(Bi-directional) 等符合各個國家自己習慣的顯示方式。

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

圖 2. 全球化應用程序

Web應用程序中Resource Bundle技術概述Web應用程序中Resource Bundle技術概述

本文結合項目實踐，總結了 web 應用程序中 Java，JSP，Dojo 和 HTML 四種不同語言是如何管理 Resource Bundle 的，實現單一可執行程序動態讀取資源文件，從而支持全球化和本地化。主要從三個方麵來闡述：資源文件存儲和命名規則;用戶語言區域信息的讀取;如何取得對應語言的資源文件中的鍵值。

Java 程序中的 Resource Bundle 管理

ResourceBundle 是一個機製，主要用來根據用戶的語言環境展示不同的界麵文字給用戶，讓用戶感覺這個應用程序為我而定製。

然而 Java 中的 ResourceBundle 是一個類，包含在標準的 Java 發行版中。圖3總結了 Java 程序中 ResourceBundle 的管理機製。

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

Web應用程序中Resource Bundle技術概述

Web應用程序中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. 

  2.     helloKey=Hello! 
    3. 

  3.     goodMorningKey=Good Morning! 
    4. 

  4.     goodEveningKey=Good Evening! 
    5. 

  5.      
    6. 

  6. 日語Properties 文件： 
    7. 

  7.     helloKey=\u3053\u3093\u306b\u3061\u306f! 
    8. 

  8.     goodMorningKey=\u304a\u306f\u3088\u3046! 
    9. 

  9.     goodEveningKey=\u3053\u3093\u3070\u3093\u306f! 
    10. 



Java 程序對資源文件的回滾機製：當對應翻譯的資源文件不存在時，將使用"默認"的資源文件(通常為英文)，圖 4 是 Java 資源文件的組織方式。


圖 4. Java 資源文件組織方式


Web應用程序中Resource Bundle技術概述


Java 中用戶語言環境(Locale)和資源文件的讀取


根據用戶使用的區域信息來決定從哪個 Resource Bundle 裏麵讀取對應的 key 值。Java 語言通過
java.util.Locale 類來表示區域，一個 Locale
實例就代表了一個特定的區域。在實際的項目中，通常將讀取資源文件包裝成一個類，方便後續代碼的重用和管理，如清單 2 的示例所示。


清單 2. Java 中 ResourceBundleService 使用




    

  1. 
public class LocalizedPropertyResources extends MessageResources {  
    2. 

  2. private static final String MODULE_NAME = "resourceBundle.module.name";  
    3. 

  3. 
public String getProperty(String key, Object... parameters) {  
    4. 

  4. Locale locale = getUserLocale();  
    5. 

  5. String value = getProperty(key, locale, parameters);  
    6. 

  6. 
Return value;  
    7. 

  7. }  
    8. 

  8. 
public String getProperty(String key, Locale locale, Object... parameters) {  
    9. 

  9. ResourceBundle resourceBundle = ResourceBundle.getBundle(MODULE_NAME, locale);  
    10. 

  10. String value resourceBundle.getString(key, parameters);  
    11. 

  11. 
return value;  
    12. 

  12. }  
    13. 

  13. } 
    14. 



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. 

  2. <%@ taglib uri="https://java.sun.com/jsp/jstl/fmt" prefix="fmt" %> 
    3. 

  3.  
    4. 

  4. <html> 
    5. 

  5.   <head> 
    6. 

  6.     <title>JSTL fmt: Localized tag testing</title> 
    7. 

  7.   </head> 
    8. 

  8.  
    9. 

  9.  <body> 
    10. 

  10.   <fmt:requestEncoding value="UTF-8" /> 
    11. 

  11.   <fmt:setLocale value="zh_TW"/> 
    12. 

  12.   <fmt:setTimeZone value= "GMT+8" scope="request"/> 
    13. 

  13.   <fmt:bundle basename="src.resources.bundles.java.menu "> 
    14. 

  14.       <fmt:message key="OK"/><br/> 
    15. 

  15.       <fmt:message key="CANCEL"/><br/> 
    16. 

  16.   </fmt:bundle> 
    17. 

  17. //也可以通過下麵的方式獲取資源文件 
    18. 

  18.  
    19. 

  19.   <fmt:setBundle basename="src.resources.bundles.java.menu"    var="resources"/> 
    20. 

  20.     … 
    21. 

  21.     <fmt:message key="OK"/><br/> 
    22. 

  22.     <fmt:message key="CANCEL"/><br/> 
    23. 

  23.      … 
    24. 

  24.   </body> 
    25. 

  25. </html> 
    26. 



2、被 Spring 管理的 JSP，通常 JSP 中有這樣的 taglig""，這種情況下可以使用 Spring message 標簽。




    

  1. <%@ taglib prefix="spring" uri="https://www.springframework.org/tags" %>  
    2. 

  2. <spring:message code="common_button_ok"/> 
    3. 



3、對於由 Struts 操作類提供的JSP，可以使用 Struts bean 消息標簽：




    

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

  2. <bean:message key=" common_button_ok "/> 
    3. 



Dojo 中的 Resource Bundle 管理


Dojo 是一個 JavaScript 庫，提供了一個有用的工具來創建豐富的 Web 客戶端界麵。同時 Dojo 也提供了 API
支持全球化功能，如翻譯資源包，函數的格式化和解析日期、數字和貨幣，Dojo 對全球化的支持主要基於 CLDR (Common Locale
Data Repository) 和 ICU 的使用。 這一小節總結了 Dojo
中資源文件的管理，用戶區域信息(locale)和資源文件的讀取，如圖5所示。


圖 5. Dojo 中資源文件管理


Web應用程序中Resource Bundle技術概述


Web應用程序中Resource Bundle技術概述


Dojo 中資源文件的存儲和命名


UTF-8 是 Dojo 程序編碼的先決條件，Dojo 腳本一般將使用 HTML，JSP，Servlet，js等編寫，所以這些文件必須以
UTF-8 編碼。Dojo 用 JSON 格式來組織資源文件，首先在 /nls
目錄下有一個主資源文件(一般是英文)，主資源文件中定義了支持的區域，區域的值設置為 true 或者 false，如清單4所示。


清單 4. Dojo 主資源文件的定義




    

  1. define({ 
    2. 

  2.       root: { 
    3. 

  3.         OK: "Ok", 
    4. 

  4.         CANCEL: "Cancel", 
    5. 

  5.         OK_CANCEL: "${OK}, ${CANCEL}" 
    6. 

  6.       }, 
    7. 

  7.       "ko": true, 
    8. 

  8.       "ja": true, 
    9. 

  9.       "ru": false, 
    10. 

  10.       "zh-cn": true 
    11. 

  11.     }); 
    12. 



翻譯的資源文件應放在/ nls / 目錄中，目錄的命名需要符合下麵的規範：


    

  • 目錄的名稱必須要全部小寫
    • 

  • 用橫線(而不是下劃線)分割語言和國家，比如 zh-cn，zh-tw 等，如清單5所示。
    • 



清單 5. 翻譯資源文件的目錄結構




    

  1. /src/web/js/nls/menu.js       ... 主資源文件，用於默認的消息顯示 
    2. 

  2.     /src/web/js/nls/ko/menu.js    ... 韓語的翻譯文件 
    3. 

  3.                     /ja/menu.js    ... 日語的翻譯文件 
    4. 

  4.                     /ru/menu.js    ...俄語的翻譯文件 
    5. 

  5.                      /zh-cn/menu.js  ...簡中的翻譯文件 
    6. 

  6.                     ... 
    7. 



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. 

  2.             async: 'sync', 
    3. 

  3.             baseUrl: '', 
    4. 

  4.             locale: '${sessionScope.userLanguageLocale}', 
    5. 

  5.              
    6. 

  6.              bindEncoding: "utf-8", 
    7. 

  7.                 … 
    8. 

  8.         }; 
    9. 



userLanguageLocale：是應用程序中用戶所設定的 locale，每個應用程序可能不太一樣。


Dojo 中有兩種方式讀取資源文件：


方式 1：又叫 AMD 方式，通過 dojo/i18n! 這個插件加載資源文件，首先檢測 dojoConifg.locale
是否設置，如果設置了就讀取 dojoConfig.locale，否則就會使用瀏覽器的顯示語言讀取對應的翻譯資源文件。清單 7 是
dojo/i18n! 的使用示例。


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




    

  1. ...  
    2. 

  2. <script src="dojo-release-1.9.1/dojo/dojo.js" data-dojo-config="async: true, parseOnLoad: true></script>  
    3. 

  3. <script>  
    4. 

  4. require(["dojo/string", "dojo/i18n!js/nls/menu"],  
    5. 

  5. 
function(string, resources){  
    6. 

  6. var strOk = resources.OK;  
    7. 

  7. alert(strOk);  
    8. 

  8. });  
    9. 

  9. </script>  
    10. 

  10. ... 
    11. 



方式 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. 

  2. <script>  
    3. 

  3. dojo.require("dojo.i18n");  
    4. 

  4. dojo.requireLocalization("js", "menu");  
    5. 

  5. var resources = dojo.i18n.getLocalization("js", "menu", locale);  
    6. 

  6. //或者省去 locale 參數，var resources = dojo.i18n.getLocalization("js", "menu")  
    7. 

  7. alert(resources.OK);  
    8. 

  8. </script>  
    9. 

  9. ... 
    10. 



HTML 中的 Resource Bundle 管理


HTML 中的硬編碼(Hard Code)通常分為兩種情況：一種情況是 HTML 頁麵不涉及任何編程邏輯，這時候可以翻譯整個 HTML
文件(這種方式在開發過程中不需要特殊處理)，或者將 HTML 變更為 JSP，這樣就可以利用 JSP 中 fmt 標簽將 Hard Code
提取出來，如清單 9 示例所示。


清單 9. HTML 更改為 JSP




    

  1. //Index.html  
    2. 

  2. <html>  
    3. 

  3. <head>  
    4. 

  4. <script language="JavaScript">  
    5. 

  5. window.location = "/login.do";  
    6. 

  6. </script>  
    7. 

  7. <title> Welcome Page </title>  
    8. 

  8. </head>  
    9. 

  9. <body>  
    10. 

  10. …  
    11. 

  11. </body>  
    12. 

  12. </html>  
    13. 

  13. //將 Index.html 更改為 Index.jsp，這樣就可以利用 JSP 中 fmt 標簽  
    14. 

  14. <%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>  
    15. 

  15. <%@ taglib prefix="fmt" uri="https://java.sun.com/jsp/jstl/fmt" %>  
    16. 

  16. <html>  
    17. 

  17. <head>  
    18. 

  18. <script language="JavaScript">  
    19. 

  19. …  
    20. 

  20. </script>  
    21. 

  21. <title> <fmt:message key="common_welcome" /></ title>  
    22. 

  22. </head>  
    23. 

  23. <body>  
    24. 

  24. …  
    25. 

  25. </body>  
    26. 

  26. </html>  
    27. 

  27. //test.properties 
    28. 

  28.  Common_welcome=Welcome Page  
    29. 

  29. … 
    30. 



//將 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. 

  2. <div dojoAttachPoint="testNode" style="display:inline">  
    3. 

  3. <table style="position: relative; margin: 20px 0 0 120px; padding: 0;">  
    4. 

  4. <tr>  
    5. 

  5. <td style="text-align: right;">Username:</td> //原來的 hard code  
    6. 

  6. <td style="text-align: right;">${usernameLabel}</td> //Resource out 之後的變量引用  
    7. 

  7. ….  
    8. 

  8. </tr>  
    9. 

  9. </div>  
    10. 

  10. Test.js  
    11. 

  11. dojo.requireLocalization("js", "message");  
    12. 

  12. dojo.declare("Test") {  
    13. 

  13. templatePath: dojo.moduleUrl("common", " /html/Test.html"),  
    14. 

  14. usernameLabel: "",  
    15. 

  15. postMixInProperties: function(){  
    16. 

  16. this.inherited(arguments);  
    17. 

  17. var resources = dojo.i18n.getLocalization("js", "message");  
    18. 

  18. this.usernameLabel = resources.labels.username; //獲取資源文件  
    19. 

  19. }  
    20. 

  20. } 
    21. 



清單 11. HTML 中特殊硬編碼處理




    

  1. // Hard Code  
    2. 

  2. <html>  
    3. 

  3. <body>  
    4. 

  4. <select id="Product">  
    5. 

  5. <option>Is Not</option>  
    6. 

  6. <option>Is</option>  
    7. 

  7. </select>  
    8. 

  8. </body>  
    9. 

  9. </html>  
    10. 

  10. //處理後的 HTML  
    11. 

  11. <html>  
    12. 

  12. <body>  
    13. 

  13. <select id="Product">  
    14. 

  14. <option value="Is Not"> ${ Label.IS_NOT}</option> 
    15. 

  15. <option value="Is">${Label.IS}</option>  
    16. 

  16. </select>  
    17. 

  17. </body>  
    18. 

  18. </html> 
    19. 



總結


本文總結了如何存儲 web 應用程序中使用不同框架時的資源文件及其命名規則，如何取得資源文件中的鍵值。希望這篇文章能為正在開發國際化 Web 應用程序的讀者提供一定的參考價值。





本文作者：佚名


來源：51CTO


最後更新：2017-11-02 14:34:21
  上一篇：go  iPhone8手機開機密碼忘了怎麼解鎖 
  下一篇：go  深入理解Js的This綁定 ( 無需死記硬背，尾部有總結和麵試題解析 )