H5单页面架构:自定义路由 + requirejs + zepto + underscore

angular优点:

  • 强大的数据双向绑定
  • View界面层组件化
  • 内置的强大服务(例如表单校验)
  • 路由简单

angular缺点:

  • 引入的js较大,对移动端来说有点吃不消
  • 语法复杂,学习成本高

backbone优点:

  • 引入的js较小
  • 清晰MVC分层
  • Model层事件机制
  • 路由简单而且便于扩展

backbone缺点:

  • MVC有点死板,有时候觉得累赘
  • 没有双向绑定,界面修改只能靠自己
  • view切换时,没有足够便捷的事件通知(要自己监听route)

其实,这两个框架都非常优秀,但是,在实际业务中,不一定百试百灵,因为有一些移动端的单页面web,业务就很简单,只是路由分别切换到几个子模块,每个子模块基本都是拉一次数据,展示给用户,很少用户交互从而修改数据,改变视图的功能。

对于这种情况,使用angular未免有点杀鸡用牛刀的感觉,而backbone虽然小巧了不少,但是模型的功能也是浪费的。

所以,在这里,我想探讨一下,能否抛开这两个框架,只索取我们基本所需,建立一个更简单的架构呢?

经验看来,一些类库是必不可少的:

  • requirejs:模块划分
  • zepto:移动端的jquery
  • underscore:便捷的基础方法,包括模版template、each、map等等
  • 路由库:这里先使用director.js,然而这玩意并没有backbone和angular的路由好用,文章最后再来探讨这个问题

 

自己做一套最简单的架构,思想非常简单:

  1. 启动程序
  2. 监听路由
  3. 路由变化,映射到对应的处理逻辑,加载对应的模块
  4. 模块加载完成,修改dom,也就是视图
  5. 页面跳转时,移除上一个模块,加载下一个模块,也就是回到第3点

 

简单的思路,让架构非常简洁明了,新团队成员来到能够轻松上手,而angular和backbone的架构,少说得2、3天才能融入一个已有项目中去。

接下来,我们具体看看怎么做。

 

第一步,还是index.html

复制代码
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Underscore & Director & Requirejs</title>
</head>

<body>
<div id="container"></div>
<script data-baseurl="./" data-main="main.js" src="libs/require.js" id="main"></script>
</body>
</html>
复制代码

这个跟前两篇没什么差别。requirejs引入main.js作为程序入口

 

第二步,main.js配置requirejs的依赖关系,并启动webapp

复制代码
(function (win) {
    //配置baseUrl
    var baseUrl = document.getElementById('main').getAttribute('data-baseurl');

    /*
     * 文件依赖
     */
    var config = {
        baseUrl: baseUrl,           //依赖相对路径
        paths: {                    //如果某个前缀的依赖不是按照baseUrl拼接这么简单,就需要在这里指出
            director: 'libs/director',
            zepto: 'libs/zepto.min',
            underscore: 'libs/underscore',
            text: 'libs/text'             //用于requirejs导入html类型的依赖
        },
        shim: {                     //引入没有使用requirejs模块写法的类库。
            underscore: {
                exports: '_'
            },
            zepto: {
                exports: '$'
            },
            director: {
                exports: 'Router'
            }
        }
    };

    require.config(config);
    require(['zepto', 'router', 'underscore'], function($, router, _){
        win.appView = $('#container');      //用于各个模块控制视图变化
        win.$ = $;                          //暴露必要的全局变量,没必要拘泥于requirejs的强制模块化
        win._ = _;
        router.init();                      //开始监控url变化
    });


})(window);
复制代码

director.js没有AMD写法,还是按照shim的方式引入。另外,由于$和_的使用率太高,所以这里直接公开为全局变量。

除此之外,还加了appView变量,目的是方便各个子模块修改界面。

 

第三步,router.js配置路由

