入门 Webpack，看这篇就够了

2016-08-05 22:55:00

写在前面的话

阅读本文之前，先看下面这个webpack的配置文件，如果每一项你都懂，那本文能带给你的收获也许就比较有限，你可以快速浏览或直接跳过；如果你和十天前的我一样，对很多选项存在着疑惑，那花一段时间慢慢阅读本文，你的疑惑一定一个一个都会消失；如果你以前没怎么接触过Webpack，如果你对webpack感兴趣，本文中有一个贯穿始终的例子，如果你能把这个例子自己动手写一次，写完以后你会发现你已明明白白的走进了Webpack的大门。

//一个常见的Webpack配置文件
var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');
var ExtractTextPlugin = require('extract-text-webpack-plugin');

module.exports = {
entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "[name]-[hash].js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: ExtractTextPlugin.extract('style', 'css?modules!postcss')
}
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.optimize.OccurenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("[name]-[hash].css")
]
}

什么是WebPack，为什么要使用它？

为什要使用WebPack

现今的很多网页其实可以看做是功能丰富的应用，它们拥有着复杂的JavaScript代码和一大堆依赖包。为了简化开发的复杂度，前端社区涌现出很多好的实践方法

  1. 模块化，让我们可以把复杂的程序细化为小的文件

  2. 类似于TypeScript这种在JavaScript基础上拓展的开发语言：使我们能够实现目前版本的JavaScript不能直接使用的特性，并且之后还能能装换为JavaScript文件使浏览器可以识别

  3. Scss，less等CSS预处理器

  4. ...

这些改进确实大大的提供了我们的开发效率，但是利用它们开发的文件需要进行额外的处理才能让浏览器识别，手动处理非常复杂，这就为WebPack类的工具的出现提供了需求。

什么是Webpack

WebPack可以看做是模块打包机：它做的事情是，分析你的项目结构，找到JavaScript模块以及其它的一些预设，打包为合适的格式以供浏览器使用。

WebPack和Grunt以及Gulp相比有什么特性

其实Webpack和另外两个并没有太多的可比性，Gulp/Grunt是一种工具，能够优化前端的工作流程，而WebPack是一种模块化的解决方案，Webpack的优点使得Webpack可以替代Gulp/Grunt类的工具。

Grunt和Gulp的工作方式是：在一个配置文件中，指明对某些文件进行类似编译，组合，压缩等任务的具体步骤，这个工具之后可以自动替你完成这些任务。

超级产品经理, document.getElementById('root'));

Babel的配置选项

Babel其实可以完全在webpack.config.js中进行配置，但是考虑到babel具有非常多的配置选项，在单一的webpack.config.js文件中进行配置往往使得这个文件显得太复杂，因此一些开发者支持把babel的配置选项可以放在一个单独的名为 ".babelrc" 的配置文件中。我们现在的babel的配置并不算复杂，不过之后我们会再加一些东西，因此现在我们就提取出相关部分，分两个配置文件进行配置（不用担心webpack会自动调用.babelrc里的babel配置选项），如下：

// webpack.config.js
module.exports = {
devtool: 'eval-source-map',

entry: dirname + "/app/main.js",
output: {
path: dirname + "/public",
filename: "bundle.js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
}
]
},

devServer: {...} // Omitted for brevity
}

//.babelrc
{
"presets": ["react", "es2015"]
}
到目前为止，我们已经知道了，对于模块，Webpack能提供非常强大的处理功能，那那些是模块呢。

一切皆模块

Webpack有一个不可不说的优点，它把所有的文件都可以当做模块处理，包括你的JavaScript代码，也包括CSS和fonts以及图片等等等，只有通过合适的loaders，它们都可以被当做模块被处理。

CSS

webpack提供两个工具处理样式表，css-loader 和 style-loader，二者处理的任务不同，css-loader使你能够使用类似@import 和 url(...)的方法实现 require()的功能,style-loader将所有的计算后的样式加入页面中，二者组合在一起使你能够把样式表嵌入webpack打包后的JS文件中。

继续上面的例子

//安装npm install --save-dev style-loader css-loader

//使用
module.exports = {
devtool: 'eval-source-map',

entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "bundle.js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: 'style!css'//添加对样式表的处理
}
]
},

devServer: {...}
}
注：感叹号的作用在于使同一文件能够使用不同类型的loader

