gulp详细入门教程

1、gulp简介

    1.gulp是什么？

      gulp是前端开发过程当中一种基于流的代码构建工具，是自动化项目的构建利器；它不只能对网站资源进行优化，并且在开发过程当中不少重复的任务可以使用正确的工具自动完成；使用它，不只能够很愉快的编写代码，并且大大提升咱们的工做效率。

      gulp是基于Nodejs的自动任务运行器， 它能自动化地完成 javascript、coffee、sass、less、html/image、css 等文件的测试、检查、合并、压缩、格式化、浏览器自动刷新、部署文件生成，并监听文件在改动后重复指定的这些步骤。在实现上，她借鉴了Unix操做系统的管道（pipe）思想，前一级的输出，直接变成后一级的输入，使得在操做上很是简单。经过本文，咱们将学习如何使用Gulp来改变开发流程，从而使开发更加快速高效。

      gulp 和 grunt 很是相似，但相比于 grunt 的频繁 IO 操做，gulp 的流操做，能更快地更便捷地完成构建工做。

     2.核心概念：流

      流，简单来讲就是创建在面向对象基础上的一种抽象的处理数据的工具。在流中，定义了一些处理数据的基本操做，如读取数据，写入数据等，程序员是对流进行全部操做的，而不用关心流的另外一头数据的真正流向。流不但能够处理文件，还能够处理动态内存、网络数据等多种数据形式。

      而gulp正是经过流和代码优于配置的策略来尽可能简化任务编写的工做。这看起来有点“像jQuery”的方法，把动做串起来建立构建任务。早在Unix的初期，流就已经存在了。流在Node.js生态系统中也扮演了重要的角色，相似于*nix将几乎全部设备抽象为文件同样，Node将几乎全部IO操做都抽象成了stream的操做。所以用gulp编写任务也可看做是用Node.js编写任务。当使用流时，gulp去除了中间文件，只将最后的输出写入磁盘，整个过程所以变得更快。

     3.特色    

      易于使用

　　      经过代码优于配置的策略，gulp 让简单的任务简单，复杂的任务可管理。

      构建快速

　　      利用 Node.js 流的威力，你能够快速构建项目并减小频繁的 IO 操做。

      易于学习

　　      经过最少的 API，掌握 gulp 绝不费力，构建工做尽在掌握：如同一系列流管道。

      插件高质

　　      gulp 严格的插件指南确保插件如你指望的那样简洁高质得工做。

     4.安装 

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

npm install -g gulp

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

npm install gulp

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

npm install --save-dev gulp

      这样就完成了gulp的安装，接下来就能够在项目中应用gulp了。

     5.gulp的使用

      一、创建gulpfile.js文件

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

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

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

      

      2 运行gulp任务

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

2、 gulp api

     1.工做方式

      在介绍gulp API以前，咱们首先来讲一下gulp.js工做方式。在gulp中，使用的是Nodejs中的stream(流)，首先获取到须要的stream，而后能够经过stream的pipe()方法把流导入到你想要的地方，好比gulp的插件中，通过插件处理后的流又能够继续导入到其余插件中，固然也能够把流写入到文件中。因此gulp是以stream为媒介的，它不须要频繁的生成临时文件，这也是咱们应用gulp的一个缘由。

　　gulp的使用流程通常是：首先经过gulp.src()方法获取到想要处理的文件流，而后把文件流经过pipe方法导入到gulp的插件中，最后把通过插件处理后的流再经过pipe方法导入到gulp.dest()中，gulp.dest()方法则把流中的内容写入到文件中。例如：

var gulp = require('gulp');
gulp.src('script/jquery.js')         // 获取流的api
    .pipe(gulp.dest('dist/foo.js')); // 写放文件的api

     2.globs的匹配规则

      咱们重点说说gulp用到的globs的匹配规则以及一些文件匹配技巧，咱们将会在后面用到这些规则。

　　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

     3.src：获取流

      gulp.src()方法正是用来获取流的，但要注意这个流里的内容不是原始的文件流，而是一个虚拟文件对象流(Vinyl files)，这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息。其语法为：

gulp.src(globs[, options]);

      globs参数是文件匹配模式(相似正则表达式)，用来匹配文件路径(包括文件名)，固然这里也能够直接指定某个具体的文件路径。当有多个匹配模式时，该参数能够为一个数组;类型为String或 Array。当有多种匹配模式时可使用数组

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

options为可选参数。如下为options的选项参数:

options.buffer

类型： Boolean 默认值： true

　　若是该项被设置为 false，那么将会以 stream 方式返回 file.contents 而不是文件 buffer 的形式。这在处理一些大文件的时候将会颇有用。

      注意：插件可能并不会实现对 stream 的支持。

options.read

类型： Boolean 默认值： true

若是该项被设置为 false， 那么 file.contents 会返回空值（null），也就是并不会去读取文件。

options.base

类型： String ， 设置输出路径以某个路径的某个组成部分为基础向后拼接。

如, 请想像一下在一个路径为 client/js/somedir 的目录中，有一个文件叫 somefile.js ：

