gulp使用方法与配置详解

一、定义

gulp是一个自动化构建工具，主要用来设定程序自动处理静态资源的工作。简单的说gulp就是用来打包项目的。

二、安装

1、全局安装gulp命令： npm install -g gulp
2、创建项目文件夹，当前文件夹下输入命令 npm init
3、全局安装gulp后，还需要在每个使用gulp的项目中单独安装一次，当前文件夹下输入命令： npm install gulp --save-dev
4、配置gulpfile.js文件：在当前项目文件夹下创建名为gulpfile.js的文件，作为该项目配置文件

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

在项目文件夹下输入命令gulp时，就是触发这个default任务，因此我们定义多个自定义事件，这样在输入gulp时，就可以直接将我们写的命令也一起触发

三、gulp API

gulp是一个基于任务的工具，规定不管做什么功能都用统一的接口处理，必须去注册一个任务，然后去执行这个任务，在任务代码中去做想做的功能，这是gulp的特点之一：任务化。gulp的每个功能都是一个任务，压缩css的任务、合并文件的任务等等。gulp规定任务要写在一个叫做glupfile.js的文件中，在这个文件中用来配置所有任务。在使用gulp时需要先引入：

var glup = require("gulp");

这个gulp是一个对象，提供了很多接口，都是这个对象的方法

1、注册任务接口：gulp.task(name[,deps],fn) ，其中name是任务名称，执行任务时使用这个名称；deps是当前定义的任务需要依赖的其他任务，为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖，则可以省略这个参数；fn是任务函数（回调函数），代表这个任务要做的事情，我们把任务要执行的代码都写在里面，该参数也是可选的。

gulp.task('myTask', ['array', 'of', 'task', 'names'], function() { //定义一个有依赖的任务
    console.log('Hello World!')
});

执行任务：在命令行使用gulp命令，后面跟任务名称，gulp myTask即可。如果任务比较多的话，一个一个来执行，效率会很低，所以gulp提供了一个默认任务，可以将要执行的所有任务放在一个数组中，这样只需要执行这个默认任务就能执行数组中的所有任务：

gulp.task("print1",function(){console.log("打印123");})
gulp.task("print3",function(){console.log("打印321");})
gulp.task("default",["print1","print3"]);

执行默认任务：不用写任务名，如：gulp即可。

（1）gulp自己有内存，当我们使用gulp进行项目构建的时候，gulp会将本地文件数据读取到gulp内存中，接下来的操作都在内存中进行，操作完成以后，再从gulp的内存中输出到本地，比如说当我们要合并两个文件的时候，先将这两个文件中的内容读取到内存中，然后在内存中进行合并，最后将合并后的内容从内存中输出到本地的文件中。这样，对应着两个操作，一个是输入，一个输出，也就是I/O操作。这是gulp的又一个特点之一：基于流。

（2）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');
});

2、读取文件接口：gulp.src(globs [,options])，将本地文件读取到内存中。其中globs参数是文件匹配模式（类似正则表达式），用来匹配文件路径（包括文件名），当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时，该参数可以为一个数组；options为可选参数。通常情况下我们不需要用到；{base:***}//基准路径 默认值为通配符开始出现之那部分路径

//转换html文件
gulp.task('html', function(){
    gulp.src('./src/index.html')
        .pipe(connect.reload())
        .pipe(gulp.dest('./dist'));     //写入命令
});

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

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

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

gulp.src([*.js,'!b*.js'])      //匹配所有js文件，但排除掉以b开头的js文件

3、输出到文件接口：gulp.dest(path[,options])，将内存中数据输出到本地文件中。其中path为写入文件的路径；options为一个可选的参数对象，通常我们不需要用到
（1）要想使用好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

（2）生成的文件路径与我们给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()把文件流写入文件后，文件流仍然可以继续使用

4、监听文件变化接口：gulp.watch(globs[,opts],tasks)，用来监视文件的变化，当文件发生变化后，我们可以利用它来执行相应的任务，例如文件压缩等。其中globs为要见识的文件匹配模式 ，规则和用法与gulp.src方法中的glob相同；opts为一个可配置对象 通常不需要用到；tasks为文件变化后要执行的任务，为一个数组

