前言: 每当我比较闲的时候呢, 我们组长就给我安排学习任务了, 这不, 要求我这两天学习一下gulp这个打包工具, 那么顺便就把学习到的知识点记录下来咯! 以便以后复习使用。这里我就引用一段套话吧, 大家看看就好: gulp是前端开发过程中对代码进行构建的工具,是自动化项目的构建利器;她不仅能对网站资源进行优化,而且在开发过程中很多重复的任务能够使用正确的工具自动完成;使用她,我们不仅可以很愉快的编写代码,而且大大提高我们的工作效率。

  在学习前,先谈谈大致使用 gulp 的步骤,给读者以初步的认识。首先当然是安装nodejs,通过 nodejs 的 npm 全局安装和项目安装 gulp,其次在项目里安装所需要的 gulp 插件,然后新建 gulp 的配置文件gulpfile.js并写好配置信息(定义gulp任务),最后通过命令提示符运行gulp任务即可。

安装 gulp 以及其他依赖

    1. 全局安装 gulp (为了通过它来执行gulp任务)
      1
      2
      3
      4
      5
      // 执行安装命令
      npm install gulp -g

      // 查看版本号
      gulp -v
    1. 新建 package.json 文件

执行命令 npm init
package.json是基于nodejs项目必不可少的配置文件,它是存放在项目根目录的普通json文件;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"name": "test", //项目名称(必须)
"version": "1.0.0", //项目版本(必须)
"description": "This is for study gulp project !", //项目描述(必须)
"homepage": "", //项目主页
"repository": { //项目资源库
"type": "git",
"url": "https://git.oschina.net/xxxx"
},
"author": { //项目作者信息
"name": "surging",
"email": "surging2@qq.com"
},
"license": "ISC", //项目许可协议
"devDependencies": { //项目依赖的插件
"gulp": "^3.8.11",
"gulp-less": "^3.0.0"
}
}
    1. 本地安装 gulp 以及其他插件
1
2
// 执行安装命令
npm install gulp --save-dev

细心的你可能会发现,我们全局安装了gulp,项目也安装了gulp,全局安装gulp是为了执行gulp任务,本地安装gulp则是为了调用gulp插件的功能。

    1. 新建gulpfile.js文件(重要)
      说明:gulpfile.js是gulp项目的配置文件,是位于项目根目录的普通js文件(其实将gulpfile.js放入其他文件夹下亦可)
    1. 运行gulp
      命令提示符执行 gulp 任务名称
      当执行gulp defaultgulp将会调用 default 任务里的所有任务

详解 gulp 的 API

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

  使用 gulp,仅需知道 4 个 API 即可:gulp.task(), gulp.src(), gulp.dest(), gulp.watch(),所以很容易就能掌握,但有几个地方需理解透彻才行。往下看…

gulp.src()

获取文件流。注意这个流里的内容不是原始的文件流,而是一个虚拟文件对象流(Vinyl files),这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息,基本语法为:

1
gulp.src([globs], option)

globs 参数是文件匹配模式(类似正则表达式), 用来匹配文件路径(包括文件名), 当然这里也可直接指定某个具体的文件路径. 当有多个匹配模式时, 该参数可以为一个数组. option 为可选参数, 通常情况下不需要用到.

  • 下面重点介绍gulp常用的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
  • 当有多种匹配模式时可以使用数组:

1
gulp.src(['js/*.js','css/*.css','*.html'])

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

1
2
gulp.src([*.js,'!b*.js']) //匹配所有js文件,但排除掉以b开头的js文件
gulp.src(['!b*.js',*.js]) //不会排除任何文件,因为排除模式不能出现在数组的第一个元素中

此外,还可以使用展开模式。 展开模式以花括号作为定界符,根据它里面的内容,会展开为多个模式,最后匹配的结果为所有展开的模式相加起来得到的结果。展开的例子如下:

  • a{b,c}d 会展开为 abd, acd
  • a{b,}c 会展开为 abc, ac
  • a{0..3}d 会展开为 a0d, a1d, a2d, a3d
  • a{b,c{d,e}f}g 会展开为 abg, acdfg, acefg
  • a{b,c}d{e,f}g 会展开为 abdeg, acdeg, abdeg, abdfg

gulp.dest()

写文件。基本语法为:

1
gulp.dest([path],options)

path为写入文件的路径,options为一个可选的参数对象,通常我们不需要用到。

