这是一张从gulp官网裁剪下来的一张图。我们可以很直观的知道gulp的四大特点。不多作解释,我们会在这篇文章中的探索中感受到它的这些特性。
在一起探索gulp之前,我们不妨来考虑一些问题
流的自动化构建工具是什么意思
在node
中,流是操作文件时一个重要的概念。gulp
是基于流进行操作的,整个插件都是通过pipe()
函数来赋予。gulp
的使用流程一般是这样子的:首先通过gulp.src()
方法获取到我们想要处理的文件流,然后把文件流通过pipe
方法导入到gulp
的插件中,最后把经过插件处理后的流再通过pipe
方法导入到gulp.dest()
中,gulp.dest()
方法则把流中的内容写入到文件中。
这里的“流”我们也可以理解为「工作流」,是业务过程的自动化,前端工作流,就是把前端业务中的一些工作用计算机工具自动完成。Gulp
则是一种前端工作流的工具,它可以解决前端中很多其实并不需要人力参与的工作,例如:
- 压缩静态资源
- 变更静态资源
- 给静态资源添加md5
- 修改预处理样式后自动编译(SASS,Less)
- 合并雪碧图
- 自动刷新浏览器
       这类工作还可以列举很多,在前端工作流出现之前,这些工作都由人力完成,而这些工作往往比写业务本身更加费时,而交给了 Gulp
