Webpack 学习笔记总结

Webpack安装

Linux系统默认已经安装了node＆npm，但版本比较低，而且没法升级，可以重新下载Node然后通过软链接替换系统自带的node和npm;

ln -s /path_to/bin/node /usr/local/bin/node

ln -s /path_to/bin/npm /usr/local/bin/npm

参考：http://blog.csdn.net/dxywx/article/details/51396234

安装webpack

# 安装到项目目录

npm install --save-dev webpack

# 全局安装

npm install -g webpack

Preheating

将src.js打包输出到des.js

webpack src.js des.js

如果项目中有webpack.config.js, 直接使用如下命令进行打包

webpack

一个最简单的webpack.config.js文件如下

var webpack = require('webpack');

module.exports = {

    entry: __dirname + "/app/main.js", // 入口文件

    output: {

        path: __dirname + "/public", // 打包后文件存在目录

        filename: 'bundle.js'

    },

}

还可以在package.json里面配置以便快捷打包，也是最常用的方式

"scripts": {

    "start": "webpack" // 相当于把npm的start命令指向webpack命令

}

package.json中的脚本部分已经默认在命令前添加了node_modules/.bin路径，所以无论是全局还是局部安装的Webpack，都不需要指明详细的路径了。

npm的start是一个特殊的脚本名称，它的特殊性在于在命令行中使用npm start就可以执行相关命令，如果对应的此脚本名称不是start，想要在命令行中运行时，需要这样用npm run {script name}如npm run build。

HelloWorld

先创建index.html，该文件需要用到一个外部的bundle.js文件，该文件是接下来通过webpack生成的文件

<html>

    <head>

    </head>

<body>

    <div id="root"></div>

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

</body>

</html>

接下来创建一个src.js，用于通过webpack打包输出到bundle.js正式文件

function addGreet() {

    var div = document.getElementById('root');

    div.textContent = 'Hello world';

}

addGreet();

执行命令，然后在浏览器中打开index.html文件

webpack src.js bundle.js

Source Maps

开发总是离不开调试，如果可以更加方便的调试当然就能提高开发效率，不过打包后的文件有时候你是不容易找到出错了的地方对应的源代码的位置的，Source Maps就是来帮我们解决这个问题的。
通过简单的配置后，Webpack在打包时可以为我们生成的source maps，这为我们提供了一种对应编译文件和源文件的方法，使得编译后的代码可读性更高，也更容易调试。

在webpack的配置文件中配置source maps，需要配置devtool，它有以下四种不同的配置选项，各具优缺点。

source-map：在一个单独的文件中产生一个完整且功能完全的文件。这个文件具有最好的source map，但是它会减慢打包文件的构建速度；
cheap-module-source-map：在一个单独的文件中生成一个不带列映射的map，不带列映射提高项目构建速度，但是也使得浏览器开发者工具只能对应到具体的行，不能对应到具体的列（符号），会对调试造成不便；
eval-source-map：使用eval打包源文件模块，在同一个文件中生成干净的完整的source map。这个选项可以在不影响构建速度的前提下生成完整的sourcemap，但是对打包后输出的JS文件的执行具有性能和安全的隐患。不过在开发阶段这是一个非常好的选项，但是在生产阶段一定不要用这个选项；
cheap-module-eval-source-map：这是在打包文件时最快的生成source map的方法，生成的Source Map 会和打包后的JavaScript文件同行显示，没有列映射，和eval-source-map选项具有相似的缺点；

上述选项由上到下打包速度越来越快，不过同时也具有越来越多的负面作用，较快的构建速度的后果就是对打包后的文件的的执行有一定影响。
在学习阶段以及在小到中型的项目上，eval-source-map是一个很好的选项，不过记得只在开发阶段使用它，在webpack.config.js文件中进行如下配置

module.exports = {

  devtool: 'eval-source-map',//配置生成Source Maps，选择合适的选项

  entry:  __dirname + "/app/main.js",

  output: {

    path: __dirname + "/public",

    filename: "bundle.js"

  }

}

cheap-module-eval-source-map方法构建速度更快，但是不利于调试，推荐在大型项目考虑到时间成本时使用。

dev-server

Webpack提供一个可选的本地开发服务器，让你的浏览器监测你对代码的修改，并自动刷新修改后的结果，这个本地服务器基于node.js构建，可以实现你想要的这些功能，不过它是一个单独的组件，在webpack中进行配置之前需要单独安装它作为项目依赖

npm install --save-dev webpack-dev-server

devserver作为webpack配置选项中的一项，具有以下配置选项