gulp的使用流程一般是这样子的:首先通过gulp.src()方法获取到我们想要处理的文件流,然后把文件流通过pipe方法导入到gulp的插件中,最后把经过插件处理后的流再通过pipe方法导入到gulp.dest()中,gulp.dest()方法则把流中的内容写入到文件中,这里首先需要弄清楚的一点是,我们给gulp.dest()传入的路径参数,只能用来指定要生成的文件的目录,而不能指定生成文件的文件名,它生成文件的文件名使用的是导入到它的文件流自身的文件名,所以生成的文件名是由导入到它的文件流决定的,即使我们给它传入一个带有文件名的路径参数,然后它也会把这个文件名当做是目录名,例如:

1
2
3
4
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

下面说说生成的文件路径与我们给gulp.dest()方法传入的路径参数之间的关系。
gulp.dest(path) 生成的文件路径是我们传入的path参数后面再加上gulp.src()中有通配符开始出现的那部分路径。例如:

1
2
3
4
5
var gulp = reruire('gulp');
//有通配符开始出现的那部分路径为 **/*.js
gulp.src('script/**/*.js')
.pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/**/*.js
//如果 **/*.js 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js

再举更多一点的例子

1
2
3
4
5
6
7
8
9
10
11
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的默认值为通配符开始出现之前那部分路径,例如:

1
gulp.src('app/src/**/*.css') //此时base的值为 app/src

上面我们说的gulp.dest()所生成的文件路径的规则,其实也可以理解成,用我们给gulp.dest()传入的路径替换掉gulp.src()中的base路径,最终得到生成文件的路径。

1
2
3
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()生成的文件路径也会改变

1
2
3
4
5
6
7
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()把文件流写入文件后,文件流仍然可以继续使用。

gulp.task()

gulp.task方法用来定义任务,内部使用的是Orchestrator,其语法为:

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

name 为任务名。deps 是当前定义的任务需要依赖的其他任务,为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖,则可省略这个参数。fn 为任务函数,我们把任务要执行的代码都写在里面。该参数也是可选的。

1
2
3
gulp.task('mytask', ['array', 'of', 'task', 'names'], function() { //定义一个有依赖的任务
// Do something
});

gulp.task()这个API没什么好讲的,但需要知道执行多个任务时怎么来控制任务执行的顺序。
gulp中执行多个任务,可以通过任务依赖来实现。例如我想要执行one,two,three这三个任务,那我们就可以定义一个空的任务,然后把那三个任务当做这个空的任务的依赖就行了:

1
2
//只要执行default任务,就相当于把one,two,three这三个任务执行了
gulp.task('default',['one','two','three']);

如果任务相互之间没有依赖,任务会按你书写的顺序来执行,如果有依赖的话则会先执行依赖的任务。但是如果某个任务所依赖的任务是异步的,就要注意了,gulp并不会等待那个所依赖的异步任务完成,而是会接着执行后续的任务。例如:

1
2
3
4
5
6
7
8
9
10
11
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这个异步任务已经完成,这个回调函数就是任务函数的第一个参数。

1
2
3
4
5
6
7
8
9
10
11
12
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获取到的流的情况。(常用)

1
2
3
4
5
6
7
8
9
  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
13
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');
});

gulp.task()就这些了,主要是要知道当依赖是异步任务时的处理。

gulp.watch()

监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等。其语法为:

1
gulp.watch([glob], [opts], [tasks])

glob 为要监视的文件匹配模式,规则和用法与gulp.src()方法中的glob相同。opts 为一个可选的配置对象,通常不需要用到。tasks 为文件变化后要执行的任务,为一个数组。

1
2
3
4
5
6
7
gulp.task('uglify',function(){
//do something
});
gulp.task('reload',function(){
//do something
});
gulp.watch('js/**/*.js', ['uglify','reload']);

gulp.watch() 还有另外一种使用方式:

1
gulp.watch([glob], [opts], cb)

glob和opts参数与第一种用法相同。cb参数为一个函数。每当监视的文件发生变化时,就会调用这个函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息,type属性为变化的类型,可以是added,changed,deleted;path属性为发生变化的文件的路径。

1
2
3
4
gulp.watch('js/**/*.js', function(event){
console.log(event.type); //变化类型 added为新增,deleted为删除,changed为改变
console.log(event.path); //变化的文件的路径
});