DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> HTML基礎知識 >> HTML5詳解
HTML5 樹元件延遲加載實作:以 HT for Web 讀取系統目錄為例
編輯:HTML5詳解     

HT for Web 的 HTML5 樹元件(TreeView)本身支援延遲加載,這個能力在處理「具備層級依賴關係」的資料時特別有用——節點展開了才去伺服器要資料,而不是一次把整棵樹拉回來。好處很直接:伺服器壓力小、瀏覽器等待時間短、頁面加載更順,使用者體驗自然更好。

本文的示範目標是:用 HT for Web 的樹元件,把伺服器上的系統檔案目錄結構一層層展示出來。

一、打造 Node.js 服務端

示範用的服務端採用 Node.js,共用到 express、socket.io、fs 與 http 四個模組。Node.js 的基礎知識這裡不展開,網上教材很多;socket.io 的話推薦先看官方入門教學 https://socket.io/get-started/chat/。

var fs = require("fs"),
    express = require("express"),
    app = express(),
    server = require("http").createServer(app),
    io = require("socket.io")(server),
    root = '/Users/admin/Projects/ht-for-web/guide';

io.on("connection", function(socket){
    socket.on("explore", function(url){
        socket.emit("file", walk(url || root));
    });
});

app.use(express.static("/Users/admin/Projects/ht-for-web"));

server.listen(5000, function(){
    console.log("server is listening at port 5000");
});

這段的運作流程是:io 監聽 connection 事件並取得一個 socket;接著 socket 監聽名為 explore 的自訂事件,收到 url 參數後去讀取資料,再派發名為 file 的自訂事件給前端處理;app.use 搭配 express.static 設定靜態檔案根目錄;最後讓 server 監聽 5000 埠。

至此服務端雛形完成,可以透過 https://localhost:5000 訪問。不過還缺一塊——讀取目錄結構的方法。

二、遞迴讀取整站檔案

function walk(pa) {
    var dirList = fs.readdirSync(pa),
        key = pa.substring(pa.lastIndexOf("/") + 1),
        obj = {
            name: key,
            path: pa,
            children: [],
            files: []
        };
    dirList.forEach(function(item) {
        var stats = fs.statSync(pa + "/" + item);
        if (stats.isDirectory()) {
            obj.children.push(walk(pa + "/" + item));
        }
        else {
            obj.files.push({name: item, dir: pa + "/" + item});
        }
    });

    return obj;
}

這裡用的是經典的遞迴遍歷:判斷每一項是目錄還是檔案,是目錄就遞迴深入,是檔案就放進 files 陣列。邏輯不複雜,跑起來的效果卻頗有架勢:

三、用 HT for Web 把資料畫出來

看似程式碼量很大,實際上 HTML 部分連空行加起來也不過五十幾行:

<!DOCTYPE Html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title>tree-loader</title>
    <script src="/socket.io/socket.io.js"></script>
    <script src="/lib/core/ht.js"></script>
    <script>
        var socket = io(), idMap = {};
        function init() {
            var dm = window.dm = new ht.DataModel(),
                tree = new ht.widget.TreeView(dm);

            tree.addToDOM();

            socket.on("file", function(data) {
                var root = dm.getDataById(idMap[data.path]);
                createChildren(data.children, root, dm);
                createFiles(data.files, root, dm);
            });
            socket.emit("explore");
        }

        function createChildren(children, parent, dm) {
            children.forEach(function(child) {
                var n = createData(child, parent);
                dm.add(n);
                createChildren(child.children, n, dm);
                createFiles(child.files, n, dm);
            });
        }

        function createFiles(files, parent, dm){
            files.forEach(function(file){
                var n = createData(file, parent);
                dm.add(n);
            });
        }

        function createData(data, parent){
            var n = new ht.Data();
            n.setName(data.name);
            n.setParent(parent);
            n.a("path", data.path);
            idMap[data.path] = n.getId();
            return n;
        }
    </script>
