js模块化构建方案

html与js模块化解决方案##

html 模块以预编译的方式模块编写,例:界面包含三部分(head body footJS同一套项目里面必然会涉及到通用的部分(head footJs),各个界面不同主要在body体。

js 以模块预加载的方式通过特定的方式去加载模块js代码。模块化js主要以sea.js方式去加载。

项目初始化

  1. 执行以下命令
$ npm install

注:可以通过cnpm安装

  1. 构建项目
$ gulp

目录结构

/project/
    /dist       # 最终输出和使用的代码目录
        /js     # 最终输出编译后的js文件
        /css    # 最终输出的样式文件
        x.html  # 输出html文件
    /src        # 源文件目录
        /scss   # scss源文件目录
        /js     # js源文件目录
        /html   # html源文件目录

模块讲解

1.html模块

html构建方式:

gulp.task("html", function() {
    var distPath = './dist';

    return gulp.src('src/html/*.html')
               .pipe(includer({ debug : true}))
               .pipe(replace("{{version}}", dateFormat('YmdHis')))
               .pipe(htmlmin( { collapseWhitespace : true, minifyCSS : true, minifyJS : true }))
               .pipe(gulp.dest(distPath))
               .pipe(notify({ message: "HTML task complete!" }))
});

配置的解决方案:html模板之间主要以include的方式加载所需模块。类似于tmodJS(artTemplate),压缩html代码最终输出到dist文件中。模块加载方式(例):

<!-- include "./components/html_head.html" -->
        <title>架手架编译html</title>
    </head>
    <body>
        <div id="layout">
            <!-- include "./components/header.html" -->
            <div id="main">
                中间内容层
            </div>
            <!-- include "./components/footer.html" -->
        </div>
        <div id="load-module" data-main="p.index"></div>
        <!-- include "./components/global_js.html" -->
    </body>
</html>
2. js模块化

在申明之前,先简单了解下html 模块中footJs模块的定义:

        <script type="text/javascript" src="js/sea.js"></script>
        <script>
            var VERSION = "{{version}}";

            seajs.config({
                base  : "./js/",
                alias : {
                    "jquery" : (!window.addEventListener) ? "jquery-1.11.3.min.js" : "jquery-2.2.4.min.js"
                },
                preload: ['jquery'], //使用use之前确保模块已经加载好
                'map': [
                    [ /^(.*\/js\/(.*)(js|css))(.*)$/i, "$1?v=" + VERSION]
                ]
            });
            
            seajs.use('app.min', function() {
                seajs.use('app');
            });
        </script>

VERSION主要配置版本号,做文件加载禁止缓存处理,map中的映射主要是为了加载模块时,添加文件后缀禁止缓存。加载编译后的app.min.js。界面的入口函数都在app.js模块中去控制。那么,如何控制每个界面加载不同的js模块?先看app.js模块定义:

/**
 * 初始化脚本模块文件
 */
define(function(require, exports, module) {
    var $  = require("jquery"),
        WD = require("widget");

    $(function(){
        var $loadModule = $('#load-module'),
            loadModule  = $loadModule.attr('data-main');
    
        console.log('app.js 初始化脚本模块文件');

        if (loadModule) {
            require(loadModule); // 动态加载页面模块文件
        }
    });
});

所有界面的入口执行函数都在app.js中通过获取html每个界面body模板中定义的data-main中的参数动态加载相应的界面以来文件。例如上述例子中定义的data-main="p.index" 在界面开始执行入口主函数app.js后,会加载p.index.js模块。再看p.index模块定义:

/**
 * 首页脚本模块文件
 */
define(function(require, exports, module) {
    var $  = require('jquery');
    var WD = require('widget');
  
    console.log('p.index', WD);
    console.log($);
    ....
    var dialog = new WD.dialog();
});

在界面js模块中引入组件模块,业务模块,视图模块,控制模块。执行主函数。其中,每个模块都可以以模块化的方式定义,具体情景看具体的业务定义,以组件模块定义为例:
定义dialog组件

/**
 * 一个对话框组件模块
 */
define(function(require, exports, module) {
    function Dialog() {
        console.log('Dialog');
    }
    
    module.exports = Dialog;
});

再接着定义全局模块引入所以定义好的组件模块

/**
 * 公共组件模块文件的模块集合
 */
define(function(require, exports, module) {
    var dialog = require('./mt.dialog'); // 例:引入一个对话框组件模块
    
    exports.dialog = dialog;
    //....        其它组件模块
    exports.func1 = function() {
        alert('方法1');
    };
});

在这个组件模块集合中,将所有模块暴露出去。具体调用方式,上述p.index.js模块中有定义。

构建亮点介绍

  1. 动态的js,css版本控制VERISON
  2. html模板模块划分。
  3. 模块化js脚本,更简洁明了的管理js代码

缺陷与不足

  1. 图片资源文件没有做处理。
  2. 低版本兼容性没处理(后期再做介绍)
  3. 将sea升级为es6语法

总结

此篇与前面两篇scss构建相呼应,可以将scss编译集成到项目里面。其中每个界面的执行脚本,主要通过界面核心(body)模板中声明的data-mian控制加载。以及编译后,动态修改界面引入的js与css文件的版本。有效解决在开发时,重复编译造成的缓存问题。至于此方案中优化的问题(兼容性控制,子模块定义方式,通用模块定义),文章另做详解

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容

  • Node.js是目前非常火热的技术,但是它的诞生经历却很奇特。 众所周知,在Netscape设计出JavaScri...
    w_zhuan阅读 3,603评论 2 41
  • 1 Node.js模块的实现# 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都...
    七寸知架构阅读 2,047评论 1 50
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,073评论 25 707
  • 1 Node.js模块的实现 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都着...
    zlx_2017阅读 1,209评论 0 1
  • 那烂漫的年月 我扯下你的肚兜 你搂住我的腰身 含下尘世的水 吞下前世的果 破了今世的修行 欠了来事的债 轮回千百世...
    菠菜菠菜大菠菜阅读 321评论 2 2