前端构建工具gulp

gulpjs是一个前端构建工具，与gruntjs相比，gulpjs无需写一大堆繁杂的配置参数，API也很是简单，学习起来很容易，并且gulpjs使用的是nodejs中stream来读取和操做数据，其速度更快。若是你尚未使用过前端构建工具，或者以为gruntjs太难用的话，那就尝试一下gulp吧。

一、gulp的安装

首先确保你已经正确安装了nodejs环境。而后以全局方式安装gulp：

npm install -g gulp

全局安装gulp后，还须要在每一个要使用gulp的项目中都单独安装一次。把目录切换到你的项目文件夹中，而后在命令行中执行：

npm install gulp

若是想在安装的时候把gulp写进项目package.json文件的依赖中，则能够加上--save-dev：

npm install --save-dev gulp

这样就完成了gulp的安装。至于为何在全局安装gulp后，还须要在项目中本地安装一次，有兴趣的能够看下stackoverflow上有人作出的回答：why-do-we-need-to-install-gulp-globally-and-locally、what-is-the-point-of-double-install-in-gulp。大致就是为了版本的灵活性，但若是没理解那也没必要太去纠结这个问题，只须要知道一般咱们是要这样作就好了。

二、开始使用gulp

2.1 创建gulpfile.js文件

就像gruntjs须要一个Gruntfile.js文件同样，gulp也须要一个文件做为它的主文件，在gulp中这个文件叫作gulpfile.js。新建一个文件名为gulpfile.js的文件，而后放到你的项目目录中。以后要作的事情就是在gulpfile.js文件中定义咱们的任务了。下面是一个最简单的gulpfile.js文件内容示例，它定义了一个默认的任务。

var gulp = require('gulp');
gulp.task('default',function(){
    console.log('hello world');
});

此时咱们的目录结构是这样子的：

├── gulpfile.js
├── node_modules
│ └── gulp
└── package.json

2.2 运行gulp任务

要运行gulp任务，只需切换到存放gulpfile.js文件的目录(windows平台请使用cmd或者Power Shell等工具)，而后在命令行中执行gulp命令就好了，gulp后面能够加上要执行的任务名，例如gulp task1，若是没有指定任务名，则会执行任务名为default的默认任务。

三、gulp的API介绍

使用gulp，仅需知道4个API便可：gulp.task(),gulp.src(),gulp.dest(),gulp.watch()，因此很容易就能掌握，但有几个地方需理解透彻才行，我会在下面一一说明。为了不出现理解误差，建议先看一遍官方文档。

3.1 gulp.src()

在介绍这个API以前咱们首先来讲一下Grunt.js和Gulp.js工做方式的一个区别。Grunt主要是以文件为媒介来运行它的工做流的，好比在Grunt中执行完一项任务后，会把结果写入到一个临时文件中，而后能够在这个临时文件内容的基础上执行其它任务，执行完成后又把结果写入到临时文件中，而后又以这个为基础继续执行其它任务...就这样反复下去。而在Gulp中，使用的是Nodejs中的stream(流)，首先获取到须要的stream，而后能够经过stream的pipe()方法把流导入到你想要的地方，好比Gulp的插件中，通过插件处理后的流又能够继续导入到其余插件中，固然也能够把流写入到文件中。因此Gulp是以stream为媒介的，它不须要频繁的生成临时文件，这也是Gulp的速度比Grunt快的一个缘由。再回到正题上来，gulp.src()方法正是用来获取流的，但要注意这个流里的内容不是原始的文件流，而是一个虚拟文件对象流(Vinyl files)，这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息，这个咱们暂时不用去深刻理解，你只需简单的理解能够用这个方法来读取你须要操做的文件就好了。其语法为：

gulp.src(globs[, options])

globs参数是文件匹配模式(相似正则表达式)，用来匹配文件路径(包括文件名)，固然这里也能够直接指定某个具体的文件路径。当有多个匹配模式时，该参数能够为一个数组。 options为可选参数。一般状况下咱们不须要用到。