接下来，在app文件夹里创建一个名字为"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 “中，如下

//main.js
import React from 'react';
import {render} from 'react-dom';
import Greeter from './Greeter';

import './main.css';//使用require导入css文件

render(, document.getElementById('root'));
通常情况下，css会和js打包到同一个文件中，并不会打包为一个单独的css文件，不过通过合适的配置webpack也可以把css打包为单独的文件的。

不过这也只是webpack把css当做模块而已，咱们继续看看一个真的CSS模块的实践。

CSS module

在过去的一些年里，JavaScript通过一些新的语言特性，更好的工具以及更好的实践方法（比如说模块化）发展得非常迅速。模块使得开发者把复杂的代码转化为小的，干净的，依赖声明明确的单元，且基于优化工具，依赖管理和加载管理可以自动完成。

不过前端的另外一部分，CSS发展就相对慢一些，大多的样式表却依旧是巨大且充满了全局类名，这使得维护和修改都非常困难和复杂。

最近有一个叫做 CSS modules 的技术就意在把JS的模块化思想带入CSS中来，通过CSS模块，所有的类名，动画名默认都只作用于当前模块。Webpack从一开始就对CSS模块化提供了支持，在CSS loader中进行配置后，你所需要做的一切就是把”modules“传递都所需要的地方，然后就可以直接把CSS的类名传递到组件的代码中，且这样做只对当前组件有效，不必担心在不同的模块中具有相同的类名可能会造成的问题。具体的代码如下

module.exports = {
devtool: 'eval-source-map',

entry: __dirname + "/app/main.js",
output: {...},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: 'style!css?modules'//跟前面相比就在后面加上了?modules
}
]
},

devServer: {...}
}
创建一个Greeter.css文件

.root {  background-color: # eee;  padding: 10px;  border: 3px solid # ccc;}

导入.root到Greeter.js中

import React, {Component} from 'react';
import config from './config.json';
import styles from './Greeter.css';//导入

class Greeter extends Component{
render() {
return (
//添加类名
{config.greetText}

);

}
}

export default Greeter
放心使用把，相同的类名也不会造成不同组件之间的污染。

CSS modules 也是一个很大的主题，有兴趣的话可以去官方文档查看更多消息。

CSS预处理器

Sass 和 Less之类的预处理器是对原生CSS的拓展，它们允许你使用类似于variables, nesting, mixins, inheritance等不存在于CSS中的特性来写CSS，CSS预处理器可以这些特殊类型的语句转化为浏览器可识别的CSS语句，你现在可能都已经熟悉了，在webpack里使用相关loaders进行配置就可以使用了，以下是常用的CSS 处理loaders

  1. Less Loader

  2. Sass Loader

  3. Stylus Loader

不过其实也存在一个CSS的处理平台-PostCSS，它可以帮助你的CSS实现更多的功能，在其CSS官方文档可了解更多相关知识。

举例来说如何使用PostCSS，我们使用PostCSS来为CSS代码自动添加适应不同浏览器的CSS前缀。

首先安装postcss-loader 和 autoprefixer（自动添加前缀的插件）

npm install --save-dev postcss-loader autoprefixer

接下来，在webpack配置文件中进行设置，只需要新建一个postcss关键字，并在里面申明依赖的插件，如下，现在你写的css会自动根据Can i use里的数据添加不同前缀了。

//webpack配置文件
module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js",
output: {...},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: 'style!css?modules!postcss'
}
]
},

postcss: [
require('autoprefixer')//调用autoprefixer插件
],

devServer: {...}
}
到现在，本文已经涉及到处理JS的Babel和处理CSS的PostCSS，它们其实也是两个单独的平台，配合Webpack可以很好的发挥它们的作用。接下来介绍Webpack中另一个非常重要的功能-Plugins

插件（Plugins）

插件（Plugins）是用来拓展Webpack功能的，它们会在整个构建过程中生效，执行相关的任务。
Loaders和Plugins常常被弄混，但是他们其实是完全不同的东西，可以这么来说，loaders是在打包构建过程中用来处理源文件的（JSX，Scss，Less..），一次处理一个，插件并不直接操作单个文件，它直接对整个构建过程其作用。

Webpack有很多内置插件，同时也有很多第三方插件，可以让我们完成更加丰富的功能。

使用插件的方法

