玩转JS系列之模块化编程和自动化构建

一开始我们这样写js

<script type="text/javascript">
function a(){
　　console.log('a init');
}
function b(){

　　console.log('b init');
　　a();

}
</script>

随着功能越来越多，我们开始把js分离，使用单独的js文件来写，然后使用下面的方式引入js

<script src="a.js" type="text/javascript" charset="utf-8"></script>

<script src="b.js" type="text/javascript" charset="utf-8"></script>

这种方式有几个缺陷：

1，不能体现他们之间的依赖关系

2，文件越多请求越多，请求多会拖慢网页打开速度

3，代码写起来不爽

有没有一种方式既可以愉快的写又可以很好的组织代码呢，那就是模块化编程。

目前有两种js编码规范来解决上述问题：AMD（异步模块定义）和CMD（通用模块定义），

根据这两种规范实现的js加载器分别有：

AMD:require.js

CMD:Sea.js

笔者使用的是require.js。

下面展示一下如何用require.js来进行模块化开发，

先看一下目录结构

使用require.js怎么来加载呢，首先在网页中引入require.js 然后在script标签中增加一个自定义属性 data-main="main.js" 页面加载完毕后require.js会根据这个属性去找main.js 然后开始执行，main.js是入口文件

<script src="require.js" defer async data-main="main.js" type="text/javascript" charset="utf-8"></script>

下面是入口文件main.js

requirejs.config({
    baseUrl: 'js/' //模块文件所在位置
});
require(['b'],function(b){
    b.init();
});

require.js里有两个方法很重要一个是require一个是define 前者用来引入模块，后者用来定义模块

在main.js中用 requirejs.config 配置好模块们所在位置之后就可以使用 require方法来使用他们了

a.js和b.js是两个模块由于require.js会自动补全所以我们引用的时候不必书写完整的文件名称a.js，只需要写文件名a就行了

a.js

define(function(){
    return {
        init:function(){
            console.log("a init")
        }
    }
});

b.js

define(['a'],function(a){
    return {
        init:function(){
            console.log("b init")
            a.init();
        }
    }
});

b依赖a所以在定义b的时候需要在define的第一个参数中引入a ，define第一个参数是数组类型，如果引入多个模块那么就像这样：define(['a','a1','a2'],function(a,a1,a2){})

执行后

是不是很简单，简简单单几行代码就拥抱了模块化编程是不是很激动

现在激动还为时过早，模块化编程我们是用上了但是还没有解决第二个问题，就是请求数，现在还是一个模块一个js文件

现在要做的就是把他们合并，合并成一个js文件,

是时候请出第二个主角了，没错就是Gulp 。整天在网上看自动化构建啥是自动化啥是构建呀

用在我们这个例子里就是自动合并，比如我添加或者修改了模块 Gulp会自动把新代码合并，是不是很酷。在gulp里这些操作称为任务，通过gulp的watch方法来监控文件，达到文件一变动，任务就执行的目的，这就是自动化构建。

Gulp提供了丰富的插件，Gulp依赖Node.js环境所以需要先安装node.js，以下说的是windows上的操作步骤

首先下载 node.js 下载地址：http://nodejs.cn/download/

安装好后进入根目录按住shift 点击鼠标右键打开命令行

使用node.js自带的npm包管理工具安装gulp

这里提一下，如果直接装会比较慢，推荐使用淘宝的npm镜像：http://npm.taobao.org/

npm install -g cnpm --registry=https://registry.npm.taobao.org

//装完之后就可以用cnpm 替代npm 速度飞快

cnpm i gulp -g

安装npm包可以选择是安装到项目里还是安装到全局，下面我们安装最重要的一个npm模块gulp-requirejs-optimize 这个模块基于requre.js提供的打包工具https://github.com/requirejs/r.js

cnpm i gulp-requirejs-optimize -D

//我们用了简写的命令 上面的命令等同于 cnpm install gulp-requirejs-optimize --save-dev  后面的--save-dev意思是

把我们装的这个模块加入到Npm的包配置清单里 这个清单是个配置文件叫做 package.json

如果一个一个装显得有些繁琐, 有没有一键安装，答案是有的。

上面我们提到了package.json，没错我们可以利用这个文件实现一个命令安装所有依赖模块

