gulp和webpack入门介绍

gulp

前言

众所周知目前比较火的工具就是gulpwebpack,但webpack和gulp却有所不同,本人两者的底层研究不是很深,所以本篇只做入门,只介绍各自环境下的环境配置和对应能实现的效果。

各自特性和特点

gulp

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

特点

gulp是基于Nodejs的自动任务运行器, 她能自动化地完成 javascript/coffee/sass/less/html/image/css 等文件的的测试、检查、合并、压缩、格式化、浏览器自动刷新、部署文件生成,并监听文件在改动后重复指定的这些步骤。在实现上,她借鉴了Unix操作系统的管道(pipe)思想,前一级的输出,直接变成后一级的输入,使得在操作上非常简单。

快速入门

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

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

  1. 安装nodejs

1.1. 说明:gulp是基于nodejs,理所当然需要安装nodejs;

1.2. 安装:打开nodejs官网,点击硕大的绿色Download按钮,它会根据系统信息选择对应版本(.msi文件)。然后像安装QQ一样安装它就可以了(安装路径随意)。

  1. 使用命令行(如果你熟悉命令行,可以直接跳到第3步)

2.1. 说明:什么是命令行?命令行在OSX是终端(Terminal),在windows是命令提示符(Command Prompt);

2.2. 注:之后操作都是在windows系统下;

2.3. 简单介绍gulp在使用过程中常用命令,打开命令提示符执行下列命令(打开方式:window + r 输入cmd回车):

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

npm -v查看npm的版本号,npm是在安装nodejs时一同安装的nodejs包管理器,那它有什么用呢?稍后解释;

cd定位到目录,用法:cd + 路径 ;

dir列出文件列表;

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

  1. npm介绍

3.1. 说明:npm(node package manager)nodejs的包管理器,用于node插件管理(包括安装、卸载、管理依赖等);

3.2. 使用npm安装插件:命令提示符执行npm install [-g] [–save-dev];

3.2.1. :node插件名称。例:npm install gulp-less –save-dev

3.2.2. -g:全局安装。将会安装在C:\Users\Administrator\AppData\Roaming\npm,并且写入系统环境变量; 非全局安装:将会安装在当前定位目录; 全局安装可以通过命令行在任何地方调用它,本地安装将安装在定位目录的node_modules文件夹下,通过require()调用;

3.2.3. –save:将保存配置信息至package.json(package.json是nodejs项目配置文件);

3.2.4. -dev:保存至package.json的devDependencies节点,不指定-dev将保存至dependencies节点;一般保存在dependencies的像这些express/ejs/body-parser等等。

3.2.5. 为什么要保存至package.json?因为node插件包相对来说非常庞大,所以不加入版本管理,将配置信息写入package.json并将其加入版本管理,其他开发者对应下载即可(命令提示符执行npm install,则会根据package.json下载所有需要的包,npm install –production只下载dependencies节点的包)。

3.3. 使用npm卸载插件:npm uninstall [-g] [–save-dev] PS:不要直接删除本地插件包

3.3.1. 删除全部插件:npm uninstall gulp-less gulp-uglify gulp-concat ……???太麻烦

3.3.2. 借助rimraf:npm install rimraf -g 用法:rimraf node_modules

3.4. 使用npm更新插件:npm update [-g] [–save-dev]

3.4.1. 更新全部插件:npm update [–save-dev]

3.5. 查看npm帮助:npm help

3.6. 当前目录已安装插件:npm list

PS:npm安装插件过程:从http://registry.npmjs.org下载对应的插件包(该网站服务器位于国外,所以经常下载缓慢或出现异常),解决办法往下看↓↓↓↓↓↓。
4、选装cnpm

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

4.2. 官方网址:http://npm.taobao.org;

4.3. 安装:命令提示符执行npm install cnpm -g –registry=https://registry.npm.taobao.org; 注意:安装完后最好查看其版本号cnpm -v或关闭命令提示符重新打开,安装完直接使用有可能会出现错误;

注:cnpm跟npm用法完全一致,只是在执行命令时将npm改为cnpm(以下操作将以cnpm代替npm)。

  1. 全局安装gulp

5.1. 说明:全局安装gulp目的是为了通过她执行gulp任务;

5.2. 安装:命令提示符执行cnpm install gulp -g;

5.3. 查看是否正确安装:命令提示符执行gulp -v,出现版本号即为正确安装。

  1. 新建package.json文件
    6.1. 说明:package.json是基于nodejs项目必不可少的配置文件,它是存放在项目根目录的普通json文件;