要使用某个插件，我们需要通过npm安装它，然后要做的就是在webpack配置中的plugins关键字部分添加该插件的一个实例（plugins是一个数组）继续看例子，我们添加了一个实现版权声明的插件。

//webpack.config.js
var webpack = require('webpack');

module.exports = {
devtool: 'eval-source-map',
entry: __dirname + "/app/main.js",
output: {...},

module: {
loaders: [
{ test: /.json$/, loader: "json" },
{ test: /.js$/, exclude: /node_modules/, loader: 'babel' },
{ test: /.css$/, loader: 'style!css?modules!postcss' }//这里添加PostCSS
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new webpack.BannerPlugin("Copyright Flying Unicorns inc.")//在这个数组中new一个就可以了
],

devServer: {...}
}
通过这个插件，打包后的JS文件显示如下

知道Webpack中的插件如何使用了，下面给大家推荐几个常用的插件

HtmlWebpackPlugin

这个插件的作用是依据一个简单的模板，帮你生成最终的Html5文件，这个文件中自动引用了你打包后的JS文件。每次编译都在文件名中插入一个不同的哈希值。

安装

npm install --save-dev html-webpack-plugin

这个插件自动完成了我们之前手动做的一些事情，在正式使用之前需要对一直以来的项目结构做一些改变：

  1. 移除public文件夹，利用此插件，HTML5文件会自动生成，此外CSS已经通过前面的操作打包到JS中了，public文件夹里。

  2. 在app目录下，创建一个Html文件模板，这个模板包含title等其它你需要的元素，在编译过程中，本插件会依据此模板生成最终的html页面，会自动添加所依赖的 css, js，favicon等文件，在本例中我们命名模板文件名称为index.tmpl.html，模板源代码如下

    Webpack Sample Project

  3. 更新webpack的配置文件，方法同上,新建一个build文件夹用来存放最终的输出文件

var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
devtool: 'eval-source-map',

entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "bundle.js"
},

module: {
loaders: [
{ test: /.json$/, loader: "json" },
{ test: /.js$/, exclude: /node_modules/, loader: 'babel' },
{ test: /.css$/, loader: 'style!css?modules!postcss' }
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"//new 一个这个插件的实例，并传入相关的参数
})
],

devServer: {
colors: true,
historyApiFallback: true,
inline: true
}
}

Hot Module Replacement

Hot Module Replacement（HMR）也是webpack里很有用的一个插件，它允许你在修改组件代码后，自动刷新实时预览修改后的效果。

在webpack中实现HMR也很简单，只需要做两项配置

  1. 在webpack配置文件中添加HMR插件；

  2. 在Webpack Dev Server中添加“hot”参数；

不过配置完这些后，JS模块其实还是不能自动热加载的，还需要在你的JS模块中执行一个Webpack提供的API才能实现热加载，虽然这个API不难使用，但是如果是React模块，使用我们已经熟悉的Babel可以更方便的实现功能热加载。

整理下我们的思路，具体实现方法如下

  1. Babel和webpack是独立的工具

  2. 二者可以一起工作

  3. 二者都可以通过插件拓展功能

  4. HMR是一个webpack插件，它让你能浏览器中实时观察模块修改后的效果，但是如果你想让它工作，需要对模块进行额外的配额；

  5. Babel有一个叫做react-transform-hrm的插件，可以在不对React模块进行额外的配置的前提下让HMR正常工作；

更新我们的例子来实际看看如何配置

//webpack中的配置
var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
devtool: 'eval-source-map',
entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "bundle.js"
},

module: {
loaders: [
{ test: /.json$/, loader: "json" },
{ test: /.js$/, exclude: /node_modules/, loader: 'babel' },
{ test: /.css$/, loader: 'style!css?modules!postcss' }
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.HotModuleReplacementPlugin()//热加载插件
],

devServer: {
colors: true,
historyApiFallback: true,
inline: true,
hot: true
}
}

安装react-transform-hmr

npm install --save-dev babel-plugin-react-transform react-transform-hmr

配置Babel

{
"presets": ["react", "es2015"],
"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很像，如下

var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "bundle.js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: 'style!css?modules!postcss'
}
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
],

}
//package.json
{
"name": "webpack-sample-project",
"version": "1.0.0",
"description": "Sample webpack project",
"scripts": {
"start": "webpack-dev-server --progress",
"build": "NODE_ENV=production webpack --config ./webpack.production.config.js --progress"
},
"author": "Cássio Zen",
"license": "ISC",
"devDependencies": {...},
"dependencies": {...}
}