gulp.task('uglify',function(){
    console.log('uglify')
});
gulp.task('',function(){
    console.log('reload')
});
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);      //变化的文件的路径
}); 

5、gulp插件：npm install XX --save-dev 安装插件到当前的项目dev，在gulpfile.js顶部引入此插件，在创建任务的时候使用此插件。
（1）gulp-load-plugins：这个插件会自动帮你加载package.json文件里的gulp插件
要使用gulp的插件，首先得用require来把插件加载进来，如果我们要使用的插件非常多，那我们的gulpfile.js文件开头可能就会是这个样子的：

var gulp = require('gulp'),
//一些gulp插件,abcd这些命名只是用来举个例子
a = require('gulp-a'), 
b = require('gulp-b'),
c = require('gulp-c'),
d = require('gulp-d'),
e = require('gulp-e'),
f = require('gulp-f'),
g = require('gulp-g'),
//更多的插件...
z = require('gulp-z');

虽然这没什么问题，但会使我们的gulpfile.js文件变得很冗长，看上去不那么舒服。gulp-load-plugins插件正是用来解决这个问题。gulp-load-plugins这个插件能自动帮你加载package.json文件里的gulp插件。例如假设你的package.json文件里的依赖是这样的:

{
    "devDependencies": {
        "gulp": "~3.6.0",
        "gulp-rename": "~1.2.0",
        "gulp-ruby-sass": "~0.4.3",
        "gulp-load-plugins": "~0.5.1"
    }
}

然后我们可以在gulpfile.js中使用gulp-load-plugins来帮我们加载插件：

var gulp = require('gulp');
//加载gulp-load-plugins插件，并马上运行它
var plugins = require('gulp-load-plugins')();

然后我们要使用gulp-rename和gulp-ruby-sass这两个插件的时候，就可以使用plugins.rename和plugins.rubySass来代替了,也就是原始插件名去掉gulp-前缀，之后再转换为驼峰命名。实质上gulp-load-plugins是为我们做了如下的转换：

plugins.rename = require('gulp-rename');
plugins.rubySass = require('gulp-ruby-sass');

gulp-load-plugins并不会一开始就加载所有package.json里的gulp插件，而是在我们需要用到某个插件的时候，才去加载那个插件。最后要提醒的一点是，因为gulp-load-plugins是通过你的package.json文件来加载插件的，所以必须要保证你需要自动加载的插件已经写入到了package.json文件里，并且这些插件都是已经安装好了的。

（2）重命名js文件： gulp-rename——用来重命名文件流中的文件。用gulp.dest()方法写入文件时，文件名使用的是文件流中的文件名，如果要想改变文件名，那可以在之前用gulp-rename插件来改变文件流中的文件名。

var gulp = require('gulp'),
    rename = require('gulp-rename'),
    uglify = require("gulp-uglify");
 
gulp.task('rename', function () {
    gulp.src('js/jquery.js')
    .pipe(uglify())  //压缩
    .pipe(rename('jquery.min.js')) //会将jquery.js重命名为jquery.min.js
    .pipe(gulp.dest('js'));
    //关于gulp-rename的更多强大的用法请参考https://www.npmjs.com/package/gulp-rename
});

（3）压缩js文件： gulp-uglify——用来压缩js文件，使用的是uglify引擎

var gulp = require('gulp');
var uglify = require('gulp-uglify');
var pump = require('pump');
 
gulp.task('compress', function (cb) {
    pump([
        gulp.src('lib/*.js'),
        uglify(),
        gulp.dest('dist')
    ],
    cb
    );
}); 

（4）压缩css文件： gulp-minify-css——要压缩css文件时可以使用该插件

var gulp = require('gulp');
var cleanCSS = require('gulp-clean-css');
gulp.task('minify-css', function() {
    return gulp.src('styles/*.css')
        .pipe(cleanCSS({compatibility: 'ie8'}))
        .pipe(gulp.dest('dist'));
});

（5）压缩html文件：gulp-htmlmin——用来压缩html文件

var gulp = require('gulp');
var htmlmin = require('gulp-htmlmin');

gulp.task('minify', function() {
    return gulp.src('src/*.html')
        .pipe(htmlmin({collapseWhitespace: true}))
        .pipe(gulp.dest('dist'));
});

