基于Node.js的自动化工具Gulp

What is gulp?

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

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

流(stream)

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

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

特点

• 易于使用

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

• 构建快速

  利用 Node.js 流的威力，你可以快速构建项目并减少频繁的 IO 操作。

• 易于学习

  通过最少的 API，掌握 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了。

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的默认任务。

3.课程练习环境

(1)在右面的编辑环境中点击【文件管理】，就可以看到我们上图已经为大家创建的目录结构；

(2)然后我们就可以对gulpfile.js文件进行编辑（双击），编辑完成后点击【保存文件】；

(3)最后在终端中转到我们的项目目录，运行gulp命令，这样就可以在终端中查看结果了。

另外，在列出的目录项中，我们可以通过右键来对文件或目录进行操作。

工作方式

在介绍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()。

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 

获取流

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

gulp.src(globs[, options]); 

globs参数是文件匹配模式(类似正则表达式)，用来匹配文件路径(包括文件名)，当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时，该参数可以为一个数组;类型为String或 Array。我们在前一节中已经讲过了globs的匹配规则，这里就不在详述。

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

//使用数组的方式来匹配多种文件 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 

写文件

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

更多示例和在线练习可以去这里看看： http://www.hubwiz.com/course/562089cb1bc20c980538e25b/