前端构建工具Gulp使用教程（一）、gulp安装以及基础API介绍

前言、gulp和grunt比较

gulpjs是一个前端构建工具，与gruntjs相比，gulpjs无需写一大堆繁杂的配置参数，API也非常简单，学习起来很容易，而且gulpjs使用的是nodejs中stream来读取和操作数据，其速度更快。

工作方式差异：Grunt主要是以文件为媒介来运行它的工作流的，比如在Grunt中执行完一项任务后，会把结果写入到一个临时文件中，然后可以在这个临时文件内容的基础上执行其它任务，执行完成后又把结果写入到临时文件中，然后又以这个为基础继续执行其它任务...就这样反复下去。而在Gulp中，使用的是Nodejs中的stream(流)，首先获取到需要的stream，然后可以通过stream的pipe()方法把流导入到你想要的地方，比如Gulp的插件中，经过插件处理后的流又可以继续导入到其他插件中，当然也可以把流写入到文件中。所以Gulp是以stream为媒介的，它不需要频繁的生成临时文件，这也是Gulp的速度比Grunt快的一个原因。

一、gulp安装

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

npm install -g gulp

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

npm install gulp --save-dev

这样gulp就安装完成了。至于为什么在全局安装gulp后，还需要在项目中本地安装一次，可以看下stackoverflow上的讨论https://stackoverflow.com/questions/22115400/why-do-we-need-to-install-gulp-globally-and-locally。
总结下大致原因是：gulp 全局安装就可以在cmd控制台 使用gulp 命令，而局部安装则是项目中需要用到gulp。而局部安装是为了版本和依赖的控制。当别人Fork你代码，或者你过段时间拷贝到别的电脑上再gulp的时候，能控制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

如果你项目根目录下还没有package.json，执行npm init。输入项目相关信息，就能得到package.json。

2.2、运行gulp任务

要运行gulp任务，只需切换到存放gulpfile.js文件的目录(windows平台请使用cmd或者Power Shell等工具)，然后在命令行中执行gulp命令就行了。如下所示：

上面执行gulp没有指定任务名，执行任务名为default的默认任务。gulp后面可以加上要执行的任务名。比如任务名称是css，在命令行中输入gulp css可以执行这个任务。

三、gulp的API介绍

使用gulp，仅需知道4个API即可：gulp.task(),gulp.src(),gulp.dest(),gulp.watch()。

3.1、gulp.src()

gulp.src()方法正是用来获取流的，但要注意这个流里的内容不是原始的文件流，而是一个虚拟文件对象流(Vinyl files)，这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息，这个我们暂时不用去深入理解，你只需简单的理解可以用这个方法来读取你需要操作的文件就行了。
其语法为：

gulp.src(globs[, options])

globs参数是文件匹配模式(类似正则表达式)，用来匹配文件路径(包括文件名)，当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时，该参数可以为一个数组。
options为可选参数。常用的选项包括read、base、allowEmpty。

read：是否需要读取文件内容，默认是true。如果是要执行删除任务，可以将read设置为false，这样能加快速度。
base：基准路径。如果没有指定，则默认是globs中明确指定的路径。
      比如gulp.src('client/js/**/*.js')。这里将匹配client/js/somedir/somefile.js文件，base值是'client/js'。如果调用gulp.dest()输出文件，输出路径是：文件所在目录中base值替换为gulp.dest()指定目录。
allowEmpty：文件是否允许为空，默认为false。如果为false，gulp.src()又读取不到任何文件就会报错

下面我们重点说说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/*.js 会展开为 **/abd/*.js,**/acd/*.js //表示名abd或acd的目录下的js
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

此外，还支持相对路径。比如

gulp.src(['./*.html','../*.html']) // ./是指当前目录，../是指父级目录

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 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js
gulp.src('script/**/*.js') //有通配符开始出现的那部分路径为 **/*.js
    .pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/**/*.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任务中的异步操作完成之前就执行了。

那如果我们想等待异步任务中的异步操作完成后再执行后续的任务，该怎么做呢？
在gulp4.0之前可以使用run-sequence插件。https://www.npmjs.com/package/run-sequence。
gulp4.0之后的版本gulp.task()函数抛弃了deps参数，使用gulp.series来控制串行、gulp.parellel()用于并行执行。后面会详细讲解

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); //变化的文件的路径
}

四、gulp4.0

上面在这几个函数的讲解都是基于gulp3.0版本。gulp4.0做了一些调整，先罗列下目前遇到的一些差异。后续再总结其他的

4.1、gulp.task()去掉依赖模块参数

gulp.task()函数在3.0版本是有三个参数，第二个参数是依赖任务，但是4.0把这个参数去掉了。

gulp('default', ['css', 'js'], function(callback) {
    callback()
}); //gulp3.0格式为：gulp.task(name[, deps], fn) 

gulp.task(name,  function(callback) {
    callback()
)} //gulp4.0格式为gulp.task(name, fn) 

3.0版本中gulp.task的deps参数是设置是依赖任务，但任务不能做到串行执行。如果要串行执行任务，要通过配合run-sequence插件来使用。看下下面的实例，运行需要先安装run-sequence、gulp-clean（npm install run-sequence gulp-clean --save-dev）。

var gulp = require('gulp'),
    runSequence = require('run-sequence'),
    clean = require('gulp-clean'),  //清理档案
//删除文件夹
gulp.task('clean', function(){
   return gulp.src(['static']).pipe(clean());
});

//复制文件夹
gulp.task('copy', function(){
   return gulp.src(['../static'])
    .pipe(gulp.dest("static"));
});

gulp('default', function(callback) {
   runSequence(['clean', 'copy'], callback);
});

在gulp4.0上安装run-sequence会报错。因为run-sequence只是gulp4.0之前的临时解决方案,gulp4.0已经不再需要。任务的串行、并行通过gulp.series、gulp.parallel接口实现。下面这个例子是串行执行，会先删除static文件夹，再复制父级目录static文件夹到当前目录。

var gulp = require('gulp'),
    clean = require('gulp-clean'),  //清理档案
//删除文件夹
gulp.task('clean', function(){
   return gulp.src(['static']).pipe(clean());
});

//复制文件夹
gulp.task('copy', function(){
   return gulp.src(['../static'])
       .pipe(gulp.dest("static"));
});

gulp('default', gulp.series('clean', 'copy', function(callback) {
   callback();
}));

如果是要并行执行，比如创建两个复制任务，希望同时执行。代码实现如下：

var gulp = require('gulp');

//复制文件夹
gulp.task('copySource', function(){
   return gulp.src(['../source'])
       .pipe(gulp.dest("source"));
});

//复制文件夹
gulp.task('copyStatic', function(){
   return gulp.src(['../static'])
       .pipe(gulp.dest("static"));
});

gulp('default', gulp.series('copySource', 'copyStatic', function(callback) {
   callback();
}));

五、参考文章

1、前端构建工具gulpjs的使用介绍及技巧：https://www.cnblogs.com/2050/p/4198792.html#!comments （写得很清晰明了，特别是对于gulp.src路径参数的介绍）
2、gulp 4.0 API 文档：http://www.ijilei.com/6049
3、gulp系列文章：https://blog.csdn.net/guang_s/article/details/84673204（包括安装、各个插件使用教程等）
4、gulp 4: gulp.parallel gulp.series -- 全新的任务执行体系：https://segmentfault.com/a/1190000017571288?utm_source=tag-newest