下面咱们重点说说Gulp用到的glob的匹配规则以及一些文件匹配技巧。 Gulp内部使用了node-glob模块来实现其文件匹配功能。咱们可使用下面这些特殊的字符来匹配咱们想要的文件：

* 匹配文件路径中的0个或多个字符，但不会匹配路径分隔符，除非路径分隔符出如今末尾
** 匹配路径中的0个或多个目录及其子目录,须要单独出现，即它左右不能有其余东西了。若是出如今末尾，也能匹配文件。
? 匹配文件路径中的一个字符(不会匹配路径分隔符)
[...] 匹配方括号中出现的字符中的任意一个，当方括号中第一个字符为^或!时，则表示不匹配方括号中出现的其余字符中的任意一个，相似js正则表达式中的用法
!(pattern|pattern|pattern) 匹配任何与括号中给定的任一模式都不匹配的
?(pattern|pattern|pattern) 匹配括号中给定的任一模式0次或1次，相似于js正则中的(pattern|pattern|pattern)?
+(pattern|pattern|pattern) 匹配括号中给定的任一模式至少1次，相似于js正则中的(pattern|pattern|pattern)+
*(pattern|pattern|pattern) 匹配括号中给定的任一模式0次或屡次，相似于js正则中的(pattern|pattern|pattern)*
@(pattern|pattern|pattern) 匹配括号中给定的任一模式1次，相似于js正则中的(pattern|pattern|pattern)

下面以一系列例子来加深理解

* 能匹配 a.js,x.y,abc,abc/,但不能匹配a/b.js
*.* 能匹配 a.js,style.css,a.b,x.y
*/*/*.js 能匹配 a/b/c.js,x/y/z.js,不能匹配a/b.js,a/b/c/d.js
** 能匹配 abc,a/b.js,a/b/c.js,x/y/z,x/y/z/a.b,能用来匹配全部的目录和文件
**/*.js 能匹配 foo.js,a/foo.js,a/b/foo.js,a/b/c/foo.js
a/**/z 能匹配 a/z,a/b/z,a/b/c/z,a/d/g/h/j/k/z
a/**b/z 能匹配 a/b/z,a/sb/z,但不能匹配a/x/sb/z,由于只有单**单独出现才能匹配多级目录
?.js 能匹配 a.js,b.js,c.js
a?? 能匹配 a.b,abc,但不能匹配ab/,由于它不会匹配路径分隔符
[xyz].js 只能匹配 x.js,y.js,z.js,不会匹配xy.js,xyz.js等,整个中括号只表明一个字符
[^xyz].js 能匹配 a.js,b.js,c.js等,不能匹配x.js,y.js,z.js

当有多种匹配模式时可使用数组

//使用数组的方式来匹配多种文件
gulp.src(['js/*.js','css/*.css','*.html'])

使用数组的方式还有一个好处就是能够很方便的使用排除模式，在数组中的单个匹配模式前加上!便是排除模式，它会在匹配的结果中排除这个匹配，要注意一点的是不能在数组中的第一个元素中使用排除模式

gulp.src([*.js,'!b*.js']) //匹配全部js文件，但排除掉以b开头的js文件
gulp.src(['!b*.js',*.js]) //不会排除任何文件，由于排除模式不能出如今数组的第一个元素中

此外，还可使用展开模式。展开模式以花括号做为定界符，根据它里面的内容，会展开为多个模式，最后匹配的结果为全部展开的模式相加起来获得的结果。展开的例子以下：

a{b,c}d 会展开为 abd,acd
a{b,}c 会展开为 abc,ac
a{0..3}d 会展开为 a0d,a1d,a2d,a3d
a{b,c{d,e}f}g 会展开为 abg,acdfg,acefg
a{b,c}d{e,f}g 会展开为 abdeg,acdeg,abdeg,abdfg

3.2 gulp.dest()

gulp.dest()方法是用来写文件的，其语法为：

gulp.dest(path[,options])

path为写入文件的路径 options为一个可选的参数对象，一般咱们不须要用到

要想使用好gulp.dest()这个方法，就要理解给它传入的路径参数与最终生成的文件的关系。 gulp的使用流程通常是这样子的：首先经过gulp.src()方法获取到咱们想要处理的文件流，而后把文件流经过pipe方法导入到gulp的插件中，最后把通过插件处理后的流再经过pipe方法导入到gulp.dest()中，gulp.dest()方法则把流中的内容写入到文件中，这里首先须要弄清楚的一点是，咱们给gulp.dest()传入的路径参数，只能用来指定要生成的文件的目录，而不能指定生成文件的文件名，它生成文件的文件名使用的是导入到它的文件流自身的文件名，因此生成的文件名是由导入到它的文件流决定的，即便咱们给它传入一个带有文件名的路径参数，而后它也会把这个文件名当作是目录名，例如：

var gulp = require('gulp');
gulp.src('script/jquery.js')
    .pipe(gulp.dest('dist/foo.js'));
//最终生成的文件路径为 dist/foo.js/jquery.js,而不是dist/foo.js

要想改变文件名，可使用插件gulp-rename

下面说说生成的文件路径与咱们给gulp.dest()方法传入的路径参数之间的关系。 gulp.dest(path)生成的文件路径是咱们传入的path参数后面再加上gulp.src()中有通配符开始出现的那部分路径。例如：

var gulp = reruire('gulp');
//有通配符开始出现的那部分路径为 **/*.js
gulp.src('script/**/*.js')
    .pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/**/*.js
