DIV CSS 佈局教程網

jQuery 一段 function 的正確寫法:把邏輯組織成模組
編輯:JavaScript綜合知識     

jQuery 的 function 大家都寫過,但「寫得出來」和「寫得對」是兩件事。這個例子示範如何把一個功能組織成有 init、有內部方法、有事件掛載的模組,而不是把幾百行攤在 $(function(){}) 裡。

引入與 HTML

<script src="/libs/jquery/jquery.js" type="text/javascript"></script>

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<script src="modules-js/qiyi.js"></script>
<script>
$(function() {
  qiyiPlugin.init($("#zong_qiyi"));
});
</script>
</head>
<div id="zong_qiyi">
    // 內容由 JavaScript 填入
</div>

這裡有個值得學的分工:qiyi.js 定義模組、$(function(){}) 只負責在 DOM 就緒後呼叫 init 並傳入掛載點。頁面的 script 保持極薄,所有邏輯都在外部檔案裡——這樣才能被快取、被測試、被其他頁面重用。

模組本體

var qiyiPlugin = {
  init: function(parentNode) {
    var self = this;
    self.parentNode = parentNode;
    // 監聽自訂事件,收到 refresh 就重畫
    self.parentNode.on('refresh', function(event) {
      self.qiyiList();
    });
  },

  // 取得並顯示列表
  qiyiList: function() {
    var self = this;
    self.getQiyiList(function(result) {
      if (result.qiyiList) {
        self.qiyiHtml1();        // 先重建骨架
        self.displayQiyiList(result.qiyiList);  // 再填內容
      } else {
        alert("沒有獲得奇藝數據,請查看接口");
      }
    });
  },

  // 把資料渲染進頁面
  displayQiyiList: function(qiyiList) {
    var self = this;
    var top = "#zong_qiyi";
    // 清掉上一次的資料列,避免重複顯示
    $(top).find('#qiyi_control_panel').each(function(){
      if ($(this).data('data')) $(this).remove();
    });
    var line0 = $(top).find("#qiyi_control_panel");  // 這是模板列
    $.each(qiyiList, function(index, item2) {
      var line1 = $(line0).clone();
      $(line1).data('data', item2);     // 把整筆資料掛在元素上
      $(line1).attr('id', index + 1);
      $(line1).find("#name").html(item2.name);
      $(line1).find("#level").html(item2.level);
      $(line1).find("#maxLevel").html(item2.maxLevel);
      $(line1).find("#exp").html(item2.exp + "/" + item2.needExp);
      $(line1).find("#desc1").html(item2.desc1);
      $(line0).before(line1);
      $(line1).show();
      $(line1).find("#upgrade").on('click', function(event) {
        var table = $(this).parents('table:first');
        var info = $(table).data('data');  // 取回這一列對應的資料
        self.clickToUpgradeQiyi(info, function(result) {
          if (!result.success) {
            alert(result.fail.desc1);
          } else {
            growingPlugin.playerTopData();
            self.parentNode.trigger('refresh');  // 觸發自己定義的事件
          }
        });
      });
    });
  },

  // 產生一份隱藏的模板列
  qiyiHtml1: function() {
    var string = "<table id='qiyi_control_panel' class='table table-bordered table-hover' style='display:none; width:500;'>";
    string += "<tr><td>名稱:</td><td id=name>haoren_內功</td></tr>";
    string += "<tr><td>當前等級:</td><td id=level></td></tr>";
    string += "<tr><td>最大等級:</td><td id=maxLevel></td></tr>";
    string += "<tr><td>exp:</td><td id=exp></td></tr>";
    string += "<tr><td>描述:</td><td id=desc1></td></tr>";
    string += "<tr><td><button id='upgrade' class='btn btn-link'>升級</button></td></tr>";
    string += "</table>";
    $("#zong_qiyi").html(string);
  },

  // 呼叫後端升級
  clickToUpgradeQiyi: function(info, callback) {
    var query = "operation=upgradeQiyi";
    query += "&qiyiName=" + info.name;
    toolsPlugin.play(query, callback);
  },

  // 取得列表
  getQiyiList: function(callback) {
    var query = "operation=getQiyiList";
    toolsPlugin.play(query, callback);
  }
};

這個結構做對了什麼

var self = this。在每個方法開頭把 this 存成 self,是因為稍後的 callback 函式裡 this 會變成別的東西(通常是觸發事件的 DOM 元素)。少了這行,this.getQiyiList 就會找不到方法。用箭頭函式(ES6 之後)可以從根本上解決這個問題,因為它不綁定自己的 this。

用 data() 掛關聯資料。每一列 clone 之後,把整筆 item2 用 .data('data', item2) 掛在元素上。點擊「升級」按鈕時,沿著 DOM 往上找到所屬的 table,再把資料取回來。這比用 data-id 屬性傳 id、然後再查表優雅,也不必為每個欄位開一個全域陣列。

自訂事件做模組解耦。self.parentNode.trigger('refresh') 觸發的是自己定義的事件名稱,而不是直接呼叫某個具體函式。升級成功後需要更新多個區域時,各區域只要監聽這個事件就好,彼此不必知道對方的存在。這是 jQuery 時代很常見的鬆耦合手法。

先重建骨架再填內容。qiyiList 裡先呼叫 qiyiHtml1() 重畫模板、再 displayQiyiList() 填資料,順序刻意安排,避免重複呼叫時內容層層疊加。

三個該改的地方

模板裡的 id 必須唯一。範例用 id="name"、id="level" 當模板的標記,但 clone 之後頁面上就會出現多個同 id 元素——這違反 HTML 規範,$("#name") 也只會選到第一個。正確做法是把 id 改成 class:class="js-name"、class="js-level",用 class 選取。

用事件委派取代逐列綁定。目前每 clone 一列就 .on('click', ...) 綁一次,列數多時會產生大量事件處理器。改成在容器上委派一次即可:
  $('#zong_qiyi').on('click', '.js-upgrade', function(){ ... });

innerHTML 拼接有 XSS 風險。item2.name 若來自使用者輸入且含有 <script>,直接塞進 .html() 就會被執行。用 .text() 而非 .html() 可以自動跳脫;若必須插入 HTML,事前消毒。

用 $(function(){}) 只是起點。當模組數量變多,這種「全域 plugin 物件互相呼叫」的寫法會愈來愈難追。ES Module 的 import/export 才是現代的正解——每個模組明確宣告依賴,誰用了誰一目了然。

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