安装 Node 环境:
可以直接到官网下载安装包安装:https://nodejs.org/
因为国内特殊网络环境,推荐使用cnpm作为替换npm包管理工具。
安装 cnpm:1
npm install -g cnpm --registry=https://registry.npm.taobao.org
用cnpm 安装模块:1
cnpm install [name]
1、gulp安装
首先确保你已经正确安装了nodejs环境。然后以全局方式安装gulp:1
npm install -g gulp
全局安装gulp后,还需要在每个要使用gulp的项目中都单独安装一次。把目录切换到你的项目文件夹中,然后在命令行中执行:
1 | npm install gulp |
如果想在安装的时候把gulp写进项目package.json文件的依赖中,则可以加上–save-dev:
1 | npm install --save-dev gulp |
2、开始使用gulp
2.1 建立gulpfile.js文件
在gulp中需要一个文件作为它的主文件gulpfile.js
。新建一个文件名为gulpfile.js
的文件,然后放到你的项目目录中。之后要做的事情就是在gulpfile.js
文件中定义我们的任务了。下面是一个最简单的gulpfile.js
文件内容示例,它定义了一个默认的任务。
1 | var gulp = require('gulp'); |
2.2 运行gulp任务
要运行gulp任务,只需切换到存放gulpfile.js
文件的目录,然后在命令行中执行gulp命令就行了,gulp后面可以加上要执行的任务名,例如gulp task1
,如果没有指定任务名,则会执行任务名为default
的默认任务。
3、gulp的API介绍
使用gulp,仅需知道4个API即可:gulp.task()
,gulp.src()
,gulp.dest()
,gulp.watch()
,所以很容易就能掌握,但有几个地方需理解透彻才行,我会在下面一一说明。为了避免出现理解偏差,建议先看一遍官方文档。
3.1 gulp.src()
gulp.src()
方法是用来获取流的,但要注意这个流里的内容不是原始的文件流,而是一个虚拟文件对象流(Vinyl files),这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息,这个我们暂时不用去深入理解,你只需简单的理解可以用这个方法来读取你需要操作的文件就行了。其语法为:1
gulp.src(globs[, options])
globs 参数是文件匹配模式(类似正则表达式),用来匹配文件路径(包括文件名),当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时,该参数可以为一个数组。
options 为可选参数。通常情况下我们不需要用到。
下面我们重点说说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)
下面以一系列例子来加深理解
src/a.js
只能匹配src/a.js
*
能匹配a.js
,x.y
,abc
,abc/
, 但不能匹配a/b.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
{}
能匹配多个属性src/{a,b}.js
(包含a.js
和b.js
文件)src/*.{jpg,png,gif}
(src下的所有jpg/png/gif文件);!
排除文件!src/a.js
(不包含src
下的a.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
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
当有多种匹配模式时可以使用数组
1 | //使用数组的方式来匹配多种文件 |
使用数组的方式还有一个好处就是可以很方便的使用排除模式,在数组中的单个匹配模式前加上!即是排除模式,它会在匹配的结果中排除这个匹配,要注意一点的是不能在数组中的第一个元素中使用排除模式1
2gulp.src([*.js,'!b*.js']) //匹配所有js文件,但排除掉以b开头的js文件
gulp.src(['!b*.js',*.js]) //不会排除任何文件,因为排除模式不能出现在数组的第一个元素中
3.2 gulp.dest()
gulp.dest()方法是用来写文件的,其语法为:
1 | gulp.dest(path[,options]) |
path 为写入文件的路径
options 为一个可选的参数对象
要想使用好gulp.dest()
这个方法,就要理解给它传入的路径参数与最终生成的文件的关系。
gulp的使用流程一般是这样子的:首先通过gulp.src()方法获取到我们想要处理的文件流,然后把文件流通过pipe
方法导入到gulp的插件中,最后把经过插件处理后的流再通过pipe
方法导入到gulp.dest()
中,gulp.dest()
方法则把流中的内容写入到文件中,这里首先需要弄清楚的一点是,我们给gulp.dest()传入的路径参数,只能用来指定要生成的文件的目录,而不能指定生成文件的文件名,它生成文件的文件名使用的是导入到它的文件流自身的文件名,所以生成的文件名是由导入到它的文件流决定的,即使我们给它传入一个带有文件名的路径参数,然后它也会把这个文件名当做是目录名,例如:
1 | var gulp = require('gulp'); |
要想改变文件名,可以使用插件gulp-rename
下面说说生成的文件路径与我们给gulp.dest()
方法传入的路径参数之间的关系。
gulp.dest(path)生成的文件路径是我们传入的path参数后面再加上gulp.src()中有通配符开始出现的那部分路径。例如:
1 | var gulp = reruire('gulp'); |
通过指定gulp.src()
方法配置参数中的base
属性,我们可以更灵活的来改变gulp.dest()
生成的文件路径。
当我们没有在gulp.src()
方法中配置base
属性时,base
的默认值为通配符开始出现之前那部分路径,例如:
1 | gulp.src('app/src/**/*.css') //此时base的值为 app/src |
上面我们说的gulp.dest()
所生成的文件路径的规则,其实也可以理解成,用我们给gulp.dest()
传入的路径替换掉gulp.src()
中的base
路径,最终得到生成文件的路径。
1 | gulp.src('app/src/**/*.css') //此时base的值为app/src,也就是说它的base路径为app/src |
所以改变base
路径后,gulp.dest()
生成的文件路径也会改变1
2
3
4
5
6
7gulp.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
,其语法为:1
gulp.task(name[, deps], fn)
name 为任务名
deps 是当前定义的任务需要依赖的其他任务,为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖,则可省略这个参数
fn 为任务函数,我们把任务要执行的代码都写在里面。该参数也是可选的。
1 | gulp.task('mytask', ['array', 'of', 'task', 'names'], function() { //定义一个有依赖的任务 |
gulp.task()
这个API没什么好讲的,但需要知道执行多个任务时怎么来控制任务执行的顺序。
gulp中执行多个任务,可以通过任务依赖来实现。例如我想要执行one
,two
,three
这三个任务,那我们就可以定义一个空的任务,然后把那三个任务当做这个空的任务的依赖就行了:
1 | //只要执行default任务,就相当于把one,two,three这三个任务执行了 |
如果任务相互之间没有依赖,任务会按你书写的顺序来执行,如果有依赖的话则会先执行依赖的任务。
但是如果某个任务所依赖的任务是异步的,就要注意了,gulp并不会等待那个所依赖的异步任务完成,而是会接着执行后续的任务。例如:
1 | gulp.task('one',function(){ |
上面的例子中我们执行two任务时,会先执行one任务,但不会去等待one任务中的异步操作完成后再执行two任务,而是紧接着执行two任务。所以two任务会在one任务中的异步操作完成之前就执行了。
那如果我们想等待异步任务中的异步操作完成后再执行后续的任务,该怎么做呢?
有三种方法可以实现:
第一:在异步操作完成后执行一个回调函数来通知gulp这个异步任务已经完成,这个回调函数就是任务函数的第一个参数。
1 | gulp.task('one',function(cb){ //cb为任务函数提供的回调,用来通知任务已经完成 |
第二:定义任务时返回一个流对象。适用于任务就是操作gulp.src获取到的流的情况。1
2
3
4
5
6
7
8
9
10gulp.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对象,例如1
2
3
4
5
6
7
8
9
10
11
12
13var 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');
});
注意: 默认的,task 将以最大的并发数执行,也就是说,gulp 会一次性运行所有的 task 并且不做任何等待。如果你想要创建一个序列化的 task 队列,并以特定的顺序执行,你需要做两件事:
- 给出一个提示,来告知 task 什么时候执行完毕
- 并且再给出一个提示,来告知一个 task 依赖另一个 task 的完成。
对于这个例子,让我们先假定你有两个 task,one
和 two
,并且你希望它们按照这个顺序执行:
1.在
one
中,你加入一个提示,来告知什么时候它会完成:可以再完成时候返回一个callback
,或者返回一个promise
或stream
,这样系统会去等待它完成。2.在
two
中,你需要添加一个提示来告诉系统它需要依赖第一个task
完成。
因此,这个例子的实际代码将会是这样:
1 | var gulp = require('gulp'); |
gulp.task()就这些了,主要是要知道当依赖是异步任务时的处理。
拓展内容:orchestrator
gulp的任务系统是基于orchestrator
。提供了start
, stop
, err
, task_start
, task_stop
, task_err
, task_not_found
, task_recursion
几个事件。
可以像下面这样监听:
1 | var gulp = require('gulp'); |
也有现成的插件gulp-plumber来监听任务异常。
3.4 gulp.watch()
gulp.watch()
用来监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等。其语法为
1 | gulp.watch(glob[, opts], tasks) |
glob 为要监视的文件匹配模式,规则和用法与gulp.src()方法中的glob相同。
opts 为一个可选的配置对象,通常不需要用到
tasks 为文件变化后要执行的任务,为一个数组
1 | gulp.task('uglify',function(){ |
gulp.watch()
还有另外一种使用方式:
1 | gulp.watch(glob[, opts, cb]) |
glob 和 opts 参数与第一种用法相同
cb 参数为一个函数。每当监视的文件发生变化时,就会调用这个函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息,type
属性为变化的类型,可以是added
, changed
, deleted
;path
属性为发生变化的文件的路径1
2
3
4gulp.watch('js/**/*.js', function(event){
console.log(event.type); //变化类型 added为新增,deleted为删除,changed为改变
console.log(event.path); //变化的文件的路径
});
4、一些常用的gulp插件
插件具体使用方法大家可以直接npm或者github 上搜索技术文档。
gulp-load-plugins 从package.json读取中加载插件。
gulp-rename 重命名。
gulp-concat 文件合并。
gulp-uglify js文件压缩。
gulp-minify-css css文件压缩。
gulp-minify-html html文件压缩。
gulp-jshint js代码检查。
gulp-sass sass编译。
gulp-ruby-sass sass编译。
gulp-autoprefixer css后处理 (加前缀)。
gulp-size 显示文件大小。
gulp-sourcemaps Source map 。
gulp-header 添加头部声明。
gulp-util 控制台提示。
gulp-imagemin 图片压缩。
gulp-tinypng tinypng 图片压缩。
gulp-imageisux 腾讯智图 图片压缩 (webp)。
browser-sync 文件改动实时刷新浏览器。
del 删除文件。
browserify 模块化(提供在浏览器中使用require()得功能)。
gulp-babel ES6 转 ES5。
本文参考:
http://www.cnblogs.com/2050/p/4198792.html
http://www.gulpjs.com.cn/docs/api/
http://markgoodyear.com/2014/01/getting-started-with-gulp/