contentBase: 默认webpack-dev-server会为根文件夹提供本地服务器，如果想为另外一个目录下的文件提供本地服务器，应该在这里设置其所在目录（本例设置到“public"目录）
port: 设置默认监听端口，如果省略，默认为”8080“
inline: 设置为true，当源文件改变时会自动刷新页面
colors: 设置为true，使终端输出的文件为彩色的
historyApiFallback: 在开发单页应用时非常有用，它依赖于HTML5 history API，如果设置为true，所有的跳转将指向index.html

继续把这些命令加到webpack的配置文件中，配置如下

module.exports = {

  devtool: 'eval-source-map',

  entry:  __dirname + "/app/main.js",

  output: {

    path: __dirname + "/public",

    filename: "bundle.js"

  },

  devServer: {

    contentBase: "./public", //本地服务器所加载的页面所在的目录

    colors: true, //终端中输出结果为彩色

    historyApiFallback: true, //不跳转

    inline: true //实时刷新

  }

}

启动webpack-dev-server，然后在浏览器中输入http://127.0.0.1:8080查看页面；

webpack-dev-server --progress --colors

也可以将上述命令配置到package.json文件中的启动命令中，然后直接使用webpack命令即可；

Loaders

通过使用不同的loader，webpack通过调用外部的脚本或工具可以对各种各样的格式的文件进行处理，比如说分析JSON文件并把它转换为JavaScript文件，或者说把下一代的JS文件（ES6，ES7)转换为现代浏览器可以识别的JS文件。或者说对React的开发而言，合适的Loaders可以把React的JSX文件转换为JS文件。

Loaders需要单独安装并且需要在webpack.config.js下的modules关键字下进行配置，Loaders有如下几个配置选项：

test：一个匹配loaders所处理的文件的拓展名的正则表达式（必须）
loader：loader的名称（必须）
include/exclude:手动添加必须处理的文件（文件夹）或屏蔽不需要处理的文件（文件夹）（可选）；
query：为loaders提供额外的设置选项（可选）

下面通过一个例子来查看：Greeter.js里有一条问候消息，但这条消息内容是放在一个单独的JSON文件里的，需要通过合适的配置使Greeter.js可以读取该JSON文件的值，配置方法如下

module.exports = {

  module: { // 在配置文件里添加JSON loader

    loaders: [

      {

        test: /\.json$/,

        loader: "json"

      }

    ]

  },

}

创建config.json和Greeter.js
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;

};

src.js

var greeter = require('./Greeter.js');

document.getElementById('root').appendChild(greeter());

Babel

Babel其实是一个编译JavaScript的平台，它的强大之处表现在可以通过编译帮你达到以下目的：

下一代的JavaScript标准（ES6，ES7），这些标准目前并未被当前的浏览器完全的支持;
使用基于JavaScript进行了拓展的语言，比如React的JSX;

Babel的安装与配置

Babel其实是几个模块化的包，其核心功能位于称为babel-core的npm包中，不过webpack把它们整合在一起使用，但是对于每一个你需要的功能或拓展，你都需要安装单独的包（用得最多的是解析Es6的babel-preset-es2015包和解析JSX的babel-preset-react包）。

我们先来一次性安装这些依赖包

npm install --save-dev babel-core babel-loader babel-preset-es2015 babel-preset-react

在webpack中配置Babel

  module: {

    loaders: [

      {

        test: /\.js$/,

        exclude: /node_modules/,

        loader: 'babel', // 在webpack的module部分的loaders里进行配置即可

        query: {

          presets: ['es2015','react']

        }

      }

    ]

  },

配置好之后就可以使用ES6的JSX语法了；
安装 React 和 React-DOM

npm install react react-dom

使用ES6的语法，更新Greeter.js并返回一个React组件
Greeter.js

import React, {Component} from 'react'

import config from './config.json';

class Greeter extends Component{

  render() {

    return (

      <div>

        {config.greetText}

      </div>

    );

  }

}

export default Greeter

使用ES6的模块定义和react-dom的渲染函数来加载呈现Greeter模块

import React from 'react';

import {render} from 'react-dom';

import Greeter from './Greeter';

render(<Greeter />, 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"]

}