优化插件

webpack提供了一些在发布阶段非常有用的优化插件，它们大多来自于webpack社区，可以通过npm安装，通过以下插件可以完成产品发布阶段所需的功能

  1. OccurenceOrderPlugin：为组件分配ID，通过这个插件webpack可以分析和优先考虑使用最多的模块，并为它们分配最小的ID

  2. UglifyJsPlugin：压缩JS代码；

  3. ExtractTextPlugin：分离CSS和JS文件

我们继续用例子来看看如何添加它们，OccurenceOrder 和 UglifyJS plugins 都是内置插件，你需要做的只是安装它们

npm install --save-dev extract-text-webpack-plugin

在配置文件的plugins后引用它们

var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');
var ExtractTextPlugin = require('extract-text-webpack-plugin');

module.exports = {
entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "bundle.js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: ExtractTextPlugin.extract('style', 'css?modules!postcss')
}
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.optimize.OccurenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("style.css")
]
}

缓存

缓存无处不在，使用缓存的最好方法是保证你的文件名和文件内容是匹配的（内容改变，名称相应改变）

webpack可以把一个哈希值添加到打包的文件名中，使用方法如下,添加特殊的字符串混合体（[name], [id] and [hash]）到输出文件名前

var webpack = require('webpack');
var HtmlWebpackPlugin = require('html-webpack-plugin');
var ExtractTextPlugin = require('extract-text-webpack-plugin');

module.exports = {
entry: dirname + "/app/main.js",
output: {
path: dirname + "/build",
filename: "[name]-[hash].js"
},

module: {
loaders: [
{
test: /.json$/,
loader: "json"
},
{
test: /.js$/,
exclude: /node_modules/,
loader: 'babel'
},
{
test: /.css$/,
loader: ExtractTextPlugin.extract('style', 'css?modules!postcss')
}
]
},
postcss: [
require('autoprefixer')
],

plugins: [
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.optimize.OccurenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("[name]-[hash].css")
]
}
现在用户会有合理的缓存了。

总结

这是一篇好长的文章，谢谢你的耐心，能仔细看到了这里，大概半个月前我第一次自己一步步配置项目所需的Webpack后就一直想写一篇笔记做总结，几次动笔都不能让自己满意，总觉得写不清楚。直到看到本文的英文版Webpack for React，真的有多次豁然开朗的感觉，喜欢看原文的点链接就可以看了。其实关于Webpack本文讲述得仍不完全，不过相信以进入Webpack的大门，能够更好的探索其它的关于Webpack的知识了。

最后欢迎大家在文后发表自己的观点讨论。

关键字：webpack, 模块化开发


本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！

相关文章

如何打造一个令人愉悦的前端开发环境（二）

入门 Webpack，看这篇就够了

使用CommonJS，AMD以及CMD编写模块化JavaScripts

基于react/redu/antd，写了一个demo，欢迎一起研究

彻底解决Webpack打包慢的问题

Meteor+Vue 从入门到放弃

webpack打包node.js后端项目

学习meteor时遇到的问题

cooking 更易上手的前端构建工具

心路历程：vue2.0+webpack+koa2 前后端同构实践（一）

webpack 教程资源收集

webpack文章(持续更新)

Webpack的dll功能

使用 webpack + react + redu + es6 开发组件化前端项目

webpack 教程资源分享

React技术栈——HotModuleReplacement

-webkit-fle 被移除了

webpack 单页面应用实战

webpack进阶之loader篇

webpack使用之基础篇

使用webpack构建多页面应用

从零开始 - 使用React+Webpack+Nodejs+Epress快速构建项目

Chrome 浏览器的 source-map 功能

使用 Webpack 为单页面应用发布新版本

React 踩坑之旅 --2016-6-15更新

Webpack 指南（整理 草稿）

基于Vue的简单的单页面应用的实现

[译] Webpack 前端构建集成方案

利用webpack和vue实现组件化

手把手深入理解 webpack dev middleware 原理與相關 plugins

webpack+vue起步

webpack使用优化（react篇）

立即
投稿

微信公众账号

微信扫一扫加关注

 返回
顶部