这里使用的路由类库是director(https://github.com/flatiron/director),相对精简的路由,但其实对于我们这个程序来说,貌似还不够精简。先凑合着吧。

director官网给出的示例也相当简单,就是“路径”对应“函数”,非常清晰而且实用的方式。

复制代码
      var author = function () { console.log("author"); };
      var books = function () { console.log("books"); };
      var viewBook = function (bookId) {
        console.log("viewBook: bookId is populated: " + bookId);
      };

      var routes = {
        '/author': author,
        '/books': [books, function() {
          console.log("An inline route handler.");
        }],
        '/books/view/:bookId': viewBook
      };

      var router = Router(routes);

      router.init();
复制代码

 

来看看我们自己的版本:

复制代码
define(['director', 'underscore'], function (Router, _) {

    //先设置一个路由信息表,可以由html直出,纯字符串配置
    var routes = {
        'module1': 'module1/controller1.js',
        'module2/:name': 'module2/controller2.js'     //director内置了普通必选参数的写法,这种路由,必须用路径“#module2/kenko”才能匹配,无法缺省
//        'module2/?([^\/]*)/?([^\/]*)': 'module2/controller2.js'    //可缺省参数的写法,其实就是正则表达式,括号内部分会被抽取出来变成参数值。backbone做得比较好,把这个语法简化了
                                                                    //  “ /?([^\/]*) ”  这样的一段表示一个可选参数,接受非斜杠/的任意字符
    };

    var currentController = null;

    //用于把字符串转化为一个函数,而这个也是路由的处理核心
    var routeHandler = function (config) {
        return function () {
            var url = config;
            var params = arguments;
            require([url], function (controller) {
                if(currentController && currentController !== controller){
                    currentController.onRouteChange && currentController.onRouteChange();
                }
                currentController = controller;
                controller.apply(null, params);
            });
        }
    };

    for (var key in routes) {
        routes[key] = routeHandler(routes[key]);
    }

    return Router(routes);
});
复制代码

这里把director的路由配置修改了一下,原来只能接受<String, Function>这样的key value对,但参考之前backbone篇,更好方式应该是让路由表尽量只有字符串配置,不要写逻辑(函数)。

所以,上述代码中,多了一个routeHandler,目的就是建立闭包,把string(配置)转换为一个闭包函数。

结果,运行效果就是,遇到一个路由,就根据配置加载对应的子模块代码。后续实际执行什么,由子模块自己决定。这样main/router就能彻底跟子模块解耦。

 

第四步,建立一个模块

tpl.html

<div>
    Here is module 1. My name: <%=name %><br>
    <a href="#module2/fromModule1">turn to module 2</a>
</div>

controller1.js

复制代码
define(['text!module1/tpl.html'], function (tpl) {

    var controller = function () {
        appView.html(_.template(tpl, {name: 'kenko'}));
    };
    return controller;
});
复制代码

我觉得能实现业务逻辑的前提下,越简单的架构就越好,便于传承和维护。

controller就是这个子模块要做的逻辑,appView是整个视图根节点,想怎么玩就怎么玩,这对于不熟悉angular、backbone的同学最爽不过了。

这里重点是利用了requirejs做模块化和依赖加载,并用了underscore的模版库template。

 

第五步,再做一个模块,加上一些销毁接口

tpl.html

<div>
    Here is module 2. My name: <%=name %><br>
    <button>click me!</button>
    <a href="#module1">turn to module 1</a>
</div>

controller2.js

复制代码
define(['text!module2/tpl.html'], function (tpl) {

    var controller = function (name) {
        appView.html(_.template(tpl, {name: name?name:'vivi'}));

        $('button').on('click', function clickHandler() {
            alert('hello');
        });

        controller.onRouteChange = function () {
            console.log('change');      //可以做一些销毁工作,例如取消事件绑定
            $('button').off('click');   //解除所有click事件监听
        };
    };

    return controller;
});
复制代码

 

至此,整个简单的框架就完成了。

posted @ 2016-02-29 15:16  axl234  阅读(2605)  评论(0编辑  收藏  举报