6.2. 它是这样一个json文件(注意: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插件

7.1. 安装:定位目录命令后提示符执行cnpm install –save-dev;

7.2. 本示例以gulp-less为例(编译less文件),命令提示符执行cnpm install gulp-less –save-dev;
7.3. 将会安装在node_modules的gulp-less目录下,该目录下有一个gulp-less的使用帮助文档README.md;

7.4. 为了能正常使用,我们还得本地安装gulp:cnpm install gulp –save-dev;

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

  1. 新建gulpfile.js文件(重要)

8.1、说明:gulpfile.js是gulp项目的配置文件,是位于项目根目录的普通js文件(其实将gulpfile.js放入其他文件夹下亦可)。

8.2. 它大概是这样一个js文件(更多插件配置请查看这里):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//导入工具包 require('node_modules里对应模块')
var gulp = require('gulp'), //本地安装gulp所用到的地方
less = require('gulp-less');
//定义一个testLess任务(自定义任务名称)
gulp.task('testLess', function () {
gulp.src('src/less/index.less') //该任务针对的文件
.pipe(less()) //该任务调用的模块
.pipe(gulp.dest('src/css')); //将会在src/css下生成index.css
});
gulp.task('default',['testLess', 'elseTask']); //定义默认任务 elseTask为其他任务,该示例没有定义elseTask任务
//gulp.task(name[, deps], fn) 定义任务 name:任务名称 deps:依赖任务名称 fn:回调函数
//gulp.src(globs[, options]) 执行任务处理的文件 globs:处理的文件路径(字符串或者字符串数组)
//gulp.dest(path[, options]) 处理完后文件生成路径

9、运行gulp

9.1、说明:命令提示符执行gulp 任务名称;

9.2、编译less:命令提示符执行gulp testLess;

9.3、当执行gulp default或gulp将会调用default任务里的所有任务[‘testLess’,’elseTask’]。

  1. 总结
  • 安装nodejs;
  • 新建package.json文件;
  • 全局和本地安装gulp;
  • 安装gulp插件;
  • 新建gulpfile.js文件;
  • 通过命令提示符运行gulp任务。

作为入门只介绍最基础的使用方法,如想进一步提升自己的自动化构建环境,可参考gulp官方给出的例子,根据自己的需求自定义一套自动化流程环境,如有需要我可以额外写一篇文章介绍自己的gulp和webpack配置以及注意点。

webpack

webpack

webpack为”模块化管理”和”打包工具”,它可以将许多松散的模块按照依赖和规则打包成符合生产环境部署的前端资源。还可以将按需加载的模块进行代码分隔,等到实际需要的时候再异步加载。通过 loader 的转换,任何形式的资源都可以视作模块,比如 CommonJs 模块、 AMD 模块、 ES6 模块、CSS、图片、 JSON、Coffeescript、 LESS 等。

特点

代码拆分

Webpack 有两种组织模块依赖的方式,同步(默认)和异步(高级)。异步依赖作为分割点,形成一个新的块。在优化了依赖树后,每一个异步区块都作为一个文件被打包。

Loader

Webpack 本身只能处理原生的 JavaScript 模块,但是 “loader 转换器”可以将各种类型的资源转换成 JavaScript 模块。这样,任何资源都可以成为 Webpack 可以处理的模块。

智能解析

Webpack 有一个智能解析器,几乎可以处理任何第三方库,无论它们的模块形式是CommonJS、 AMD 还是普通的 JS 文件。甚至在加载依赖的时候,允许使用动态表达式 require(“./templates/“ + name + “.jade”)。

插件系统

Webpack 还有一个功能丰富的插件系统。大多数内容功能都是基于这个插件系统运行的,还可以开发和使用开源的 Webpack 插件,来满足各式各样的需求。

快速运行

Webpack 使用异步 I/O (NodeJs)和多级缓存提高运行效率,这使得 Webpack 能够以令人难以置信的速度快速增量编译。

快速入门

  1. 全局安装webpack (安装webpack命令)

安装: npm i webpack -g //全局安装 测试: webpack version 只需要安装一次;

  1. 本地安装

全局安装相当于只是安装了webpack命令,如果需要在我们的项目中使用, 那么还需要本地安装(项目中安装) 安装:npm i webpack –save-dev 安装稳定版本(大多都是最新版) npm i webpack@2.1.0-beta.11 –save-dev

  1. 简单使用

1)新建项目(文件夹) npm init 初始化package.json包配置文件

2)本地安装 npm i webpack –save-dev //保存到包配置文件中

3)新建模块 scripts 文件夹(命明任意) a.js
b.js index.html

4)命令行打包 webpack 源文件 输出文件 webpack a.js bundle.js a.js 主文件(入口文件,第一个被页面加载的文件) bundle.js 打包后的文件(文件内容包含a.js和a.js依赖的所有文件)

5)页面使用

1
<script src="scripts/bundle.js"></script>

注:后面可以用HtmlWebpackPlugin来自动将打包后的js引入,目前只做初步了解,以后有机会再讲。

  1. webpack配置文件

webpack.config.js

webpack提供了配置文件,我们可以把webpack后面的参数放到配置文件中,之后直接使用webpack命令执行。关于这个的初始化模版,可以参考下我这个(摘取于官方中文文档)