这类工具,则可以释放这些人力。
gulp与经常提到的grunt、webpack有什么区别
- Gulp / Grunt可以理解为帮助前端自动化的工具,用于优化前端工作流程。比如自动刷新页面、combo、压缩css、js、编译less等等。二者的区别可以自行百度,个人推荐Gulp。小项目,零散页,历史项目,结构不复杂,维护难度相对低,模块化要求低,用gulp上手快,任务流清晰易懂。
- webpack 提供的是一个前端模块化的方案,和requirejs类似但又有不同。 webpack设置复杂,更多关注项目整体的配置,因为require everywhere的理念,使得静态资源也变得容易维护,模块化组件化更是爽到飞起。中大型项目的利器。
现在来开始一起学习gulp - 一款基于流的自动化构建工具
1.安装及使用
(1)输入命令 npm install -g gulp
(2)创建一个项目文件夹,当前文件夹下输入命令 npm init
,可以一路回车
(3)当前项目文件下输入命令 npm install gulp --save-dev
(全局安装gulp后,还需要在每个要使用gulp的项目中都单独安装一次)
(4)配置gulpflie.js
文件,作为该项目配置文件,填写以下代码,当前目录下执行gulp
命令,触发这个default
任务
//gulpfile.js
var gulp = require('gulp')
gulp.task('default',function(){
console.log('hello world')
})
2.gulp的API介绍
gulp.task(name[, deps], fn)
gulp.task方法用来定义任务
name
为任务名deps
是当前定义的任务需要依赖的其他任务,为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖,则可省略这个参数fn
为任务函数,我们把任务要执行的代码都写在里面。该参数也是可选的
gulp.task('mytask', ['array', 'of', 'task', 'names'],
function() { //定义一个有依赖的任务
// Do something
})
gulp.src(globs[, options])
globs
参数是文件匹配模式(类似正则表达式),用来匹配文件路径(包括文件名),当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时,该参数可以为一个数组options
为可选参数。通常情况下我们不需要用到下面我们重点说说
Gulp
用到的glob
的匹配规则以及一些文件匹配技巧
例子:
//转换html文件
gulp.task('html', function(){
gulp.src('./src/index.html')
.pipe(connect.reload())
.pipe(gulp.dest('./dist'))//写入命令
})
gulp.dest(path[,options])
gulp.dest()
方法是用来写文件的path
为写入文件的路径options
为一个可选的参数对象,通常我们不需要用到
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.watch(glob[, opts], tasks)
gulp.watch()
用来监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等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插件
1.自动加载插件
使用:gulp-load-plugins
安装:npm install --save-dev gulp-load-plugins
要使用gulp
的插件,首先得用require
来把插件加载进来,如果我们要使用的插件非常多,那我们的gulpfile.js
文件开头可能就会是这个样子的:
var gulp = require('gulp')
//一些gulp插件,abcd这些命名只是用来举个例子
a = require('gulp-a')
b = require('gulp-b')
c = require('gulp-c')
d = require('gulp-d')
e = require('gulp-e')
f = require('gulp-f')
g = require('gulp-g')
//更多的插件...
z = require('gulp-z')
虽然这没什么问题,但会使我们的gulpfile.js
文件变得很冗长,看上去不那么舒服。gulp-load-plugins
插件正是用来解决这个问题。 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-load-plugins
是为我们做了如下的转换
plugins.rename = require('gulp-rename')
plugins.rubySass = require('gulp-ruby-sass')
gulp-load-plugins
并不会一开始就加载所有package.json
里的gulp
插件,而是在我们需要用到某个插件的时候,才去加载那个插件。
最后要提醒的一点是,因为gulp-load-plugins
是通过你的k文件来加载插件的,所以必须要保证你需要自动加载的插件已经写入到了package.json
文件里,并且这些插件都是已经安装好了的。
2.重命名
使用:gulp-rename
安装:npm install --save-dev gulp-rename
用来重命名文件流中的文件。用gulp.dest()
方法写入文件时,文件名使用的是文件流中的文件名,如果要想改变文件名,那可以在之前用gulp-rename
插件来改变文件流中的文件名。
var gulp = require('gulp')
rename = require('gulp-rename')
uglify = require("gulp-uglify")
gulp.task('rename', function () {
gulp.src('js/jquery.js')
.pipe(uglify()) //压缩
.pipe(rename('jquery.min.js')) //会将jquery.js重命名为jquery.min.js
.pipe(gulp.dest('js'))
//关于gulp-rename的更多强大的用法请参考https://www.npmjs.com/package/gulp-rename
})
3.js文件压缩
使用 :gulp-uglify
安装:npm install --save-dev gulp-uglify
用来压缩js文件,使用的是uglify引擎
var gulp = require('gulp')
var uglify = require('gulp-uglify')
var pump = require('pump')
gulp.task('compress', function (cb) {
pump([
gulp.src('lib/*.js')
uglify()
gulp.dest('dist')
],
cb
)
})
4.css文件压缩
使用 :gulp-clean-css
安装:npm install gulp-clean-css --save-dev
要压缩css文件时可以使用该插件
var gulp = require('gulp')
var cleanCSS = require('gulp-clean-css')
gulp.task('minify-css', function() {
return gulp.src('styles/*.css')
.pipe(cleanCSS({compatibility: 'ie8'}))
.pipe(gulp.dest('dist'));
})
5.html文件压缩
使用 :gulp-htmlmin
安装:npm i gulp-htmlmin --save-dev
用来压缩html文件
var gulp = require('gulp')
var htmlmin = require('gulp-htmlmin')
gulp.task('minify', function() {
return gulp.src('src/*.html')
.pipe(htmlmin({collapseWhitespace: true}))
.pipe(gulp.dest('dist'))
})
6.js代码检查
使用 :gulp-jshint
安装:npm install --save-dev gulp-jshint
用来检查js代码
var gulp = require('gulp'),
jshint = require("gulp-jshint")
gulp.task('jsLint', function () {
gulp.src('js/*.js')
.pipe(jshint())
.pipe(jshint.reporter()); // 输出检查结果
})
7.文件合并
使用 :gulp-concat
安装:npm install --save-dev gulp-concat
用来把多个文件合并为一个文件,我们可以用它来合并js或css文件等,这样就能减少页面的http请求数了
var gulp = require('gulp'),
concat = require("gulp-concat")
gulp.task('concat', function () {
gulp.src('js/*.js') //要合并的文件
.pipe(concat('all.js')) // 合并匹配到的js文件并命名为 "all.js"
.pipe(gulp.dest('dist/js'))
})
8.less和sass的编译
less
使用gulp-less
安装:npm install --save-dev gulp-less
var gulp = require('gulp')
less = require("gulp-less")
gulp.task('compile-less', function () {
gulp.src('less/*.less')
.pipe(less())
.pipe(gulp.dest('dist/css'))
})
sass
使用gulp-sass
安装:npm install --save-dev gulp-sass
var gulp = require('gulp')
sass = require("gulp-sass")
gulp.task('compile-sass', function () {
gulp.src('sass/*.sass')
.pipe(sass())
.pipe(gulp.dest('dist/css'))
})
9.图片压缩
可以使用gulp-imagemin
插件来压缩jpg、png、gif等
图片。
安装:npm install --save-dev gulp-imagemin
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-imagemin
的使用比较复杂一点,而且它本身也有很多插件,建议去它的项目主页看看文档
10.自动刷新
使用gulp-livereload
插件,安装:npm install --save-dev gulp-livereload
当代码变化时,它可以帮我们自动刷新页面
该插件最好配合谷歌浏览器来使用,且要安装livereload chrome extension扩展插件,不能下载的请自行FQ。
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'])
})
11.服务器
使用 :gulp-connect
插件
安装 :npm install --save-dev gulp-connect
Gulp plugin to run a webserver (with LiveReload),开服务器,并集成了LiveReload
(自动刷新), 下载这个插件上面的LiverReload
插件就不用再下载了
var gulp = require('gulp')
connect = require('gulp-connect')
gulp.task('connect', function() {
connect.server({
root: 'app',
livereload: true
})
})
以上是关于基础原理了解,简单安装和常用的API及插件学习,需要灵活运用还需要我们在项目中去摸索。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。