DIV CSS 佈局教程網

用命名空間避免 JavaScript 的全域污染與命名衝突
編輯:關於JavaScript     

頁面載入的第三方腳本一多,全域變數撞名就成了家常便飯。解法其實很古老也很有效:建立自己的程式碼庫,把所有東西收在同一個命名空間底下。

建立自己的命名空間

概念類似 Java 的 package,只是 JavaScript 靠物件一層層嵌套來模擬:

ziggy_js = function(){}
ziggy_js.ui = function(){}
ziggy_js.ui.alerts = function(){}
ziggy_js.ui.alerts.showErrorAlert = function(){
  alert("An error occurred");
}
ziggy_js.ui.alerts.showErrorAlert();

// 也可以在裡面定義「類別」
ziggy_js.ui.alerts.messageDisplayer = function(inMsg){
  this.msg = inMsg;
  this.toString = function(){
    return "msg=" + this.msg;
  }
}
var v = new ziggy_js.ui.alerts.messageDisplayer("hello");
alert(v);

動手前先檢查是否已被佔用

每個檔案都應該自帶守門邏輯,避免覆蓋掉別人的命名空間:

// 在 ziggy_js.string.js 中
if(typeof ziggy_js == 'undefined'){
  ziggy_js = function(){};
}
ziggy_js.string = function(){}
ziggy_js.string.test = function(inMsg){
  alert(inMsg);
}
// 頁面中引入
<script src="ziggy_js.string.js"></script>

依功能拆分模組

陣列處理模組:

ziggy_js.array = function(){}
// 複製陣列
ziggy_js.array.copyArray = function(inSrcArray, inDestArray){
  var i;
  for(i=0; i<inSrcArray.length; i++){
    inDestArray.push(inSrcArray[i]);
  }
  return inDestArray;
}
// 在陣列中尋找某個值
ziggy_js.array.findInArray = function(inArray, inValue){
  var i;
  for(i=0; i<inArray.length; i++){
    if(inArray[i] == inValue){
      return i;
    }
  }
  return -1;
}

瀏覽器資訊模組:

ziggy_js.browser = function(){}
ziggy_js.browser.getBrowserIdentity = function(){
  return navigator.appName + " " + navigator.appVersion;
}
var brow = ziggy_js.browser.getBrowserIdentity();
alert(brow);

日期處理模組:

ziggy_js.dateTime = function(){}
ziggy_js.dateTime.isLeapYear = function(inYear){
  if((inYear%4==0 && inYear%100!=0) || inYear%400==0){
    return true;
  }else{
    return false;
  }
}
ziggy_js.dateTime.getNumberDaysInMonth = function(inMonth, inYear){
  inMonth = inMonth - 1;
  var leap_year = this.isLeapYear(inYear) ? 1 : 0;
  if(inMonth==3 || inMonth==5 || inMonth==8 || inMonth==10){
    return 30;
  }else if(inMonth==1){
    return 28 + leap_year;
  }else{
    return 31;
  }
}
var days = ziggy_js.dateTime.getNumberDaysInMonth(2, 2007);
alert(days);

幾個實務上的補充

這個模式(又稱「命名空間物件」)在 jQuery 外掛盛行的年代非常普遍,jQuery 自己的 $.fn、YUI 的 YAHOO.util 都是同樣思路。但有兩點值得注意:

第一,用 ziggy_js = function(){} 這種寫法會建立全域變數,若要在嚴格模式下運作或避免污染,建議改用 var 宣告,並在檔案最外層包成 IIFE。

第二,現代的 ES 模組(import / export)已经从語言層面解決了這個問題:每個檔案天生擁有獨立作用域,只有在明確匯出與匯入時才產生關聯,不需要再靠命名前綴手動隔離。新專案請優先採用模組化方案,只有在維護舊程式碼時才需要沿用這套命名空間寫法。

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