gulp.src('client/js/**/*.js') // 匹配 'client/js/somedir/somefile.js' 如今 `base` 的值为 `client/js/`
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 写入 'build/somedir/somefile.js' 将`client/js/`替换为build
 
gulp.src('client/js/**/*.js', { base: 'client' }) // base 的值为 'client'
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 写入 'build/js/somedir/somefile.js' 将`client`替换为build

     4.dest：写文件

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

gulp.dest(path[,options])

path为写入文件的路径；

options为一个可选的参数对象，如下为选项参数：

options.cwd

类型： String 默认值： process.cwd()

输出目录的 cwd 参数，只在所给的输出目录是相对路径时候有效。

options.mode

类型： String 默认值： 0777

八进制权限字符，用以定义全部在输出目录中所建立的目录的权限。

var gulp = require('gulp');
gulp.src('script/jquery.js')　       // 获取流
    .pipe(gulp.dest('dist/foo.js')); // 写放文件

      下面再说说生成的文件路径与咱们给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.dest()把文件流写入文件后，文件流仍然能够继续使用。

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

     6.task：定义任务

      gulp.task方法用来定义任务，其语法为：

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

name 为任务名；

deps 是当前定义的任务须要依赖的其余任务，为一个数组。当前定义的任务会在全部依赖的任务执行完毕后才开始执行。若是没有依赖，则可省略这个参数；

fn 为任务函数，咱们把任务要执行的代码都写在里面。该参数也是可选的。

当你定义一个简单的任务时，须要传入任务名字和执行函数两个属性。

gulp.task('greet', function () {
   console.log('Hello world!');
});

      执行gulp greet的结果就是在控制台上打印出“Hello world”。

　　你也能够定义一个在gulp开始运行时候默认执行的任务，并将这个任务命名为“default”：

gulp.task('default', function () {
   // Your default task
});

      前面已经介绍了gulp.task的语法，可是当有多个任务时，须要知道怎么来控制任务的执行顺序。

　　能够经过任务依赖来实现。例如我想要执行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是一个异步执行的任务
    exec('', function (err) {
        setTimeout(function () {
            if (err) {
                return cb(err);
            }
            console.log('one is finish');
            cb();  //执行回调，表示这个异步任务已经完成
        }, 5000)
    });
});

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

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

gulp.task('one',function(cb){
  var stream = gulp.src('client/**/*.js')
      .pipe(exec()) //exec()中有某些异步操做
      .pipe(gulp.dest('build'));
    return stream;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});

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

var Q = require('q');
gulp.task('one', function() {
  var deferred = Q.defer();
 
  // 执行异步的操做
  setTimeout(function() {
    deferred.resolve();
  }, 1);
  return deferred.promise;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});

3、写本身的gulp任务

     1.项目需求

      咱们将建立一个本身的gulp，具体的需求是经过gulp把咱们本身所编写的JS文件合并压缩、CSS文件进行压缩后，而且生成新的文件。咱们所须要的插件为：gulp-minify-css gulp-concat gulp-uglify gulp-rename 以下图所示，完成后的项目目录结构：

     2.安装插件

      根据咱们项目的需求，安装所须要的插件，能够经过"npm install 插件名" 来安装插件

      而后打开gulpfile.js，将咱们所用到的插件引用到咱们项目中，代码以下:

var gulp = require('gulp'),
    minifycss = require('gulp-minify-css'),  //CSS压缩
    concat = require('gulp-concat'),         // 文件合并
    uglify = require('gulp-uglify'),         //js压缩插件
    rename = require('gulp-rename');         // 重命名

     3.编写任务代码

      1.压缩css

gulp.task('minifycss', function() {
    return gulp.src('src/css/*.css')         //压缩的文件
        .pipe(minifycss())                   //执行压缩
        .pipe(gulp.dest('dist/css'));        //输出文件夹
});

      2.JS 合并压缩

gulp.task('minifyjs', function() {
    return gulp.src('src/js/*.js')
        .pipe(concat('all.js'))               //合并全部js到main.js
        .pipe(gulp.dest('dist/js'))           //输出main.js到文件夹
        .pipe(rename({suffix: '.min'}))       //rename压缩后的文件名
        .pipe(uglify())                       //压缩
        .pipe(gulp.dest('dist/js'));          //输出
});

      3.将以上两个任务合并为一个任务

gulp.task('build', ['minifycss', 'minifyjs']);

      4.监视文件的变化，自动执行任务

// 监视文件的变化，当文件有更新时执行build任务
gulp.task('watch', function () {
    gulp.watch(['src/js/*.js', 'src/css/*.css'], ['build']);
});

      5.定义默认任务

gulp.task('default', ['build', 'watch']);

     4.执行任务

      在命令行中先转到gulp-demo目录下，就能够输入gulp命令来运行本项目了，刷新gulp-demo目录看看会出现什么结果呢。运行完成后的目录以下图：

      运行过程当中的消息以下图所示：

      至此，整个gulp教程结束，同时附上gulp手册。

      手册1    手册2