{
  "name": "",
  "description": "",
  "version": "1.0.0",
  "author": "maxiao",
  "private": true,
  "scripts": {
  },
  "dependencies": {
  },
  "devDependencies": {"gulp": "^3.9.1",
    "gulp-bom": "^1.0.0","gulp-rename": "^1.2.2",
    "gulp-requirejs": "^1.0.0-rc2",
    "gulp-requirejs-optimize": "^1.2.0",
    "gulp-rev": "^8.0.0",
    "gulp-rev-collector": "^1.2.2",
    "gulp-sequence": "^0.4.6",

  }
}

我们把这个文件放到根目录下然后在命令行里执行 cnpm install npm会自动把里面列的所有模块都装上

这里提到的模块是node.js里的模块而非我们前端定义的那些模块，唯一的区别是一个在node.js里执行一个在浏览器端执行，如果对js的服务端编程感兴趣的话可以去了解一下node 这里就不多聊了。

当所有gulp依赖的模块都安装好之后就可以编写我们的gulp任务脚本了，没错这个脚本是个js文件叫做gulpfile.js

下面是gulpfile.js里的内容，是不是很熟悉

var gulp = require('gulp');// 引入组件
var 
    minifycss = require('gulp-minify-css'),//css压缩
    uglify = require('gulp-uglify'),//js压缩
    requirejsOptimize = require('gulp-requirejs-optimize');
    concat = require('gulp-concat'),//文件合并
    rename = require('gulp-rename'),//文件更名
    rev = require('gulp-rev'),//给文件名添加版本号
    del = require('del'),//删除就版本
    bom = require('gulp-bom'),//添加bom防止中文乱码
    obfuscate = require('gulp-obfuscate'),
    revCollector = require('gulp-rev-collector'),//路径替换
    gulpSequence = require('gulp-sequence'), //按顺序执行任务
;//提示信息
var newVersion = function () {
    var uuid = require('node-uuid');
    return uuid.v1().slice(0, 8)
}
/***************************************************************************************************************JS*/
//清理
gulp.task('clearjs', function (cb) {
    return del('dest/livecontent/livecommon/app/*.js', cb);
});


gulp.task("requirejs_pipe", function () {
    return gulp.src('main.js')
        .pipe(requirejsOptimize(function (file) {
            return {
                name: 'main',
                optimize: 'uglify2',
                //useStrict: true,
                baseUrl: '/',

            };
        }))
        .pipe(rev())
        .pipe(gulp.dest('dest/'))
        .pipe(rev.manifest({
                merge: true
        }))
        .pipe(gulp.dest(''));

});
//更改版本号
gulp.task('renamejs', function () {
    return gulp.src('main.js')
        .pipe(rev())
        .pipe(gulp.dest('dest/'))
        .pipe(rev.manifest({
            merge: true
        }))
        .pipe(gulp.dest(''));
});
//更改引用
gulp.task('usenewjs', function () {
    return gulp.src(['rev-manifest.json', 'index.html'])   //- 读取 rev-manifest.json 文件以及需要进行css名替换的文件
        .pipe(revCollector({
            replaceReved: true
        }))
        .pipe(bom())
        //- 执行文件内css名的替换
        .pipe(gulp.dest('dest/js/'));
});
// 默认任务
gulp.task('default', function () {
    gulpSequence('clearjs',
        'requirejs_pipe','usenewjs'
    )(function (err) {
            if (err) console.log(err)
        })
// Watch .js files
    gulp.watch(['js/*.js'], function () {
        gulpSequence('clearjs', 'requirejs_pipe', 'usenewjs')(function (err) {
            if (err) console.log(err)
        })
    });


});

写好后在命令行里输入：gulp 然后回车

gulp就会一直监控js目录下的文件变化了，一有改动就会生成新的文件写入到dest目录下

里面用到了几个我没提到的模块比如给合并后的文件加版本号的，控制任务顺序执行的，删除文件，防止文件乱码的，这都是笔者爬坑过程中为了解决问题一个一个找的啊真良心推荐每个都会用到

我们项目中的代码只有index.html requre.js,main.js,a.js,b.js 。 node.js，npm ，gulp只是我们的用到的工具。

es6的到来前端工具百花齐放，学好js再使用他们就会感觉很顺手事半功倍

posted @ 2017-08-21 19:45 小马在唱歌阅读(1566) 评论(0) 编辑收藏举报

刷新页面返回顶部

小马在唱歌

玩转JS系列之模块化编程和自动化构建

公告