首页 > 代码库 > 前端构建工具gulp的使用
前端构建工具gulp的使用
前言:之前一直说着做项目的时候要用gulp ,webpack,结果实习后一直用thinkphp之后就不怎么接触,不会用gulp/webpack,总觉得不是一个合格的前端开发工作者呀!
最近做毕设用的是nodejs 的express,gulp使用的是nodejs中stream来读取和操作数据,所以有nodejs的基础的话,gulp非常容易理解
一,gulp的安装
首先要确保安装好了nodejs的环境,然后以全局的方式安装gulp
npm install -g gulp
全局安装后,还要在每个要使用gulp的项目中再安装一次gulp,把目录切换到安装的目录中
npm install gulp
如果想在安装的时候把gulp写进项目package.json文件的依赖中,则可以加上--save-dev:
npm install --save-dev gulp
二,gulp的使用
1,首先新建一个gulpfile.js的文件放在项目的目录中
我们在文件中定义一个默认的任务
1 var gulp = require(‘gulp‘); 2 gulp.task(‘default‘,function(){ 3 console.log(‘hello world‘); 4 });
此时我们的目录结构是这样子的:
|----gulpfile.js
|----node-modules
| |----gulp
|----package.json
2,运行gulp
windows下cmd中切换到项目目录下
gulp 任务名
如果没有指定任务名的话,就会执行default默认的任务
三,gulp的API
1,gulp.src()
在Gulp中,使用的是Nodejs中的stream(流),首先获取到需要的stream,然后可以通过stream的pipe()
方法把流导入到你想要的地方,比如Gulp的插件中,经过插件处理后的流又可以继续导入到其他插件中,当然也可以把流写入到文件中。所以Gulp是以stream为媒介的,它不需要频繁的生成临时文件.
gulp.src()方法是用来获取流的但要注意这个流里的内容不是原始的文件流,而是一个虚拟文件对象流(Vinyl files),这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息。用这个方法来读取你需要操作的文件
语法如下:
gulp.src(globs[, options])
globs参数是文件匹配模式(类似正则表达式),用来匹配文件路径(包括文件名),当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时,该参数可以为一个数组。
options为可选参数。通常情况下我们不需要用到。
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
当有多种匹配模式时可以使用数组
gulp.src([‘js/*.js‘,‘css/*.css‘,‘*.html‘])
使用数组的方式还有一个好处就是可以很方便的使用排除模式,在数组中的单个匹配模式前加上!
即是排除模式,它会在匹配的结果中排除这个匹配,要注意一点的是不能在数组中的第一个元素中使用排除模式
1 gulp.src([*.js,‘!b*.js‘]) //匹配所有js文件,但排除掉以b开头的js文件 2 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
2,glup.dest()
gulp.dest()方法是用来写文件的,其语法为:
gulp.dest(path[,options])
path为写入文件的路径
options为一个可选的参数对象,通常我们不需要用到
这个方法我们需要理解好传入的路径参数与最终生成的文件的关系。
gulp的使用流程一般是这样子的:首先通过gulp.src()
方法获取到我们想要处理的文件流,然后把文件流通过pipe方法导入到gulp的插件中,最后把经过插件处理后的流再通过pipe方法导入到gulp.dest()
中,gulp.dest()
方法则把流中的内容写入到文件中,这里首先需要弄清楚的一点是,我们给gulp.dest()
传入的路径参数,只能用来指定要生成的文件的目录,而不能指定生成文件的文件名,它生成文件的文件名使用的是导入到它的文件流自身的文件名,所以生成的文件名是由导入到它的文件流决定的,即使我们给它传入一个带有文件名的路径参数,然后它也会把这个文件名当做是目录名,例如:
1 var gulp = require(‘gulp‘); 2 3 gulp.src(‘script/jquery.js‘) 4 5 .pipe(gulp.dest(‘dist/foo.js‘)); 6 7 //最终生成的文件路径为 dist/foo.js/jquery.js,而不是dist/foo.js
要想改变文件名,可以使用插件gulp-rename
gulp.dest(path)
生成的文件路径是我们传入的path参数后面再加上gulp.src()
中有通配符开始出现的那部分路径。
1 var gulp = reruire(‘gulp‘); //有通配符开始出现的那部分路径为 **/*.js 2 3 gulp.src(‘script/**/*.js‘) .pipe(gulp.dest(‘dist‘)); //最后生成的文件路径为 dist/**/*.js 4 5 //如果 **/*.js 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js
3,gulp.task()
gulp.task
方法用来定义任务,内部使用的是Orchestrator,其语法为:
gulp.task(name[, deps], fn)
name 为任务名
deps 是当前定义的任务需要依赖的其他任务,为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖,则可省略这个参数
fn 为任务函数,我们把任务要执行的代码都写在里面。该参数也是可选的。
1 gulp.task(‘mytask‘, [‘array‘, ‘of‘, ‘task‘, ‘names‘], function() {//定义一个有依赖的任务 2 3 // Do something 4 5 });
执行多个任务时怎么控制任务执行的顺序
//只要执行default任务,就相当于把one,two,three这三个任务执行了
gulp.task(‘default‘,[‘one‘,‘two‘,‘three‘]);
如果任务相互之间没有依赖,任务会按你书写的顺序来执行,如果有依赖的话则会先执行依赖的任务。
是如果某个任务所依赖的任务是异步的,就要注意了,gulp并不会等待那个所依赖的异步任务完成,而是会接着执行后续的任务。例如:
1 gulp.task(‘one‘,function(cb){ 2 var stream = gulp.src(‘client/**/*.js‘) 3 .pipe(dosomething()) //dosomething()中有某些异步操作 4 .pipe(gulp.dest(‘build‘)); 5 return stream; 6 }); 7 gulp.task(‘two‘,[‘one‘],function(){ 8 console.log(‘two is done‘); 9 });
上面的例子中我们执行two任务时,会先执行one任务,但不会去等待one任务中的异步操作完成后再执行two任务,而是紧接着执行two任务。所以two任务会在one任务中的异步操作完成之前就执行了。
那如果我们想等待异步任务中的异步操作完成后再执行后续的任务,该怎么做呢?
有三种方法可以实现:
第一:在异步操作完成后执行一个回调函数来通知gulp这个异步任务已经完成,这个回调函数就是任务函数的第一个参数。
1 gulp.task(‘one‘,function(cb){ 2 //cb为任务函数提供的回调,用来通知任务已经完成 3 //one是一个异步执行的任务 4 setTimeout(function(){ 5 console.log(‘one is done‘); 6 cb(); //执行回调,表示这个异步任务已经完成 7 },5000); 8 }); 9 //这时two任务会在one任务中的异步操作完成后再执行 10 gulp.task(‘two‘,[‘one‘],function(){ 11 console.log(‘two is done‘); 12 });
第二:定义任务时返回一个流对象。适用于任务就是操作gulp.src获取到的流的情况。
gulp.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 var Q = require(‘q‘); //一个著名的异步处理的库 https://github.com/kriskowal/q 2 gulp.task(‘one‘,function(cb){ 3 var deferred = Q.defer(); 4 // 做一些异步操作 5 setTimeout(function() { 6 deferred.resolve(); 7 }, 5000); 8 return deferred.promise; 9 }); 10 11 gulp.task(‘two‘,[‘one‘],function(){ 12 console.log(‘two is done‘); 13 });
4,gulp.watch()
gulp.watch()
用来监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等。其语法为
gulp.watch(glob[, opts], tasks)
glob 为要监视的文件匹配模式,规则和用法与gulp.src()
方法中的glob
相同。
opts 为一个可选的配置对象,通常不需要用到
tasks 为文件变化后要执行的任务,为一个数组
1 gulp.task(‘uglify‘,function(){ 2 //do something 3 }); 4 gulp.task(‘reload‘,function(){ 5 //do something 6 }); 7 gulp.watch(‘js/**/*.js‘, [‘uglify‘,‘reload‘]);
gulp.watch()
还有另外一种使用方式:
gulp.watch(glob[, opts, cb])
glob和opts参数与第一种用法相同
cb参数为一个函数。每当监视的文件发生变化时,就会调用这个函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息,type
属性为变化的类型,可以是added
,changed
,deleted
;path
属性为发生变化的文件的路径
1 gulp.watch(‘js/**/*.js‘, function(event){ 2 console.log(event.type); //变化类型 added为新增,deleted为删除,changed为改变 3 console.log(event.path); //变化的文件的路径 4 });
博客转载:http://www.cnblogs.com/2050/p/4198792.html
前端构建工具gulp的使用