经验之谈——gulp使用教程

Posted 2020-09-26 矩阵鱼

gulp的最实用教程

使用gulp编译less、sass、压缩js等常用功能讲解

　　　

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

　　gulp是基于Nodejs的自动任务运行器， 她能自动化地完成 javascript/coffee/sass/less/html/image/css 等文件的的测试、检查、合并、压缩、格式化、浏览器自动刷新、部署文件生成，并监听文件在改动后重复指定的这些步骤。

 

　　在实现上，她借鉴了Unix操作系统的管道（pipe）思想，前一级的输出，直接变成后一级的输入，使得在操作上非常简单。通过本文，我们将学习如何使用Gulp来改变开发流程，从而使开发更加快速高效。

 

  

gulp环境的搭建

学习前，先了解一下大致使用gulp的步骤。先当然是安装nodejs，通过nodejs的npm全局安装和项目安装gulp，其次在项目里安装所需要的gulp插件，然后新建gulp的配置文件gulpfile.js并写好配置信息（定义gulp任务），最后通过命令提示符运行gulp任务即可。

安装nodejs -> 全局安装gulp -> 项目安装gulp以及gulp插件 -> 配置gulpfile.js -> 运行任务。

npm（node package manager）nodejs的包管理器，用于node插件管理（包括安装、卸载、管理依赖等）；

简单介绍gulp在使用过程中常用命令，打开命令提示符执行下列命令（打开方式：window + r 输入cmd回车）：

node -v查看安装的nodejs版本，出现版本号，说明刚刚已正确安装nodejs。PS：未能出现版本号，请尝试注销电脑重试；

npm -v查看npm的版本号，npm是在安装nodejs时一同安装的nodejs包管理器.

cd定位到目录，用法：cd + 路径 ；

dir列出文件列表；

cls清空命令提示符窗口内容。

按下win+R键，键入cmd，执行如下代码：

npm install <name> [-g] [--save-dev]

 

--save：将保存配置信息至package.json（package.json是nodejs项目配置文件）；
-dev：保存至package.json的devDependencies节点，不指定-dev将保存至dependencies节点；一般保存在dependencies的像这些express/ejs/body-parser等等。

因为npm安装插件是从国外服务器下载，受网络影响大，可能出现异常，如果npm的服务器在中国就好了，所以我们乐于分享的淘宝团队干了这事。！这是一个完整 npmjs.org 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟 一次以保证尽量与官方服务同步。

使用如下命令安装：

npm install cnpm -g --registry=https://registry.npm.taobao.org

注意：安装完后最好查看其版本号cnpm -v；

全局安装gulp：

 

cnpm install gulp -g

 

查看gulp版本号：

gulp -v

定位到本地：

cd +路径

 

 

package.json文件

新建package.json文件：package.json是基于nodejs项目必不可少的配置文件，它是存放在项目根目录的普通json文件；

实例展示：

{
"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": "[e-mail]"
},
"license": "ISC", //项目许可协议
"devDependencies": { //项目依赖的插件
"gulp": "^3.8.11",
"gulp-less": "^3.0.0"
}
}

 注：若复制此文件，不能包含任何的注释，请把注释都删掉；

当然我们可以手动新建这个配置文件，但是作为一名有志青年，我们应该使用更为效率的方法：命令提示符执行:

cnpm init

 

安装本地gulp插件

安装：定位目录命令后提示符执行cnpm install --save-dev；

本示例以gulp-less为例（编译less文件），命令提示符执行

cnpm install gulp-less --save-dev

 将会安装在node_modules的gulp-less目录下，该目录下有一个gulp-less的使用帮助文档README.md；

本地安装将安装在定位目录的node_modules文件夹下，通过require()调用；

为了能正常使用，我们还得本地安装gulp：


cnpm install gulp --save-dev

 全局安装gulp是为了执行gulp任务，本地安装gulp则是为了调用gulp插件的功能。

 

新建gulpfile.js文件（重要）

说明：gulpfile.js是gulp项目的配置文件，是位于项目根目录的普通js文件（其实将gulpfile.js放入其他文件夹下亦可）。

它大概是这样一个js文件：