</head>
<body onload="init();">
</body>
</html>

幾個需要留意的細節:

  • 要用 socket.io 就必須引入 <script src="/socket.io/socket.io.js"></script>。有趣的是專案裡並不存在這個實體檔案,卻能正常運作——這是 socket.io 服務端中介軟體動態提供的,有興趣可以自己去翻原始碼。
  • HT for Web 的核心包 <script src="/lib/core/ht.js"></script> 一定要引入,否則後面的元件全都無法使用。
  • 整體流程是:建立 DataModel 作為資料容器,建立 TreeView 並綁定該容器,透過 socket 監聽 file 事件取得伺服器回傳的資料,在回呼函式中呼叫 createChildren 與 createFiles 建立節點,最後派發 explore 事件發出請求。
  • createData 中刻意維護了一份 idMap,用 path 對映到節點 id。這是後續「伺服器回傳某層資料、前端要找到對應父節點掛上去」的關鍵。

四、改造為真正的延遲加載

上面的版本一次就把整棵樹塞進去了,離我們要的延遲加載還有一段距離。改造分兩邊進行。

4.1 服務端:只回傳一層

把 walk 方法中的遞迴改成不回溯,只描述當前節點即可:

obj.children.push(walk(pa + "/" + item));
// 將上面這行程式碼改成下面的寫法
obj.children.push({name: item, path: pa + "/" + item});

這樣伺服器每次只回傳請求路徑下的第一級目錄結構。

4.2 前端:掛上 loader

接著幫 tree 設定 loader:

tree.setLoader({
    load: function(data) {
        socket.emit("explore", data.a("path"));
        data.a("loaded", true);
    },
    isLoaded: function(data) {
        return data.a("loaded");
    }
});

loader 包含兩個方法,職責很清楚:load 負責「何時去抓資料」,isLoaded 負責「資料是否已經抓過」。在 load 中派發 explore 事件並帶上當前節點的 path,接著把 loaded 標記為 true;isLoaded 則回傳該標記,一旦為 true,tree 就不會再次觸發 load,避免重複請求。

另外還要調整兩個建立節點的方法:移除 createChildren 中的遞迴呼叫,並在 createFiles 中把節點的 loaded 設為 true——這樣非目錄節點前面就不會出現展開圖示。

function createChildren(children, parent, dm) {
    children.forEach(function(child) {
        var n = createData(child, parent);
        dm.add(n);
    });
}

function createFiles(files, parent, dm){
    files.forEach(function(file){
        var n = createData(file, parent);
        n.a("loaded", true);
        dm.add(n);
    });
}

改到這裡,延遲加載機制就完成了。我在伺服器控制台把每次收到的請求路徑印出來驗證:

控制台共四筆紀錄:第一筆是請求根目錄時印的,其餘三筆對應我在瀏覽器中展開的三個目錄。也就是說,沒有被展開的節點確實沒有送出任何請求,延遲加載生效。

五、加上檔案類型圖示

目前的樹看起來有點單調,除了展開圖示之外,目錄和檔案在視覺上幾乎無法區分。於是又做了一輪美化:每個節點都配圖示,且依副檔名顯示不同樣式。

這樣一眼就能分辨出什麼是目錄、什麼是 jar、什麼是腳本檔。這部分純屬樣式問題,直接看程式碼:

