DIV CSS 佈局教程網

jQuery EasyUI 格式化列的注意事項:函數必須放在主頁面
編輯:JQuery入門技巧     

EasyUI datagrid 的列格式化(formatter)寫好了卻不生效,控制台報「找不到 formatIsvalid 這個函數」——這個問題困住了我一段時間,記錄一下原因和解法。

主框架頁面

項目採用經典的 EasyUI layout 佈局:西側菜單點擊後,把對應 URL 的內容加載到中間區域。

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8"/>
  <title>主界面</title>

  <div th:include="/public/util::public"/>
  <div th:include="/public/util::jquery-easyui"/>

  <script type="text/javascript"
    th:src="${@configApp.getStaticWeb()} + '/cms/script/main/index.js'"></script>
  <script type="text/javascript"
    th:src="${@configApp.getStaticWeb()} + '/cms/script/site/site-index.js'"></script>
</head>

<body class="easyui-layout">
  <div data-options="region:'north',title:''" style="height:80px;" id="north"></div>

  <div data-options="region:'west',title:'系統功能區',split:true" style="width:200px;">
    <ul class="easyui-tree" id="menu"></ul>
  </div>

  <div data-options="region:'center',title:'主界面區'" style="padding:5px;" id="center"></div>
</body>
</html>

此時主頁面已經加載了 EasyUI 的腳本和 CSS,各子頁面不必重複引入——即使引入了也會被去掉。

問題現場

我一開始把格式化函數寫在 datagrid 所在的子頁面裡,結果始終不生效:

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8"/>
  <title>站點列表頁面</title>

  <script type="text/javascript">
    function formatIsvalid(val, row) {
      return val == '1' ? '是' : '否';
    }
  </script>
</head>

<body>
  <table id="site" title="站點列表" class="easyui-datagrid"
    data-options="url:'/site/list', toolbar:'#siteToolbar',
      rownumbers:true, fitColumns:true, singleSelect:true">
    <thead>
      <tr>
        <th data-options="field:'siteid',width:50">ID</th>
        <th data-options="field:'sitename',width:50">名稱</th>
        <th data-options="field:'siteurl',width:50">網址</th>
        <th data-options="field:'isvalid',width:50,formatter:formatIsvalid">是否有效</th>
        <th data-options="field:'isdelete',width:50">是否可以刪除</th>
        <th data-options="field:'remark',width:50">備注</th>
        <th data-options="field:'createtime',width:50">創建時間</th>
      </tr>
    </thead>
  </table>

  <div id="siteToolbar">
    <a href="#" class="easyui-linkbutton" data-options="iconCls:'icon-add',plain:true"
      onclick="newSite()">新增</a>
    <a href="#" class="easyui-linkbutton" data-options="iconCls:'icon-edit',plain:true"
      onclick="editSite()">編輯</a>
    <a href="#" class="easyui-linkbutton" data-options="iconCls:'icon-remove',plain:true"
      onclick="removeSite()">刪除</a>
  </div>
</body>
</html>

原因

EasyUI 解析 columns 時,formatter: formatIsvalid 這種寫法傳的是函數引用,而不是函數名字符串。它在解析的那一刻就要在當前作用域裡找到這個函數。

而在 layout 框架異步加載子頁面的場景下,datagrid 的初始化時機、作用域歸屬變得複雜:子頁面裡用 <script> 聲明的函數,在 EasyUI 實際解析 columns 的時刻可能還不在可訪問的作用域鏈上,於是拿到 undefined,後續調用時就報「找不到 formatIsvalid」。

解法:把格式化函數放到主頁面

把這個函數移到主界面的 script 裡,問題就消失了。

// 放在主頁面的 js 文件中
function formatIsvalid(val, row) {
  return val == '1' ? '是' : '否';
}

// 也可以掛成全局對象的方法,便於管理
window.Formatters = {
  isvalid: function (val, row) {
    return val == '1' ? '是' : '否';
  },
  date: function (val) {
    return val ? val.substring(0, 10) : '';
  }
};

在主頁面預先定義好所有公共格式化函數,子頁面直接引用即可。這樣做的好處是:公共函數集中管理,多個子頁面共享同一套格式化規則,避免每個頁面各寫一份、行為不一致。

幾種替代方案對比

方案一:函數放主頁面(推薦)

適合多頁面共用的通用格式化,如狀態值轉文本、日期截取、金額千分位。缺點是需要維護一個全局命名空間。

方案二:用字符串指定全局函數名

EasyUI 支持 formatter: 'formatIsvalid' 這種字符串形式,此時它會去全局作用域查找。這種寫法延遲了查找時機,靈活度更高,但函數依然必須掛在全局上,本質要求沒變。

方案三:改為 JS 初始化 datagrid

不用 class="easyui-datagrid" 加 data-options 的聲明式寫法,改成在子頁面的 script 裡調用 $('#site').datagrid({ columns: [[ ... ]] })。這樣 columns 對象是在函數執行時才被構造的,當前作用域裡的函數一定找得到,作用域問題自然消解。

$('#site').datagrid({
  url: '/site/list',
  toolbar: '#siteToolbar',
  rownumbers: true,
  fitColumns: true,
  singleSelect: true,
  columns: [[
    { field: 'siteid', title: 'ID', width: 50 },
    { field: 'sitename', title: '名稱', width: 80 },
    { field: 'isvalid', title: '是否有效', width: 80,
      formatter: function (val, row) {
        return val == '1' ? '是' : '否';
      }
    }
  ]]
});

這三種方案裡,方案三對作用域的要求最低——把 formatter 寫成匿名函數內聯在 columns 裡,連查找都省了。代價是失去了聲明式 HTML 的可讀性。

排查這類問題的思路

遇到「EasyUI 說找不到某個函數」時,可以按這個順序檢查:

  • 函數名是否拼寫一致(大小寫敏感);
  • 函數是否掛在全局對象上,還是被包在某個閉包或 jQuery ready 裡;
  • datagrid 初始化的時機是否早於函數定義的時機;
  • 是否處於 iframe 或異步加載的場景,導致作用域被隔離。

本質上這不是 EasyUI 的 bug,而是聲明式配置對作用域的隱含要求:凡是通過 data-options 傳遞的函數引用,都必須在解析時刻可從全局訪問到。理解這一點,同類問題(比如 toolbar 裡 handler 找不到、combobox 的 onSelect 不生效)都能用同一套思路排查。

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