1.调试更容易(生成Source Maps)
开发总是离不开调试,方便的调试能极大的提高开发效率,不过有时候通过打包后的文件,你是不容易找到出错了的地方,对应的你写的代码的位置的,Source Maps就是来帮我们解决这个问题的。
通过简单的配置,webpack就可以在打包时为我们生成的source maps,这为我们提供了一种对应编译文件和源文件的方法,使得编译后的代码可读性更高,也更容易调试。
在webpack的配置文件中配置source maps,需要配置devtool,它有以下四种不同的配置选项,各具优缺点,描述如下
正如上表所述,上述选项由上到下打包速度越来越快,不过同时也具有越来越多的负面作用,较快的打包速度的后果就是对打包后的文件的的执行有一定影响。
对小到中型的项目中,eval-source-map是一个很好的选项,再次强调你只应该开发阶段使用它,我们继续对上文新建的webpack.config.js,进行如下配置:
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js", // 唯一入口文件
output: {
path: __dirname + "/public", // 打包后文件存放的地方
filename: "bundle.js"
}
}
cheap-module-eval-source-map方法构建速度更快,但是不利于调试,推荐在大型项目考虑时间成本时使用。
2.使用webpack构建本地服务器
想不想让你的浏览器监听你的代码的修改,并自动刷新显示修改后的结果,其实Webpack提供一个可选的本地开发服务器,这个本地服务器基于node.js构建,可以实现你想要的这些功能,不过它是一个单独的组件,在webpack中进行配置之前需要单独安装它作为项目依赖
npm install --save-dev webpack-dev-server
把这些命令加到webpack的配置文件中,现在的配置文件webpack.config.js如下所示
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js", // 唯一入口文件
output: {
path: __dirname + "/public", // 打包后文件存放的地方
filename: "bundle.js"
},
devServer: {
contentBase: "./public", //本地服务器所加载的页面所在的目录
historyApiFallback: true, //不跳转
inline: true //实时刷新
}
}
在package.json中的scripts对象中添加如下命令,用以开启本地服务器:
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "webpack",
"server": "webpack-dev-server --open"
},
在终端中输入npm run server即可在本地的8080端口查看结果
3.loaders
Loaders是webpack提供的最激动人心的功能之一了。通过使用不同的loader,webpack有能力调用外部的脚本或工具,实现对不同格式的文件的处理,比如说分析转换scss为css,或者把下一代的JS文件(ES6,ES7)转换为现代浏览器兼容的JS文件,对React的开发而言,合适的Loaders可以把React的中用到的JSX文件转换为JS文件。
Loaders需要单独安装并且需要在webpack.config.js中的modules关键字下进行配置,Loaders的配置包括以下几方面:
test:一个用以匹配loaders所处理文件的拓展名的正则表达式(必须)
loader:loader的名称(必须)
include/exclude:手动添加必须处理的文件(文件夹)或屏蔽不需要处理的文件(文件夹)(可选);
query:为loaders提供额外的设置选项(可选)
不过在配置loader之前,我们把Greeter.js里的问候消息放在一个单独的JSON文件里,并通过合适的配置使Greeter.js可以读取该JSON文件的值,各文件修改后的代码如下:
在app文件夹中创建带有问候信息的JSON文件(命名为config.json)
{
"greetText": "HI there and greetings from JSON"
}
Greeter.js文件变为这样
var config = require('./config.json');
module.exports = function() {
var greet = document.createElement('div');
greet.textContent = config.greetText;
return greet;
};
注由于webpack3.*/webpack2.*已经内置可处理JSON文件,这里我们无需再添加webpack1.*需要的json-loader。在看如何具体使用loader之前我们先看看Babel是什么?
4.babel
Babel其实是一个编译JavaScript的平台,它可以编译代码帮你达到以下目的:
让你能使用最新的JavaScript代码(ES6,ES7...),而不用管新标准是否被当前使用的浏览器完全支持;
让你能使用基于JavaScript进行了拓展的语言,比如React的JSX;
5.Babel的安装与配置
Babel其实是几个模块化的包,其核心功能位于称为babel-core的npm包中,webpack可以把其不同的包整合在一起使用,对于每一个你需要的功能或拓展,你都需要安装单独的包(用得最多的是解析Es6的babel-env-preset包和解析JSX的babel-preset-react包)。
我们先来一次性安装这些依赖包
// npm一次性安装多个依赖模块,模块之间用空格隔开
npm install --save-dev babel-core babel-loader babel-preset-env babel-preset-react
在webpack中配置Babel的方法如下:
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js", // 唯一入口文件
output: {
path: __dirname + "/public", // 打包后文件存放的地方
filename: "bundle.js"
},
devServer: {
contentBase: "./public", //本地服务器所加载的页面所在的目录
historyApiFallback: true, //不跳转
inline: true //实时刷新
},
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader",
options: {
presets: [
"env", "react"
]
}
},
exclude: /node_modules/
}
]
}
}
现在你的webpack的配置已经允许你使用ES6以及JSX的语法了。继续用上面的例子进行测试,不过这次我们会使用React,记得先安装 React 和 React-DOM
npm install --save react react-dom
接下来我们使用ES6的语法,更新Greeter.js并返回一个React组件
//Greeter,jsimportReact,{Component}from'react'importconfigfrom'./config.json';classGreeterextendsComponent{render(){return(<div>{config.greetText}</div>);}}exportdefaultGreeter
修改main.js如下,使用ES6的模块定义和渲染Greeter模块
// main.jsimportReactfrom'react';import{render}from'react-dom';importGreeterfrom'./Greeter';render(<Greeter/>,document.getElementById('root'));
重新使用npm start打包,如果之前打开的本地服务器没有关闭,你应该可以在localhost:8080下看到与之前一样的内容,这说明react和es6被正常打包了。
5.Babel的配置
Babel其实可以完全在 webpack.config.js 中进行配置,但是考虑到babel具有非常多的配置选项,在单一的webpack.config.js文件中进行配置往往使得这个文件显得太复杂,因此一些开发者支持把babel的配置选项放在一个单独的名为 ".babelrc" 的配置文件中。我们现在的babel的配置并不算复杂,不过之后我们会再加一些东西,因此现在我们就提取出相关部分,分两个配置文件进行配置(webpack会自动调用.babelrc里的babel配置选项),如下:
module.exports={entry:__dirname+"/app/main.js",//已多次提及的唯一入口文件output:{path:__dirname+"/public",//打包后的文件存放的地方filename:"bundle.js"//打包后输出文件的文件名},devtool:'eval-source-map',devServer:{contentBase:"./public",//本地服务器所加载的页面所在的目录historyApiFallback:true,//不跳转inline:true//实时刷新},module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/}]}};
//.babelrc{"presets":["react","env"]}
到目前为止,我们已经知道了,对于模块,Webpack能提供非常强大的处理功能,那那些是模块呢
6.一切皆模块
Webpack有一个不可不说的优点,它把所有的文件都都当做模块处理,JavaScript代码,CSS和fonts以及图片等等通过合适的loader都可以被处理。
css
webpack提供两个工具处理样式表,css-loader和style-loader,二者处理的任务不同,css-loader使你能够使用类似@import和url(...)的方法实现require()的功能,style-loader将所有的计算后的样式加入页面中,二者组合在一起使你能够把样式表嵌入webpack打包后的JS文件中。
//安装
npm install --save-dev style-loader css-loader
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader",
options: {
presets: [
"env", "react"
]
}
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
},{
loader: "css-loader"
}
]
}
]
}
接下来,在app文件夹里创建一个名字为"main.css"的文件,对一些元素设置样式
/* main.css */
html {
box-sizing: border-box;
-ms-text-size-adjust: 100%;
-webkit-text-size-adjust: 100%;
}
*, *:before, *:after {
box-sizing: inherit;
}
body {
margin: 0;
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
h1, h2, h3, h4, h5, h6, p, ul {
margin: 0;
padding: 0;
}
我们这里例子中用到的webpack只有单一的入口,其它的模块需要通过import,require,url等与入口文件建立其关联,为了让webpack能找到”main.css“文件,我们把它导入”main.js “中,如下
// const greeter = require ('./Greeter.js');
import React from 'react';
import {render} from 'react-dom';
import Greeter from './Greeter';
import './main.css'; // 使用require导入css文件
render(<Greeter />, document.getElementById('root'));
通常情况下,css会和js打包到同一个文件中,并不会打包为一个单独的css文件,不过通过合适的配置webpack也可以把css打包为单独的文件的。
css module
在过去的一些年里,JavaScript通过一些新的语言特性,更好的工具以及更好的实践方法(比如说模块化)发展得非常迅速。模块使得开发者把复杂的代码转化为小的,干净的,依赖声明明确的单元,配合优化工具,依赖管理和加载管理可以自动完成。
不过前端的另外一部分,CSS发展就相对慢一些,大多的样式表却依旧巨大且充满了全局类名,维护和修改都非常困难。
被称为CSS modules的技术意在把JS的模块化思想带入CSS中来,通过CSS模块,所有的类名,动画名默认都只作用于当前模块。Webpack对CSS模块化提供了非常好的支持,只需要在CSS loader中进行简单配置即可,然后就可以直接把CSS的类名传递到组件的代码中,这样做有效避免了全局污染。具体的代码如下
module.exports = {
...
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader",
options: {
modules: true, // 指定启用css modules
localIdentName: '[name]__[local]--[hash:base64:5]' // 指定css的类名格式
}
}
]
}
]
}
};
我们在app文件夹下创建一个Greeter.css文件来进行一下测试
/* Greeter.css */
.root {
background-color: #eee;
padding: 10px;
border: 3px solid #ccc;
}
导入.root到Greeter.js中
importReact,{Component}from'react';importconfigfrom'./config.json';importstylesfrom'./Greeter.css';//导入classGreeterextendsComponent{render(){return(<divclassName={styles.root}>//使用cssModule添加类名的方法{config.greetText}</div>);}}exportdefaultGreeter
放心使用把,相同的类名也不会造成不同组件之间的污染。
CSS modules 也是一个很大的主题,有兴趣的话可以去其官方文档了解更多。
CSS预处理器
Sass 和 Less 之类的预处理器是对原生CSS的拓展,它们允许你使用类似于variables, nesting, mixins, inheritance等不存在于CSS中的特性来写CSS,CSS预处理器可以这些特殊类型的语句转化为浏览器可识别的CSS语句,
你现在可能都已经熟悉了,在webpack里使用相关loaders进行配置就可以使用了,以下是常用的CSS 处理loaders:
Less Loader
Sass Loader
Stylus Loader
不过其实也存在一个CSS的处理平台-PostCSS,它可以帮助你的CSS实现更多的功能,在其官方文档可了解更多相关知识。
举例来说如何使用PostCSS,我们使用PostCSS来为CSS代码自动添加适应不同浏览器的CSS前缀。
首先安装postcss-loader 和 autoprefixer(自动添加前缀的插件)
npm install --save-dev postcss-loader autoprefixer
接下来,在webpack配置文件中添加postcss-loader,在根目录新建postcss.config.js,并添加如下代码之后,重新使用npm start打包时,你写的css会自动根据Can i use里的数据添加不同前缀了。
//webpack.config.jsmodule.exports={...module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:[{loader:"style-loader"},{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}]}]}}// postcss.config.jsmodule.exports={plugins:[require('autoprefixer')]}
至此,本文已经谈论了处理JS的Babel和处理CSS的PostCSS的基本用法,它们其实也是两个单独的平台,配合webpack可以很好的发挥它们的作用。接下来介绍Webpack中另一个非常重要的功能-Plugins
插件(Plugins)
插件(Plugins)是用来拓展Webpack功能的,它们会在整个构建过程中生效,执行相关的任务。
Loaders和Plugins常常被弄混,但是他们其实是完全不同的东西,可以这么来说,loaders是在打包构建过程中用来处理源文件的(JSX,Scss,Less..),一次处理一个,插件并不直接操作单个文件,它直接对整个构建过程其作用。
Webpack有很多内置插件,同时也有很多第三方插件,可以让我们完成更加丰富的功能。
使用插件的方法
要使用某个插件,我们需要通过npm安装它,然后要做的就是在webpack配置中的plugins关键字部分添加该插件的一个实例(plugins是一个数组)继续上面的例子,我们添加了一个给打包后代码添加版权声明的插件。
constwebpack=require('webpack');module.exports={...module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:[{loader:"style-loader"},{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}]}]},plugins:[newwebpack.BannerPlugin('版权所有,翻版必究')],};
通过这个插件,打包后的JS文件显示如下
这就是webpack插件的基础用法了,下面给大家推荐几个常用的插件
HtmlWebpackPlugin
这个插件的作用是依据一个简单的index.html模板,生成一个自动引用你打包后的JS文件的新index.html。这在每次生成的js文件名称不同时非常有用(比如添加了hash值)。
安装
npm install --save-dev html-webpack-plugin
这个插件自动完成了我们之前手动做的一些事情,在正式使用之前需要对一直以来的项目结构做一些更改:
移除public文件夹,利用此插件,index.html文件会自动生成,此外CSS已经通过前面的操作打包到JS中了。
在app目录下,创建一个index.tmpl.html文件模板,这个模板包含title等必须元素,在编译过程中,插件会依据此模板生成最终的html页面,会自动添加所依赖的 css, js,favicon等文件,index.tmpl.html中的模板源代码如下:
<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><title>Webpack Sample Project</title></head><body><divid='root'></div></body></html>
3.更新webpack的配置文件,方法同上,新建一个build文件夹用来存放最终的输出文件
constwebpack=require('webpack');constHtmlWebpackPlugin=require('html-webpack-plugin');module.exports={entry:__dirname+"/app/main.js",//已多次提及的唯一入口文件output:{path:__dirname+"/build",filename:"bundle.js"},devtool:'eval-source-map',devServer:{contentBase:"./public",//本地服务器所加载的页面所在的目录historyApiFallback:true,//不跳转inline:true//实时刷新},module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:[{loader:"style-loader"},{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}]}]},plugins:[newwebpack.BannerPlugin('版权所有,翻版必究'),newHtmlWebpackPlugin({template:__dirname+"/app/index.tmpl.html"//new 一个这个插件的实例,并传入相关的参数})],};
再次执行npm start你会发现,build文件夹下面生成了bundle.js和index.html。
Hot Module Replacement
Hot Module Replacement(HMR)也是webpack里很有用的一个插件,它允许你在修改组件代码后,自动刷新实时预览修改后的效果。
在webpack中实现HMR也很简单,只需要做两项配置
在webpack配置文件中添加HMR插件;
在Webpack Dev Server中添加“hot”参数;
不过配置完这些后,JS模块其实还是不能自动热加载的,还需要在你的JS模块中执行一个Webpack提供的API才能实现热加载,虽然这个API不难使用,但是如果是React模块,使用我们已经熟悉的Babel可以更方便的实现功能热加载。
整理下我们的思路,具体实现方法如下
Babel和webpack是独立的工具
二者可以一起工作
二者都可以通过插件拓展功能
HMR是一个webpack插件,它让你能浏览器中实时观察模块修改后的效果,但是如果你想让它工作,需要对模块进行额外的配额;
Babel有一个叫做react-transform-hrm的插件,可以在不对React模块进行额外的配置的前提下让HMR正常工作;
还是继续上例来实际看看如何配置
constwebpack=require('webpack');constHtmlWebpackPlugin=require('html-webpack-plugin');module.exports={entry:__dirname+"/app/main.js",//已多次提及的唯一入口文件output:{path:__dirname+"/build",filename:"bundle.js"},devtool:'eval-source-map',devServer:{contentBase:"./public",//本地服务器所加载的页面所在的目录historyApiFallback:true,//不跳转inline:true,hot:true},module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:[{loader:"style-loader"},{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}]}]},plugins:[newwebpack.BannerPlugin('版权所有,翻版必究'),newHtmlWebpackPlugin({template:__dirname+"/app/index.tmpl.html"//new 一个这个插件的实例,并传入相关的参数}),newwebpack.HotModuleReplacementPlugin()//热加载插件],};
安装react-transform-hmr
npm install --save-dev babel-plugin-react-transform react-transform-hmr
配置Babel
// .babelrc{"presets":["react","env"],"env":{"development":{"plugins":[["react-transform",{"transforms":[{"transform":"react-transform-hmr","imports":["react"],"locals":["module"]}]}]]}}}
现在当你使用React时,可以热加载模块了,每次保存就能在浏览器上看到更新内容。
产品阶段的构建
目前为止,我们已经使用webpack构建了一个完整的开发环境。但是在产品阶段,可能还需要对打包的文件进行额外的处理,比如说优化,压缩,缓存以及分离CSS和JS。
对于复杂的项目来说,需要复杂的配置,这时候分解配置文件为多个小的文件可以使得事情井井有条,以上面的例子来说,我们创建一个webpack.production.config.js的文件,在里面加上基本的配置,它和原始的webpack.config.js很像,如下
// webpack.production.config.jsconstwebpack=require('webpack');constHtmlWebpackPlugin=require('html-webpack-plugin');module.exports={entry:__dirname+"/app/main.js",//已多次提及的唯一入口文件output:{path:__dirname+"/build",filename:"bundle.js"},devtool:'null',//注意修改了这里,这能大大压缩我们的打包代码devServer:{contentBase:"./public",//本地服务器所加载的页面所在的目录historyApiFallback:true,//不跳转inline:true,hot:true},module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:ExtractTextPlugin.extract({fallback:"style-loader",use:[{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}],})}]},plugins:[newwebpack.BannerPlugin('版权所有,翻版必究'),newHtmlWebpackPlugin({template:__dirname+"/app/index.tmpl.html"//new 一个这个插件的实例,并传入相关的参数}),newwebpack.HotModuleReplacementPlugin()//热加载插件],};//package.json{"name":"test","version":"1.0.0","description":"","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"webpack","server":"webpack-dev-server --open","build":"NODE_ENV=production webpack --config ./webpack.production.config.js --progress"},"author":"","license":"ISC","devDependencies":{...},"dependencies":{"react":"^15.6.1","react-dom":"^15.6.1"}}
注意:如果是window电脑,build需要配置为"build": "set NODE_ENV=production && webpack --config ./webpack.production.config.js --progress".谢谢评论区简友提醒。
优化插件
webpack提供了一些在发布阶段非常有用的优化插件,它们大多来自于webpack社区,可以通过npm安装,通过以下插件可以完成产品发布阶段所需的功能
OccurenceOrderPlugin :为组件分配ID,通过这个插件webpack可以分析和优先考虑使用最多的模块,并为它们分配最小的ID
UglifyJsPlugin:压缩JS代码;
ExtractTextPlugin:分离CSS和JS文件
我们继续用例子来看看如何添加它们,OccurenceOrder 和 UglifyJS plugins 都是内置插件,你需要做的只是安装其它非内置插件
npm install --save-dev extract-text-webpack-plugin
在配置文件的plugins后引用它们
// webpack.production.config.jsconstwebpack=require('webpack');constHtmlWebpackPlugin=require('html-webpack-plugin');constExtractTextPlugin=require('extract-text-webpack-plugin');module.exports={entry:__dirname+"/app/main.js",//已多次提及的唯一入口文件output:{path:__dirname+"/build",filename:"bundle.js"},devtool:'none',devServer:{contentBase:"./public",//本地服务器所加载的页面所在的目录historyApiFallback:true,//不跳转inline:true,hot:true},module:{rules:[{test:/(\.jsx|\.js)$/,use:{loader:"babel-loader"},exclude:/node_modules/},{test:/\.css$/,use:[{loader:"style-loader"},{loader:"css-loader",options:{modules:true}},{loader:"postcss-loader"}]}]},plugins:[newwebpack.BannerPlugin('版权所有,翻版必究'),newHtmlWebpackPlugin({template:__dirname+"/app/index.tmpl.html"}),newwebpack.optimize.OccurrenceOrderPlugin(),newwebpack.optimize.UglifyJsPlugin(),newExtractTextPlugin("style.css")],};
此时执行npm run build可以看见代码是被压缩后的
缓存
缓存无处不在,使用缓存的最好方法是保证你的文件名和文件内容是匹配的(内容改变,名称相应改变)
webpack可以把一个哈希值添加到打包的文件名中,使用方法如下,添加特殊的字符串混合体([name], [id] and [hash])到输出文件名前
constwebpack=require('webpack');constHtmlWebpackPlugin=require('html-webpack-plugin');constExtractTextPlugin=require('extract-text-webpack-plugin');module.exports={..output:{path:__dirname+"/build",filename:"bundle-[hash].js"},...};
现在用户会有合理的缓存了。
去除build文件中的残余文件
添加了hash之后,会导致改变文件内容后重新打包时,文件名不同而内容越来越多,因此这里介绍另外一个很好用的插件clean-webpack-plugin。
安装:
cnpm install clean-webpack-plugin --save-dev
使用:
引入clean-webpack-plugin插件后在配置文件的plugins中做相应配置即可:
constCleanWebpackPlugin=require("clean-webpack-plugin");plugins:[...// 这里是之前配置的其它各种插件newCleanWebpackPlugin('build/*.*',{root:__dirname,verbose:true,dry:false})]
关于clean-webpack-plugin的详细使用可参考这里