國際化UI字串

Java和Javascript API可讓您將下列資源類型中的字串國際化:

  • Java源檔案。
  • JSP指令碼。
  • 用戶端程式庫或頁面來源中的Javascript。
  • 對話框和元件配置屬性中使用的JCR節點屬性值。

有關國際化和本地化流程的概述,請參閱國際化元件

以Java和JSP代碼將字串國際化

com.day.cq.i18n Java套件可讓您在UI中顯示本地化字串。 I18n類別提供從AEM字典擷取本地化字串的get方法。 get方法唯一需要的參數是英語中的字串常值。 英文是UI的預設語言。 以下示例將單詞Search本地化:

i18n.get("Search");

以英文識別字串,與ID識別字串並用於在執行階段參考字串的一般國際化架構不同。 使用英文字串常值可提供下列優點:

  • 程式碼容易理解。
  • 預設語言的字串一律可用。

確定用戶語言

有兩種方式可判斷使用者偏好的語言:

  • 對於已驗證的使用者,請從使用者帳戶的偏好設定中決定語言。
  • 請求的頁的地區。

使用者帳戶的語言屬性是偏好的方法,因為它更可靠。 不過,使用者必須登入才能使用此方法。

建立I18n Java對象

I18n類提供兩個建構子。 您如何確定用戶的首選語言決定了要使用的建構子。

若要以使用者帳戶中指定的語言呈現字串,請使用下列建構函式(匯入com.day.cq.i18n.I18n)後):

I18n i18n = new I18n(slingRequest);

建構函式使用SlingHTTPRequest來檢索用戶的語言設定。

要使用頁面區域設定來確定語言,首先需要獲取所請求頁面語言的ResourceBundle :

Locale pageLang = currentPage.getLanguage(false);
ResourceBundle resourceBundle = slingRequest.getResourceBundle(pageLang);
I18n i18n = new I18n(resourceBundle); 

將字串國際化

使用I18n對象的get方法來國際化字串。 get方法唯一需要的參數是要國際化的字串。 該字串與Translator字典中的字串對應。 get方法會在字典中查找字串,並傳回目前語言的翻譯。

get方法的第一個引數必須符合下列規則:

  • 值必須是字串常值。 類型String的變數不可接受。
  • 字串常值必須在一行上表示。
  • 字串區分大小寫。
i18n.get("Enter a search keyword");

使用翻譯提示

指定國際化字串的轉換提示以區分字典中的重複字串。 使用get方法的第二個可選參數來提供翻譯提示。 翻譯提示必須與字典中項目的Comment屬性完全相符。

例如,字典包含字串Request兩次:一次是動詞,一次是名詞。 下列程式碼包含翻譯提示,作為get方法中的引數:

i18n.get("Request","A noun, as in a request for a web page");

在本地化句子中包含變數

在本地化字串中加入變數,將內容含義建置至句子中。 例如,登入Web應用程式後,首頁會顯示訊息「歡迎返回管理員」。 收件箱中有2條郵件。」 頁面內容會決定使用者名稱和訊息數量。

在字典中,變數在字串中以括弧內的索引表示。將變數的值指定為get方法的引數。 引數會放置在轉換提示之後,而索引會與引數的順序對應:

i18n.get("Welcome back {0}. You have {1} messages.", "user name, number of messages", user.getDisplayName(), numItems); 

國際化字串和翻譯提示必須與字典中的字串和注釋完全匹配。 您可以提供null值作為第二個引數,以省略本地化提示。

使用靜態Get方法

I18N類定義了靜態get方法,當您需要本地化少量字串時,該方法非常有用。 除了對象的get方法的參數外,靜態方法還需要您使用的SlingHttpRequest對象或ResourceBundle,具體取決於您如何確定用戶的首選語言:

  • 使用用戶的語言首選項:提供SlingHttpRequest作為第一個參數。

    I18n.get(slingHttpRequest, "Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);

  • 使用頁面語言:提供ResourceBundle作為第一個參數。

    I18n.get(resourceBundle,"Welcome back {}. You have {} messages.", "user name, number of messages", user.getDisplayName(), numItems);

在Javascript程式碼中將字串國際化

Javascript API可讓您將用戶端上的字串當地化。 與Java和JSP程式碼一樣,Javascript API可讓您識別要本地化的字串、提供本地化提示,以及在本地化的字串中包含變數。

granite.utils 用戶端程式庫資料夾提供Javascript API。 若要使用API,請在頁面上包含此用戶端程式庫資料夾。 本地化函式使用Granite.I18n命名空間。

在顯示本地化字串之前,需要使用Granite.I18n.setLocale函式設定區域設定。 此函式需要區域設定的語言代碼作為參數:

Granite.I18n.setLocale("fr");

若要呈現本地化字串,請使用Granite.I18n.get函式:

Granite.I18n.get("string to localize");

下列範例會國際化字串"Welcome back":

Granite.I18n.setLocale("fr");
Granite.I18n.get("string to localize", [variables], "localization hint");

函式參數與Java I18n.get方法不同:

  • 第一個參數是要本地化的字串常值。
  • 第二個參數是要插入至字串常值的陣列。
  • 第三個參數是本地化提示。

以下範例使用Javascript將「歡迎返回管理員」當地化。 收件箱中有2條郵件。」 句子:

Granite.I18n.setLocale("fr");
Granite.I18n.get("Welcome back {0}. You have {1} new messages in your inbox.", [username, numMsg], "user name, number of messages");

從JCR節點國際化字串

UI字串通常以JCR節點屬性為基礎。 例如,頁面的jcr:title屬性通常用作頁面程式碼中h1元素的內容。 I18n類提供用於定位這些字串的getVar方法。

以下示例JSP指令碼從儲存庫中檢索jcr:title屬性,並在頁上顯示本地化字串:

<% title = properties.get("jcr:title", String.class);%>
<h1><%=i18n.getVar(title) %></h1>

指定JCR節點的轉換提示

與Java API🔗中的翻譯提示類似,您可以提供翻譯提示來區分字典中的重複字串。 提供翻譯提示作為包含國際化屬性的節點的屬性。 提示屬性的名稱由具有_commentI18n尾碼的國際化屬性名稱組成:

${prop}_commentI18n

例如,cq:page節點包含正在本地化的jcr:title屬性。 提供提示作為名為jcr:title_commentI18n的屬性的值。

測試國際化覆蓋範圍

測試您是否已將UI中的所有字串國際化。 若要查看涵蓋哪些字串,請將使用者語言設為zz_ZZ,然後在網頁瀏覽器中開啟UI。 國際化字串將以以下格式顯示存根轉換:

USR_*Default-String*_尠

下圖顯示了AEM首頁的存根翻譯:

chlimage_1

要設定用戶的語言,請為用戶帳戶配置首選項節點的語言屬性。

用戶的首選項節點的路徑如下:

/home/users/<letter>/<hash>/preferences

chlimage_1-1

本頁內容