一、什麼是webpack
本質上,webpack 是一個現代 JavaScript 應用程序的靜態模塊打包器(module bundler)。當 webpack 處理應用程序時,它會遞歸地構建一個依賴關係圖(dependency graph),其中包含應用程序需要的每個模塊,然後將所有這些模塊打包成一個或多個 bundle。
二、webpack.config.js 的基本配置
webpack 配置中文文檔
const HtmlWebpackPlugin = require('html-webpack-plugin');
// 該插件的主要是爲了抽離css樣式,防止將樣式打包在js中引起頁面樣式加載錯亂的現象
const ExtractTextPlugin = require('extract-text-webpack-plugin');
module.exports = {
entry: __dirname + "/app/main.js", //已多次提及的唯一入口文件
output: {
path: __dirname + "/build",
filename: "bundle-[hash].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: ExtractTextPlugin.extract({
fallback: "style-loader",
use: [{
loader: "css-loader",
options: {
modules: true,
localIdentName: '[name]__[local]--[hash:base64:5]'
}
}, {
loader: "postcss-loader"
}],
})
}
}
]
},
plugins: [
new webpack.BannerPlugin('版權所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html" //new 一個這個插件的實例,並傳入相關的參數
}),
new webpack.optimize.OccurrenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("style.css")
]
};
二、使用webpack構建本地服務器
想不想讓你的瀏覽器監聽你的代碼的修改,並自動刷新顯示修改後的結果,其實Webpack
提供一個可選的本地開發服務器,這個本地服務器基於node.js構建,可以實現你想要的這些功能,不過它是一個單獨的組件,在webpack中進行配置之前需要單獨安裝它作爲項目依賴
npm install --save-dev webpack-dev-server
devserver作爲webpack配置選項中的一項,以下是它的一些配置選項,更多配置可參考這裏
devserver的配置選項 | 功能描述 |
---|---|
contentBase | 默認webpack-dev-server會爲根文件夾提供本地服務器,如果想爲另外一個目錄下的文件提供本地服務器,應該在這裏設置其所在目錄(本例設置到“public"目錄) |
port | 設置默認監聽端口,如果省略,默認爲”8080“ |
inline | 設置爲true ,當源文件改變時會自動刷新頁面 |
historyApiFallback | 在開發單頁應用時非常有用,它依賴於HTML5 history API,如果設置爲true ,所有的跳轉將指向index.html |
把這些命令加到webpack的配置文件中,現在的配置文件webpack.config.js
如下所示
module.exports = {
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"
},
三、生成Source Maps(使調試更容易)
通過簡單的配置,webpack
就可以在打包時爲我們生成的source maps
,這爲我們提供了一種對應編譯文件和源文件的方法,使得編譯後的代碼可讀性更高,也更容易調試。
在webpack
的配置文件中配置source maps
,需要配置devtool
,它有以下四種不同的配置選項,各具優缺點,描述如下:
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',
entry: __dirname + "/app/main.js",
output: {
path: __dirname + "/public",
filename: "bundle.js"
},
devServer: {
contentBase: "./public",//本地服務器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉
inline: true//實時刷新
}
}
cheap-module-eval-source-map
方法構建速度更快,但是不利於調試,推薦在大型項目考慮時間成本時使用。
四、Loaders 的使用
Loaders需要單獨安裝並且需要在webpack.config.js
中的modules
關鍵字下進行配置,Loaders的配置包括以下幾方面:
test
:一個用以匹配loaders所處理文件的拓展名的正則表達式(必須)loader
:loader的名稱(必須)include/exclude
:手動添加必須處理的文件(文件夾)或屏蔽不需要處理的文件(文件夾)(可選);query
:爲loaders提供額外的設置選項(可選)
五、Babel
Babel其實是一個編譯JavaScript的平臺,它可以編譯代碼幫你達到以下目的:
- 讓你能使用最新的JavaScript代碼(ES6,ES7...),而不用管新標準是否被當前使用的瀏覽器完全支持;
- 讓你能使用基於JavaScript進行了拓展的語言,比如React的JSX
安裝這些依賴包
// npm一次性安裝多個依賴模塊,模塊之間用空格隔開
npm install --save-dev babel-core babel-loader babel-preset-env babel-preset-react
Babel可以完全在 webpack.config.js
中進行配置,但是在單一的webpack.config.js
文件中進行配置使得這個文件顯得太複雜,因此一些開發者支持把 babel 的 options 配置選項放在一個單獨的名爲 ".babelrc" 的配置文件中。
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//實時刷新
},
// Bable 配置
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader",
// 如果把options單獨放在.babelrc文件中,這裏的options就不用配置了
options: {
presets: [
"env", "react"
]
}
},
exclude: /node_modules/
}
]
}
};
//.babelrc
{
"presets": ["react", "env"]
}
六、配置解析 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 = {
entry: __dirname + "/app/main.js",//已多次提及的唯一入口文件
output: {
path: __dirname + "/public",//打包後的文件存放的地方
filename: "bundle.js"//打包後輸出文件的文件名
},
devtool: 'eval-source-map',
devServer: {
contentBase: "./public",//本地服務器所加載的頁面所在的目錄
historyApiFallback: true,//不跳轉
inline: true//實時刷新
},
// Bable 配置
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
use: {
loader: "babel-loader"
},
exclude: /node_modules/
},
{
test: /\.css$/,
use: [
{
loader: "style-loader"
}, {
loader: "css-loader"
}
]
}
]
}
};
請注意這裏對同一個文件引入多個loader的方法。
6.1、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.js
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//實時刷新
},
// Bable 配置
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.js
module.exports = {
plugins: [
require('autoprefixer')
]
}
6.2、CSS module
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文件夾下創建一個Index.css
文件來進行一下測試
/* Index.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 './Index.css';//導入
class Index extends Component{
render() {
return (
<div className={styles.root}> //使用cssModule添加類名的方法
{config.greetText}
</div>
);
}
}
export default Index
CSS modules 也是一個很大的主題,有興趣的話可以去其官方文檔瞭解更多。
七、插件(Plugins)
webpack插件(Plugins)是用來拓展Webpack功能的,它們會在整個構建過程中生效,執行相關的任務。Webpack有很多內置插件,同時也有很多第三方插件,可以讓我們完成更加豐富的功能。
7.1、使用插件的方法
要使用某個插件,我們需要通過npm
安裝它,然後要做的就是在webpack配置中的plugins關鍵字部分添加該插件的一個實例(plugins是一個數組),添加了一個給打包後代碼添加版權聲明的插件。
const webpack = 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: [
new webpack.BannerPlugin('版權所有,翻版必究')
],
};
這就是webpack插件的基礎用法了,下面給大家推薦幾個常用的插件
7.2、插件 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>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Webpack Sample Project</title>
</head>
<body>
<div id='root'>
</div>
</body>
</html>
3.更新webpack
的配置文件,方法同上,新建一個build
文件夾用來存放最終的輸出文件
const webpack = require('webpack');
const HtmlWebpackPlugin = 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//實時刷新
},
// Babel 配置
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: [
new webpack.BannerPlugin('版權所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"//new 一個這個插件的實例,並傳入相關的參數
})
],
};
再次執行npm start
你會發現,build文件夾下面生成了bundle.js
和index.html
。
7.3、插件 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正常工作;
配置如下:
const webpack = require('webpack');
const HtmlWebpackPlugin = 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: [
new webpack.BannerPlugin('版權所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"//new 一個這個插件的實例,並傳入相關的參數
}),
new webpack.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時,可以熱加載模塊了,每次保存就能在瀏覽器上看到更新內容。
7.4、插件 extract-text-webpack-plugin
作用:該插件的主要是爲了抽離css樣式,防止將樣式打包在js中引起頁面樣式加載錯亂的現象
安裝:插件安裝命令如下:
npm install extract-text-webpack-plugin --save-dev
使用:在webpack.config.js中引入
const ExtractTextPlugin = require("extract-text-webpack-plugin");
module.exports = {
module: {
rules: [
{
test: /\.css$/,
use: ExtractTextPlugin.extract({
fallback: "style-loader", // 編譯後用什麼loader來提取css文件
use: "css-loader" // 指需要什麼樣的loader去編譯文件,這裏由於源文件是.css所以選擇css-loader
})
}
]
},
plugins: [
new ExtractTextPlugin("styles.css"),
]
}
插件參數:該插件有三個參數意義分別如下:
use:指需要什麼樣的loader去編譯文件,這裏由於源文件是.css所以選擇css-loader
fallback:編譯後用什麼loader來提取css文件
publicfile:用來覆蓋項目路徑,生成該css文件的文件路徑
7.5、插件優化
webpack提供了一些在發佈階段非常有用的優化插件,可以通過npm安裝,通過以下插件可以完成產品發佈階段所需的功能。
OccurenceOrderPlugin
:爲組件分配ID,通過這個插件webpack可以分析和優先考慮使用最多的模塊,併爲它們分配最小的IDUglifyJsPlugin
:壓縮JS代碼;ExtractTextPlugin
:分離CSS和JS文件
OccurenceOrder 和 UglifyJS plugins 都是內置插件,你需要做的只是安裝其它非內置插件
npm install --save-dev extract-text-webpack-plugin
在配置文件的plugins後引用它們
// webpack.production.config.js
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = 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: [
new webpack.BannerPlugin('版權所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html"
}),
new webpack.optimize.OccurrenceOrderPlugin(),
new webpack.optimize.UglifyJsPlugin(),
new ExtractTextPlugin("style.css")
],
};
八、構建產品發佈環境
對於複雜的項目來說,需要複雜的配置,這時候分解配置文件爲多個小的文件可以使得事情井井有條,以上面的例子來說,我們創建一個webpack.production.config.js
的文件,在裏面加上基本的配置,它和原始的webpack.config.js很像,如下
// webpack.production.config.js
const webpack = require('webpack');
const HtmlWebpackPlugin = 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: [
new webpack.BannerPlugin('版權所有,翻版必究'),
new HtmlWebpackPlugin({
template: __dirname + "/app/index.tmpl.html" //new 一個這個插件的實例,並傳入相關的參數
}),
new webpack.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可以把一個哈希值添加到打包的文件名中,使用方法如下,添加特殊的字符串混合體([name], [id] and [hash])到輸出文件名前
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
module.exports = {
..
output: {
path: __dirname + "/build",
filename: "bundle-[hash].js"
},
...
};
9.1、去除build
文件中的殘餘文件
添加了hash
之後,會導致改變文件內容後重新打包時,文件名不同而內容越來越多,因此這裏介紹另外一個很好用的插件clean-webpack-plugin
。
安裝:
cnpm install clean-webpack-plugin --save-dev
使用:
引入clean-webpack-plugin
插件後在配置文件的plugins
中做相應配置即可:
const CleanWebpackPlugin = require("clean-webpack-plugin");
plugins: [
...// 這裏是之前配置的其它各種插件
new CleanWebpackPlugin('build/*.*', {
root: __dirname,
verbose: true,
dry: false
})
]
關於clean-webpack-plugin
的詳細使用可參考這裏