CSS

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

  module: {

    loaders: [

      {

        test: /\.css$/,

        loader: 'style!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:;

  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;

}

h1, h2, h3, h4, h5, h6, p, ul {

  margin:;

  padding:;

}

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(<Greeter />, document.getElementById('root'));

通常情况下，css会和js打包到同一个文件中，并不会打包为一个单独的css文件，不过通过合适的配置webpack也可以把css打包为单独的文件的。不过这也只是webpack把css当做模块而已，咱们继续看看一个真的CSS模块的实践。

CSS module

大多的样式表依旧是巨大且充满了全局类名，这使得维护和修改都非常困难和复杂。
CSS modules 就意在把JS的模块化思想带入CSS中来，通过CSS模块，所有的类名，动画名默认都只作用于当前模块。Webpack从一开始就对CSS模块化提供了支持，在CSS loader中进行配置后，你所需要做的一切就是把”modules“传递到所需要的地方，然后就可以直接把CSS的类名传递到组件的代码中，且这样做只对当前组件有效，不必担心在不同的模块中具有相同的类名可能会造成的问题。
在webpack.config.js中添加配置

      {

        test: /\.css$/,

        loader: 'style!css?modules' // 跟前面相比就在后面加上了?modules

      }

Greeter.css

.root {

  background-color: #eee;

  padding: 10px;

  border: 3px solid #ccc;

}

Greeter.js

import React, {Component} from 'react';

import config from './config.json';

import styles from './Greeter.css'; //导入

class Greeter extends Component{

  render() {

    return (

      <div className={styles.root}> // 添加类名

        {config.greetText}

      </div>

    );

  }

}

export default Greeter

相同的类名也不会造成不同组件之间的污染。

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关键字，并在里面申明依赖的插件，如下，现在你写的css会自动根据Can i use里的数据添加不同前缀了。
webpack.config.js

module.exports = {

  module: {

    loaders: [

      {

        test: /\.js$/,

        exclude: /node_modules/,

        loader: 'babel'

      },

      {

        test: /\.css$/,

        loader: 'style!css?modules!postcss'

      }

    ]

  },

  postcss: [

    require('autoprefixer')//调用autoprefixer插件

  ],

  devServer: {...}

}

上面已经涉及到处理JS的Babel和处理CSS的PostCSS，它们其实也是两个单独的平台，配合Webpack可以很好的发挥它们的作用。

Plugins

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

要使用某个插件，我们需要通过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: {...}

}

BannerPlugin 这个插件用于在生成的文件最顶部添加一些文件的信息;

HtmlWebpackPlugin

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

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

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

移除public文件夹，利用此插件，HTML5文件会自动生成，此外CSS已经通过前面的操作打包到JS中了，public文件夹里。
在app目录下，创建一个Html文件模板，这个模板包含title等其它你需要的元素，在编译过程中，本插件会依据此模板生成最终的html页面，会自动添加所依赖的 css, js，favicon等文件，在本例中我们命名模板文件名称为index.tmpl.html，模板源代码如下

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

    <title>Webpack Sample Project</title>

  </head>

  <body>

    <div id='root'>

    </div>

  </body>

</html>

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

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: {...}

}

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正常工作；

配置webpack.config.js

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时，可以热加载模块了.

产品阶段的构建

在产品阶段，还需要对打包的文件进行额外的处理，比如说优化，压缩，缓存以及分离CSS和JS。
对于复杂的项目来说，需要复杂的配置，这时候分解配置文件为多个小的文件可以使得事情井井有条，以上面的例子来说，我们创建一个“webpack.production.config.js”的文件，在里面加上基本的配置,它和原始的webpack.config.js很像，如下

webpack.production.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安装，通过以下插件可以完成产品发布阶段所需的功能

OccurenceOrderPlugin :为组件分配ID，通过这个插件webpack可以分析和优先考虑使用最多的模块，并为它们分配最小的ID
UglifyJsPlugin：压缩JS代码；
ExtractTextPlugin：分离CSS和JS文件

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

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

在配置文件的plugins后引用它们
webpack.config.js

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 entry.js bundle.js 将 entry.js 打包输出到 bundle.js, webpack会自动把相关的依赖库给打包进去；
webpack 会分析入口文件，解析包含依赖关系的各个文件，这些文件(模块)都被打包到bundle.js，webpack会给每个模块分配一个唯一的id并通过这个id索引和访问模块，
在页面启动时，会先执行entry.js中的代码，其它模块会在运行 require 的时候再被执行；

src.js

// v1

document.write('It works.');

// v2: 添加模块

document.write(require('./module.js'));

生成的bundle.js部分内容如下：

/** v2

 function(module, exports, __webpack_require__) {

    // v1

    document.write('It works.');

    // v2: 添加模块

    document.write(__webpack_require__(1));

},

 function(module, exports) {

    module.exports = 'It works from module.js';

}

 */

// http://www.jianshu.com/p/42e11515c10f#
// http://www.pro-react.com/materials/appendixA/