学习前端自动化构建工具Gulp

Gulp是什么？

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

gulp是基于NodeJs的自动任务运行器，她能自动化的完成JavaScript、coffee、sass、less、html/img、css等文件的测试、检查、合并、压缩、格式化、浏览器自动刷新、部署文件生成，并监听文件改动后重复这些步骤。在实现上，她借鉴了Unix操做系统的管道思想，前一级的输出，直接变成后一级的输入，使得在操做上很是简单。

什么是流？

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

而gulp正是经过流和代码优于配置的策略来尽可能简化任务编写的工做。当使用流时，gulp去除了中间文件，只将最后的输出写入磁盘，整个过程所以变得更快。

Gulp的特色

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

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

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

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

安装

首先全局安装gulp：

npm install -g gulp

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

npm install gulp

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

npm install --save-dev gulp

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

gulp的使用

1、创建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的默认任务。

工做方式

在介绍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

接下来咱们将为你们讲解gulp api，包括gulp.src(),gulp.task(),gulp.dest(),gulp.watch(),gulp.run()。

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

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()把文件流写入文件后，文件流仍然能够继续使用。

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

task

gulp.task方法用来定义任务，内部使用的是Orchestrator(用于排序、执行任务和最大并发依赖关系的模块)，其语法为：

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(){
    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');
});

run

gulp.run()表示要执行的任务。可能会使用单个参数的形式传递多个任务。以下代码：

gulp.task('end',function(){
gulp.run('task1','task3','task2');
});

注意：任务是尽量多的并行执行的，而且可能不会按照指定的顺序运行。

插件安装

在咱们编写gulp代码时候，须要用到一些gulp的插件，能够经过npm install --save-dev 插件名称 来安装。以下代码来安装自动加载插件：

npm install --save-dev gulp-load-plugins

要使用gulp的插件，首先得用require来把插件加载进来。

var gulp=require('gulp'),
    plugins=require('gulp-load-plugins')(),
    uglify = require('gulp-uglify'),
    minifyHtml = require('gulp-minify-html'),
    rename = require('gulp-rename');

gulp的插件有不少种，咱们将在本节内容中为同窗们讲解几个插件的用法。如还想了解更多插件，请查阅相关资料。

自动加载

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-rename插件用来重命名文件流中的文件。用gulp.dest()方法写入文件时，文件名使用的是文件流中的文件名，若是要想改变文件名，那能够在以前用gulp-rename插件来改变文件流中的文件名。

var gulp = require('gulp'),
    rename = require('gulp-rename'),
    uglify = require("gulp-uglify");
 
gulp.task('rename', function () {
    gulp.src('src/1.js')
    .pipe(uglify())           //压缩
    .pipe(rename('1.min.js')) //会将1.js重命名为1.min.js
    .pipe(gulp.dest('js'));
});

js文件压缩

gulp-uglify插件用来压缩js文件。

var gulp = require('gulp'),
    uglify = require("gulp-uglify");
 
gulp.task('minify-js', function () {
    gulp.src('src/*.js')          // 要压缩的js文件
    .pipe(uglify())              //使用uglify进行压缩
    .pipe(gulp.dest('dist/js')); //压缩后的路径
});

css文件压缩

gulp-minify-css插件用来压缩css文件。

var gulp = require('gulp'),
    minifyCss = require("gulp-minify-css");
 
gulp.task('minify-css', function () {
    gulp.src('src/*.css') // 要压缩的css文件
    .pipe(minifyCss())    //压缩css
    .pipe(gulp.dest('dist/css'));
});

html文件压缩

gulp-minify-html插件用来压缩html文件。

var gulp = require('gulp'),
    minifyHtml = require("gulp-minify-html");
 
gulp.task('minify-html', function () {
    gulp.src('src/*.html') // 要压缩的html文件
    .pipe(minifyHtml())    //压缩
    .pipe(gulp.dest('dist/html'));
});

js代码检查

使用gulp-jshint插件，用来检查js代码。

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

文件合并

使用gulp-concat插件，用来把多个文件合并为一个文件,咱们能够用它来合并js或css文件等。

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

图片压缩

可使用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-livereload插件，当代码变化时，它能够帮咱们自动刷新页面。

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']);
});

好了，到这里gulp的基本用法都已经讲解完了，最重要的仍是在项目中多多使用才能尽快掌握。本文来源于笔者学习汇智网课堂的学习笔记。原课程做者：草莓。