//导入工具包 require(\'node_modules里对应模块\')
var gulp = require(\'gulp\'), //本地安装gulp所用到的地方
less = require(\'gulp-less\'),
sass=require(\'gulp-sass\'),
concat = require(\'gulp-concat\'),
uglify = require(\'gulp-uglify\'),
livereload = require(\'gulp-livereload\'),
cssmin = require(\'gulp-clean-css\');
//确保已本地安装gulp-make-css-url-version [cnpm install gulp-make-css-url-version --save-dev]
cssver = require(\'gulp-make-css-url-version\');

//定义一个testLess任务（自定义任务名称）
gulp.task(\'testLess\', function () {
gulp.src(\'less/lessDemo.less\') //该任务针对的文件
.pipe(less()) //该任务调用的模块
.pipe(gulp.dest(\'css\')); //将会在src/css下生成lessDemo.css
});
// 编译Sass
gulp.task(\'testSass\', function() {
gulp.src(\'sass/sassDemo.scss\')
.pipe(sass())
.pipe(gulp.dest(\'css\'));
});

//合并JS
gulp.task(\'testConcat\', function () {
gulp.src(\'SRC/*.js\')
.pipe(concat(\'all.js\'))//合并后的文件名
.pipe(gulp.dest(\'dist/js\'));
});

gulp.task(\'testCssmin\', function () {
gulp.src(\'css/lessDemo.css\')
.pipe(cssver()) //给css文件里引用文件加版本号（文件MD5）
.pipe(cssmin())
.pipe(gulp.dest(\'dist/css\'));
});

//压缩JS
gulp.task(\'jsmin\', function () {
gulp.src(\'js/bootstrap.js\')
.pipe(uglify({
//mangle: true,//类型：Boolean 默认：true 是否修改变量名
mangle: {except: [\'require\' ,\'exports\' ,\'module\' ,\'$\']}//排除混淆关键字
}))
.pipe(gulp.dest(\'dist/js\'));
});

gulp.task(\'less\', function() {
gulp.src(\'less/test1.less\')
.pipe(less())
.pipe(gulp.dest(\'css\'))
.pipe(livereload());
});

gulp.task(\'watch\', function() {
livereload.listen();
gulp.watch(\'less/test1.less\', [\'less\']);
});

gulp.task(\'default\',[\'testLess\',\'testSass\']); //定义默认任务
//gulp.task(name[, deps], fn) 定义任务 name：任务名称 deps：依赖任务名称 fn：回调函数
//gulp.src(globs[, options]) 执行任务处理的文件 globs：处理的文件路径(字符串或者字符串数组)
//gulp.dest(path[, options]) 处理完后文件生成路径

 

require("gulp")：导入工具包 require(\'node_modules里对应模块\');

src(globs[, options])：src方法是指定需要处理的源文件的路径，gulp借鉴了Unix操作系统的管道（pipe）思想，前一级的输出，直接变成后一级的输入，gulp.src返回当前文件流至可用插件；
通配符路径匹配示例：
“css/a.js”：指定具体文件；
“*”：匹配所有文件
“**”：匹配0个或多个子文件夹
“{}”：匹配多个属性
“!”：排除文件

.dest(path[, options])：dest方法是指定处理完后文件输出的路径；
dest方法是指定处理完后文件输出的路径；

.task(name[, deps], fn)：task定义一个gulp任务；

.pipe()方法：pipe方法传入方法的是一个function，这个function作用是接受上一个流（stream）的结果，并返回一个处理后流的结果(返回值应该是一个stream对象)。

此处特别说明一下编译sass：
根据博主的使用经验，gulp-sass依赖了node-sass这个库。安装node-sass这个库的时候要执行一个脚本，而在这个过程中出错了，可以试下管理员身份安装。大家在使用时需注意。

 

运行gulp

说明：命令提示符执行gulp 任务名称；

编译less：命令提示符执行：

 

gulp testLess

 

 

 

当执行gulp default或gulp将会调用default任务里的所有任务。

 

写在最后
当我在用 gulp 时我用它做什么？

编译 sass
合并优化压缩 css
校验压缩 js
优化图片
添加文件加密（md5）
组件化头部底部（include html）
实时自动刷新…
总之，gulp是前端开发过程中对代码进行自动化构建的利器。它不仅能对资源进行优化，而且在开发过程中能够通过配置自动完成很多重复的任务，让我们可以专注于代码，提高工作效率。

本期分享就到这里，我们下期再见。觉得内容不错的小伙伴请点推荐，欢迎大家在评论下方评论区与博主互动，谢谢大家！

 更多精彩内容，敬请关注 Q的前端世界的技术博客。