（6）js代码检查 jshint：gulp-jshint——用来检查js代码

var gulp = require('gulp'),
    jshint = require("gulp-jshint");
 
gulp.task('jsLint', function () {
    gulp.src('js/*.js')
        .pipe(jshint())     //进行代码检查
        .pipe(jshint.reporter());      // 输出检查结果
});

（7）文件合并：gulp-concat——用来把多个文件合并为一个文件，我们可以用它来合并js或css文件等，这样就能减少页面的http请求数了

var gulp = require('gulp'),
    concat = require("gulp-concat");
 
gulp.task('concat', function () {
    gulp.src('js/*.js')  //要合并的文件
        .pipe(concat('all.js'))  // 合并匹配到的js文件并命名为 "all.js"
        .pipe(gulp.dest('dist/js'));
});

（8）编译Sass： gulp-sass

var gulp = require('gulp'),
    sass = require("gulp-sass");
 
gulp.task('compile-sass', function () {
    gulp.src('sass/*.sass')
        .pipe(sass())
        .pipe(gulp.dest('dist/css'));
});

（9）编译less： gulp-less

var gulp = require('gulp'),
    less = require("gulp-less");
 
gulp.task('compile-less', function () {
    gulp.src('less/*.less')
        .pipe(less())
        .pipe(gulp.dest('dist/css'));
});

（10）图片压缩：gulp-imagemin——可以使用gulp-imagemin插件来压缩jpg、png、gif等图片

var gulp = require('gulp');
var imagemin = require('gulp-imagemin');
var pngquant = require('imagemin-pngquant'); //png图片压缩插件

gulp.task('default', function () {
    return gulp.src('src/images/*')
        .pipe(imagemin({
            progressive: true,
            use: [pngquant()] //使用pngquant来压缩png图片
        }))
        .pipe(gulp.dest('dist'));
});

gulp-imagemin的使用比较复杂一点，而且它本身也有很多插件，可以去它的项目主页看看文档

（11）自动刷新（半自动化构建项目）：gulp-livereload——当代码变化时，它可以帮我们自动刷新页面，该插件最好配合谷歌浏览器来使用，且要安装livereload chrome extension扩展插件,不能下载的请自行FQ

var gulp = require('gulp'),
    less = require('gulp-less'),
    livereload = require('gulp-livereload');

gulp.task('less', function() {
    gulp.src('less/*.less')
        .pipe(less())
        .pipe(gulp.dest('css'))
        .pipe(livereload());
});

gulp.task('watch', function() {
    livereload.listen(); //要在这里调用listen()方法
    gulp.watch('less/*.less', ['less']);
});

（12）创建本地服务器（全自动化构建项目）： gulp-connect——集成了自动刷新（livereload）

gulp.task('server',function(){     //注册全自动监视任务
    $.connect.server({
        root:'dist',//服务器的根目录
        port:8080, //服务器的地址，没有此配置项默认也是 8080
        livereload:true//启用实时刷新的功能
    });
});

（13）CSS自动添加前缀：gulp-autoprefixer——将一些不兼容的css属性添加前缀让各个浏览器兼容

var gulp = require("gulp");
var prefix = require("gulp-autoprefixer");
gulp.task("css",function(){
    gulp.src("./src/css**")
        .pipe(profix({browsers:["last 5 version","iOS > 3","Firefox > 2","Google > 30"]}))
        .pipe(gulp.dest("./dist/css"));
});

（14）ES6转ES5：gulp-babel——为了让更多浏览器兼容项目，需要将项目中的es6的语法转为es5的语法

const babel = require('gulp-babel')
gulp.task('js',function(){
    return gulp.src('./src/js/**')
        .pipe(babel({presets:['es2015']// 必须要有这个参数，否则会报错}))
        .pipe(uglify()).pipe(gulp.dest('./dist/js'))
})

（15）清除目标文件夹：gulp-clean——如果每次打包的时候起不一样的名字，会造成有些文件没有用，但是还占据空间。所以每次在打包之前应该先将之前的文件夹情空，然后再打包

gulp.task('clean',function(){
    return gulp.src('./dist')
        .pipe(clean())
})