1
2
3
4
5
6
7
8
9
10
11
var path = require('path');
module.exports = {
//入口文件
entry: './foo.js',
//输出目录和文件
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'foo.bundle.js'
}
};

注:多页面应用和多入口文件请参考webpack官方中文文档里有详解,我在此不再拷贝过来。

  1. 运行webpack命令

最简单的就是直接 使用指令:webpack

由于webpack其实还有很多可以添加配置指令,所以一般都把对应的脚本指令放到packjson文件,如下是我的:

1
2
3
4
5
6
"scripts": {
"dev": "webpack-dev-server --hot --watch --progress --profile --colors ",
"build": "webpack -p --colors --watch",
"start": "webpack-dev-server --open",
"clean": "npm cache clean -f"
},

加载器

loader 用于对模块的源代码进行转换。loader 可以使你在 import 或”加载”模块时预处理文件。因此,loader 类似于其他构建工具中“任务(task)”,并提供了处理前端构建步骤的强大方法。loader 可以将文件从不同的语言(如 TypeScript)转换为 JavaScript,或将内联图像转换为 data URL。loader 甚至允许你直接在 JavaScript 模块中 import CSS文件!

  1. loader模块加载器

webpack原生仅支持JavaScript模块加载(require(‘/xxx.js’)),如果需要提供其他的模块加载器,那么我们就必须进行安装。 如果直接通过require去加载非js文件,那么会报错。 You may need an appropriate loader to handle this file type.(提示差加载器) Cannot resolve module ‘style-loader’(没有安装模块。指定加载器,没有安装)

  1. style模块加载器

css-loader:css文件加载器; style-loader: style文件加载器;

npm install css-loader style-loader –save-dev来安装这些loader。

使用模块加载器,你还需要在webpack.config.js中进行配置。

styles/a.css body{ background: pink; } scripts/a.js //导入css模块 require(“../styles/a.css”);

  1. less模块加载器

less是CSS 预处理语言,使用less可以提高编写css效率,webpack中也可以对less模块加载。 安装:npm install less less-loader –save-dev

styles/myless.less @color: #00ff0f; h1,h2{ color: @color; }

scripts/a.js //导入myless.less模块。 require(“../styles/myless.less”); 执行命令webpack,开始打包。

  1. url资源加载器

url-loader对图片的加载器,将采用如果图片小可以采用base64(内嵌在js中)。 file-loader:对大图片,默认不(推荐)会嵌入js,所以这个文件会直接拷贝到输出目录,需要使用时,直接通过路径来使用。file-loader就是用来识别文件(在服务器上)的地址

var image = require(‘../images/xxxx.jpg’); console.log(image);

注:其他加载器请参考官方文档了解并使用如:html-loader、babel-loader等

其他

1. webpack-dev-server

webpack-dev-server是webpack中常用的工具,它是一个服务器,基于express,并且提供热加载功能,方便我们开发。

安装webpack-dev-server

npm install webpack-dev-server -g npm install webpack-dev-server //本地安装

使用webpack-dev-server

webpack-dev-server服务器启动后,默认使用iframe帮我们自动刷新。 执行webpack-dev-server –hot –inline; –hot 采用热部署,不用F5就可以刷新页面(AJAX)。 –inline无需刷新页面就可以更新(刷新的代码直接嵌套在我们的打包文件中)。

或在配置文件里配置

1
2
3
4
5
6
7
8
devServer: {
host: "192.168.0.135",
//压缩代码
compress: false,
contentBase: [path.join(__dirname, "dist"), path.join(__dirname, "src")],
port: 9000,
watchContentBase: true
}

具体的参数和如何设置请查看官方文档的解释

2. extract-text-webpack-plugin 提取css

webpack中所有资源(css/img/js)都看为模块,所以如果一个js中依赖的css,默认情况下会打包到模块中。 extract-text-webpack-plugin 插件可以把css提取到一个文件,然后通过link引入这个文件即可。 extract-text-webpack-plugin是一个第三方的插件,所以使用之前先要安装。 安装:npm i extract-text-webpack-plugin –save-dev

使用

1
const extractSCSS = new ExtractTextPlugin("css/styles.css");
1
2
3
4
5
6
7
8
{
test: /\.scss$/,
use: extractSCSS.extract({
fallback: "style-loader",
//如果需要,可以在 sass-loader 之前将 resolve-url-loader 链接进来
use: ["css-loader", "sass-loader"]
})
}
1
2
3
plugins: [
extractSCSS,
],

基本的介绍到这,如有一些概念拿不准请去官方文档看,一些进阶的玩法和整体的所有配置,以后有机会可以出一篇作为文章,贴出我自己的配置文件以及注意事项。

坚持原创技术分享,您的支持将鼓励我继续创作!
Fork me on GitHub