//若是 **/*.js 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js

再举更多一点的例子

gulp.src('script/avalon/avalon.js') //没有通配符出现的状况
    .pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/avalon.js

//有通配符开始出现的那部分路径为 **/underscore.js
gulp.src('script/**/underscore.js')
    //假设匹配到的文件为script/util/underscore.js
    .pipe(gulp.dest('dist')); //则最后生成的文件路径为 dist/util/underscore.js

gulp.src('script/*') //有通配符出现的那部分路径为 *
    //假设匹配到的文件为script/zepto.js    
    .pipe(gulp.dest('dist')); //则最后生成的文件路径为 dist/zepto.js

经过指定gulp.src()方法配置参数中的base属性，咱们能够更灵活的来改变gulp.dest()生成的文件路径。 当咱们没有在gulp.src()方法中配置base属性时，base的默认值为通配符开始出现以前那部分路径，例如：

gulp.src('app/src/**/*.css') //此时base的值为 app/src

上面咱们说的gulp.dest()所生成的文件路径的规则，其实也能够理解成，用咱们给gulp.dest()传入的路径替换掉gulp.src()中的base路径，最终获得生成文件的路径。

gulp.src('app/src/**/*.css') //此时base的值为app/src,也就是说它的base路径为app/src
     //设该模式匹配到了文件 app/src/css/normal.css
    .pipe(gulp.dest('dist')) //用dist替换掉base路径，最终获得 dist/css/normal.css
因此改变base路径后，gulp.dest()生成的文件路径也会改变

