HTML5树组件延迟加载技术实现

时间 2019-12-07

标签 html5 html 组件延迟加载技术实现栏目 HTML5 繁體版

原文原文链接

HT for Web的HTML5树组件有延迟加载的功能，这个功能对于那些须要从服务器读取具备层级依赖关系数据时很是有用，须要获取数据的时候再向服务器发起请求，这样可减轻服务器压力，同时也减小了浏览器的等待时间，让页面的加载更加流畅，加强用户体验。css

http://www.hightopo.com/guide/readme.htmlhtml

进入正题，今天用来作演示的Demo是，客户端请求服务器读取系统文件目录结构，经过HT for Web的HTML5树组件显示系统文件目录结构。java

首先，咱们先来设计下服务器，此次Demo的服务器采用Node.js，用到了Node.js的express、socket.io、fs和http这四个模块，Node.js的相关知识，我在这里就不阐述了，网上的教材一堆，这里推荐下socket.io的相关入门http://socket.io/get-started/chat/。node

服务端代码代码：web

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端口。express

到此，一个简单的服务器就搭建好了，如今能够经过http://localhost:5000来访问服务器了。等等，好像缺了点什么。对了，获取系统文件目录结构的方法忘记给了，OK，那么咱们就先来看看获取整站文件的代码是怎么写的：浏览器

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;
}

如你们所见，采用递归的方式，逐层遍历子目录，代码也没什么高深的地方，相信你们都看得懂。那咱们来看看运行效果吧：服务器

duang～文件目录结构出来了，是否是感受酷酷的，这代码量不小吧。其实，代码并很少，贴出来你们瞅瞅：app

<!DOCTYPE html>
<html>
<head>
    <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>

这就是所有的HTML代码，加上空行总共也就50几行，怎么样，有没有感受HT for Web很强大。废话很少说，来看看这些代码都干了些什么：socket

要用到socket.io就须要在页面引入<script src=“/socket.io/socket.io.js”></script>，其实在个人项目中并不存在/socket.io/socket.io.js文件，可是却能正常使用，具体什么缘由，我就很少说，你们本身研究去吧；
最重要的是要引入HT for Web的核心包<script src=“/lib/core/ht.js”></script>，这个包不引入的话，下面的HT for Web组件就没法使用；
接下来就是代码了，首先建立一个数据容器DataModel，用来存放文件目录的节点数据，再建立一个TreeView对象并引用刚建立到数据容器，接下来经过socket监听file事件，获取服务器返回的数据，在回调函数中经过调用createChildren和createFiles函数，建立文件目录节点对象，并添加到数据容器中，最后是向服务器发起数据请求，即经过socket派发explore事件。

总体的思路是这样子的，固然这离咱们要实现的树组件的延迟加载技术还有些差距，那么，HT for Web的HTML5树组件的延迟加载技术是怎么实现的呢？不要着急，立刻开始探讨。

首先咱们须要改造下获取文件目录的方法walk，由于前面介绍的方法中，使用的是加载整站文件目录，因此咱们要将walk方法改形成只获取一级目录结构，改造起来很简单，就是将递归部分改形成获取当前节点就能够了，具体代码以下：

obj.children.push(walk(pa + '/' + item));
// 将上面对代码改为下面的代码
obj.children.push({name: item, path: pa + '/' + item});

这样子服务器就只请求当前请求路径下的第一级文件目录结构。接下来就是要调整下客户端代码了，首先须要给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方法中，对socket派发explore事件，当前节点的path为参数，向服务器请求数据，以后将当前节点的loaded属性设置为true；在isLoaded方法中，返回当前节点的loaded属性，若是返回为true，那么tree将不会在执行load方法向服务器请求数据。

接下来须要移除createChildren的两个回调方法，而且在createFiles方法中为建立出来的节点的loaded属性设置成true，这样在不是目录的节点前就不会有展开的图标。createChildren和createFiles两个方法修改后的代码以下：

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);
    });
}

如此，HT for Web的HTML5树组件延迟加载技术就设计完成了，我在服务器的控制台打印出请求路径，看看这个延迟加载是否是真的，以下图：

看吧，控制台打印的是4条记录，第一条是请求跟目录时打印的，我在浏览器中展开里三个目录，在控制台打印了其对应的目录路径。

等等，如今这个目录看起来好烦，只有文字，除了位子前的展开图标能够用来区别文件和目录外，没有其余什么区别，因此我决定对其进行一番改造，让每一级目录都有图标，并且不一样文件对应不一样的图标，来看看效果吧：

怎么样，是否是一眼就能看出是什么文件，这个都是样式上面的问题，我就再也不一一阐述了，直接上代码：

<!DOCTYPE html>
<html>
<head>
    <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>

在最后，附上完整的服务器代码：

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;
}

http://www.hightopo.com/guide/readme.html