<!DOCTYPE Html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
    <script src="/socket.io/socket.io.js"></script>
    <script src="/build/ht-debug.js"></script>
    <script>
        var socket = io(), idMap = {};
        function init() {
            var icons = ["CSS", "dir-open", "dir", "file", "Flash", "gif", "Html", "jar",
                "Java", "mp3", "pdf", "png", "script", "txt", "video", "XML", "zip"];
            icons.forEach(function(c){
                ht.Default.setImage(c, 16, 16, "/test/wyl/images/" + c + ".png");
            });

            var dm = window.dm = new ht.DataModel(),
                tree = new ht.widget.TreeView(dm);
            tree.setLoader({
                load: function(data) {
                    socket.emit("explore", data.a("path"));
                    data.a("loaded", true);
                },
                isLoaded: function(data) {
                    return data.a("loaded");
                }
            });
            tree.getLabelFont = function(data){
                return "13px Helvetica, Arial, sans-serif";
            };
            tree.getLabelColor = function (data) {
                return this.isSelected(data) ? "white" : "black";
            };
            tree.getSelectBackground = function (data) {
                return "#408EDB";
            };
            tree.getIcon = function (data) {
                var icon = data.getIcon() || "file";
                if (data.a("isdir")) {
                    if (this.isExpanded(data)) {
                        icon = "dir-open";
                    } else {
                        icon = "dir";
                    }
                }
                return icon;
            };
            tree.addToDOM();

            socket.on("file", function(data) {
                var root = dm.getDataById(idMap[data.path]);
                createChildren(data.children, root, dm);
                createFiles(data.files, root, dm);
            });
            socket.emit("explore");
        }

        function createChildren(children, parent, dm) {
            children.forEach(function(child) {
                var n = createData(child, parent);
                n.a("isdir", true);
                dm.add(n);
            });
        }

        function createFiles(files, parent, dm){
            files.forEach(function(file){
                var n = createData(file, parent);
                n.a("loaded", true);
                dm.add(n);
            });
        }

        function createData(data, parent){
            var name = data.name,
                icon = "file";
            if (/.jar$/.test(name)) icon = "jar";
            else if (/.css$/.test(name)) icon = "CSS";
            else if (/.gif$/.test(name)) icon = "gif";
            else if (/.png$/.test(name)) icon = "png";
            else if (/.js$/.test(name)) icon = "script";
            else if (/.html$/.test(name)) icon = "Html";
            else if (/.zip$/.test(name)) icon = "zip";
            var n = new ht.Data();
            n.setName(data.name);
            n.setParent(parent);
            n.setIcon(icon);
            n.a("path", data.path);
            idMap[data.path] = n.getId();
            return n;
        }
    </script>
</head>
<body onload="init();">
</body>
</html>

這裡有兩個值得借鏡的設計:一是透過 ht.Default.setImage 預先註冊圖示資源,之後只要給名稱就能取用;二是把「節點是不是目錄」記在自訂屬性 isdir 上,getIcon 再據此在 dir 與 dir-open 之間切換,讓展開狀態也有視覺回饋。

六、最後附上完整服務端程式碼

var fs = require("fs"),
    express = require("express"),
    app = express(),
    server = require("http").createServer(app),
    io = require("socket.io")(server),
    root = "/Users/admin/Projects/ht-for-web/guide";

io.on("connection", function(socket){
    socket.on("explore", function(url){
        socket.emit("file", walk(url || root));
    });
});

app.use(express.static("/Users/admin/Projects/ht-for-web"));

server.listen(5000, function(){
    console.log("server is listening at port 5000");
});

function walk(pa) {
    var dirList = fs.readdirSync(pa),
        key = pa.substring(pa.lastIndexOf("/") + 1),
        obj = {
            name: key,
            path: pa,
            children: [],
            files: []
        };
    dirList.forEach(function(item) {
        var stats = fs.statSync(pa + "/" + item);
        if (stats.isDirectory()) {
            obj.children.push({name: item, path: pa + "/" + item});
        }
        else {
            obj.files.push({name: item, dir: pa + "/" + item});
        }
    });

    return obj;
}

回頭看整個實作,延遲加載的關鍵其實只有三件事:服務端有能力只回傳局部資料、前端有明確的「是否已載入」標記、以及一個在展開時被觸發的載入回呼。剩下的程式碼,大多是在處理節點身分對映與視覺呈現這類工程細節。

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