gulp.src(script/lib/*.js) //没有配置base参数，此时默认的base路径为script/lib
    //假设匹配到的文件为script/lib/jquery.js
    .pipe(gulp.dest('build')) //生成的文件路径为 build/jquery.js

gulp.src(script/lib/*.js, {base:'script'}) //配置了base参数，此时base路径为script
    //假设匹配到的文件为script/lib/jquery.js
    .pipe(gulp.dest('build')) //此时生成的文件路径为 build/lib/jquery.js    
用gulp.dest()把文件流写入文件后，文件流仍然能够继续使用。

3.3 gulp.task()

gulp.task方法用来定义任务，内部使用的是Orchestrator，其语法为：

gulp.task(name[, deps], fn)

name 为任务名 deps 是当前定义的任务须要依赖的其余任务，为一个数组。当前定义的任务会在全部依赖的任务执行完毕后才开始执行。若是没有依赖，则可省略这个参数 fn 为任务函数，咱们把任务要执行的代码都写在里面。该参数也是可选的。

gulp.task('mytask', ['array', 'of', 'task', 'names'], function() { //定义一个有依赖的任务
  // Do something
});

gulp.task()这个API没什么好讲的，但须要知道执行多个任务时怎么来控制任务执行的顺序。 gulp中执行多个任务，能够经过任务依赖来实现。例如我想要执行one,two,three这三个任务，那咱们就能够定义一个空的任务，而后把那三个任务当作这个空的任务的依赖就好了：

//只要执行default任务，就至关于把one,two,three这三个任务执行了
gulp.task('default',['one','two','three']);

若是任务相互之间没有依赖，任务会按你书写的顺序来执行，若是有依赖的话则会先执行依赖的任务。 可是若是某个任务所依赖的任务是异步的，就要注意了，gulp并不会等待那个所依赖的异步任务完成，而是会接着执行后续的任务。例如：

gulp.task('one',function(){
  //one是一个异步执行的任务
  setTimeout(function(){
    console.log('one is done')
  },5000);
});

//two任务虽然依赖于one任务,但并不会等到one任务中的异步操做完成后再执行
gulp.task('two',['one'],function(){
  console.log('two is done');
});

上面的例子中咱们执行two任务时，会先执行one任务，但不会去等待one任务中的异步操做完成后再执行two任务，而是紧接着执行two任务。因此two任务会在one任务中的异步操做完成以前就执行了。

那若是咱们想等待异步任务中的异步操做完成后再执行后续的任务，该怎么作呢？ 有三种方法能够实现： 第一：在异步操做完成后执行一个回调函数来通知gulp这个异步任务已经完成,这个回调函数就是任务函数的第一个参数。

gulp.task('one',function(cb){ //cb为任务函数提供的回调，用来通知任务已经完成
  //one是一个异步执行的任务
  setTimeout(function(){
    console.log('one is done');
    cb();  //执行回调，表示这个异步任务已经完成
  },5000);
});

//这时two任务会在one任务中的异步操做完成后再执行
gulp.task('two',['one'],function(){
  console.log('two is done');
});

第二：定义任务时返回一个流对象。适用于任务就是操做gulp.src获取到的流的状况。

gulp.task('one',function(cb){
  var stream = gulp.src('client/**/*.js')
      .pipe(dosomething()) //dosomething()中有某些异步操做
      .pipe(gulp.dest('build'));
    return stream;
});

gulp.task('two',['one'],function(){
  console.log('two is done');
});

第三：返回一个promise对象，例如

var Q = require('q'); //一个著名的异步处理的库 https://github.com/kriskowal/q
gulp.task('one',function(cb){
  var deferred = Q.defer();
  // 作一些异步操做
  setTimeout(function() {
     deferred.resolve();
  }, 5000);
  return deferred.promise;
});

gulp.task('two',['one'],function(){
  console.log('two is done');
});

gulp.task()就这些了，主要是要知道当依赖是异步任务时的处理。

3.4 gulp.watch()

gulp.watch()用来监视文件的变化，当文件发生变化后，咱们能够利用它来执行相应的任务，例如文件压缩等。其语法为

gulp.watch(glob[, opts], tasks)

glob 为要监视的文件匹配模式，规则和用法与gulp.src()方法中的glob相同。 opts 为一个可选的配置对象，一般不须要用到 tasks 为文件变化后要执行的任务，为一个数组

gulp.task('uglify',function(){
  //do something
});
gulp.task('reload',function(){
  //do something
});
gulp.watch('js/**/*.js', ['uglify','reload']);

gulp.watch()还有另一种使用方式：

gulp.watch(glob[, opts, cb])

glob和opts参数与第一种用法相同 cb参数为一个函数。每当监视的文件发生变化时，就会调用这个函数,而且会给它传入一个对象，该对象包含了文件变化的一些信息，type属性为变化的类型，能够是added,changed,deleted；path属性为发生变化的文件的路径

gulp.watch('js/**/*.js', function(event){
    console.log(event.type); //变化类型 added为新增,deleted为删除，changed为改变 
    console.log(event.path); //变化的文件的路径
});