DIV CSS 佈局教程網

JavaScript 統一管理提示語(message)的方案與封裝
編輯:關於JavaScript     

項目開發中,各個頁面、各個業務操作都會用到提示語。當 message 數量堆積起來,散落在各處寫死顯然難以維護。更好的方式是統一管理,這樣做國際化時也能集中處理。

整體思路

推薦的方案是用數據庫統一存儲所有提示語,並在項目啟動時把全部提示語加載到內存或緩存中。後端(Java 等)的實現很直接,問題是前端 JS 怎麼用?下面做一個簡單封裝,思路清晰、調用方便。

一、創建 message.jsp

<%-- <%@ page import="com.xxx.xxx.xxx.xxx.I18nManager" %> --%>
<%@ page language="java" pageEncoding="UTF-8"%>
<script type="text/javascript">
function I18nManager() {
  this.init;
  this.messages;
}

I18nManager.prototype = {
  get: function (id, args) {
    if (!this.init) {
      this.messages = new Array();

      // 這裡用 Java 代碼讀取服務端已緩存好的消息提示語
      <%-- this.messages['charset'] = "<%= I18nManager.get(user, "charset") %>"; --%>
      <%-- this.messages['M0001'] = "<%= I18nManager.get(user, "M0001") %>"; --%>
      <%-- this.messages['M0002'] = "<%= I18nManager.get(user, "M0002") %>"; --%>
      <%-- this.messages['ui.title.user'] = "<%= I18nManager.get(user, "ui.title.user") %>"; --%>

      // 也可以靜態設置一些提示語
      this.messages['M0001'] = "操作成功!";
      this.messages['M0002'] = "操作失敗!";

      this.init = true;
    }

    var message = this.messages[id];
    if (!message && message !== "") {
      return id;   // 找不到時返回 id 本身,便於排查
    }

    // 支持占位符替換
    if (args) {
      if (typeof args == "object" && args.length) {
        for (var i = 0; i < args.length; i++) {
          var pattern = new RegExp("\\{" + i + "\\}", "g");
          message = message.replace(pattern, args[i]);
        }
      } else {
        message = message.replace(/\{0\}/g, args);
      }
    }

    return message;
  },

  alert: function (id, args) {
    alert(this.get(id, args));
  }
};

var i18n = new I18nManager();
</script>

代碼中的「操作成功」「操作失敗」是靜態寫死的值,僅作演示。實際項目中,我們在 JSP 裡用 Java 代碼讀取服務端啟動時已緩存的全部提示語,動態輸出到 this.messages['xxxx'] 中,替換掉注釋掉的那幾行即可。

二、頁面中如何使用

window.onload = function () {
  i18n.alert('M0001');
  // 或者只取文本
  // alert(i18n.get('M0001'));
};

直接用封裝好的 get 和 alert 方法即可,也可以按實際需要擴展自己的方法,比如 confirm、setHtml 等。

三、幾點設計上的改進建議

第一,懶加載時機。把初始化放在第一次 get 調用上,避免頁面加載時就同步遍歷全部消息;若消息量很大,更合適的做法是通過一次 Ajax 請求異步拉取 JSON。

第二,用對象代替數組。[] 創建的數組被當成字典用,length 和 for...in 行為都容易誤導,改成 {} 更貼合語義。

第三,佔位符與 HTML 轉義。若提示語要寫進頁面(innerHTML),而參數可能包含用戶輸入,務必先做轉義,避免 XSS。

第四,與後端國際化資源打通。與其由 JSP 逐條輸出,不如讓後端提供一個 /i18n/messages?lang=zh-CN 接口,前端啟動時拉取一次並緩存,這樣多語言切換、版本更新都更靈活。

第五,開發環境降級。找不到 key 時返回 key 本身(如上面的寫法)是個不錯的習慣,能讓缺失的翻譯在頁面上直接暴露,而不是靜默顯示空白。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved