建站
咨詢
售后
建站咨詢
新聞中心
前言
本文講述的最佳實踐是從日常業(yè)務中總結而出的，不一定適合所有項目。畢竟每個公司或個人的項目不同，最佳實踐也會有所不同。但是可以從這篇文章借鑒吸收一點有用的東西。
成都創(chuàng)新互聯公司2013年成立，先為臨沭等服務建站，臨沭等地企業(yè)，進行企業(yè)商務咨詢服務。為臨沭企業(yè)網站制作PC+手機+微官網三網同步一站式服務解決您的所有建站問題。
為了避免出現 我這明明可以，你那怎么不行 的尷尬情況，這里列一下文章涉及到依賴的版本號。
- ├── webpack 5.39.1
- ├── webpack-cli 4.7.2
- ├── node 12.8.0
- ├── npm 6.10.2
正文
初始化項目
- 1. mkdir test-app && cd test-app
- 2. npm init
首先添加一個入口文件 /src/index.js 和 webpack 配置文件 webpack.config.js，現在我們的目錄結構如下
- test-app
- ├── src
- | └── index.js
- ├── package.json
- ├── webpack.config.js
安裝 webpack
- npm install webpack webpack-cli -D
開始搞事情
在 src/index.js 中隨便寫點東西
- class Test {
- constructor() {
- document.writeTest('hello world')
- }
- }
- new Test()
先來打個包看看啥效果， 執(zhí)行命令 npx webpack
等待一段時間后，看到目錄有了變化, 新增了一個 dist 目錄，該目錄下有一個 main.js 文件
- test-app
- + ├── dist
- + | └── main.js
- ├── src
- | └── index.js
- ├── package.json
- ├── webpack.config.js
讓我們來看看 main.js 里有點啥
- new class{constructor(){document.writeTest("hello world")}};
這玩意都不用試，肯定不得行啊，得將 js 代碼轉成 es5 才行。首先安裝下babel-loader及幾個相關的依賴
配置 babelbabel-loader
- @babel/core
- @babel/preset-env
- @babel/plugin-transform-runtime
- @babel/plugin-proposal-decorators
- @babel/plugin-proposal-class-properties
- @babel/plugin-proposal-private-methods
- @babel/runtime
- @babel/runtime-corejs3
- npm install babel-loader @babel/core @babel/preset-env @babel/plugin-transform-runtime @babel/plugin-proposal-decorators @babel/plugin-proposal-class-properties @babel/plugin-proposal-private-methods -D
- npm install @babel/runtime @babel/runtime-corejs3 -s
修改 webpack.config.js 文件， 添加 babel-loader 配置
- const path = require('path');
- module.exports = {
- entry: './src/index.js',
- output: {
- path: path.resolve(__dirname, 'dist'),
- filename: 'bundle.[contenthash:8].js',
- },
- module: {
- rules: [
- {
- test: /\.(jsx|js)$/,
- use: 'babel-loader',
- exclude: /node_modules/,
- },
- ]
- }
- }
根目錄下添加相應的 .babelrc 配置文件
- {
- "presets": ["@babel/preset-env"],
- "plugins": [
- ["@babel/plugin-transform-runtime", {"corejs": 3}],
- ["@babel/plugin-proposal-decorators", { "legacy": true }],
- ["@babel/plugin-proposal-class-properties", { "loose": true }],
- ["@babel/plugin-proposal-private-methods", { "loose": true }]
- ]
- }
再次執(zhí)行命令 npx webpack 來打個包。完成后查看目錄結構
- test-app
- ├── dist
- + | ├── bundle.b8ba1739.js
- | ├── main.js
- ├── src
- | └── index.js
- + ├── .babelrc
- ├── package.json
- ├── webpack.config.js
查看構建后的 bundle.b8ba1739.js 文件
- (()=>{"use strict";new function n(){!function(n,t){if(!(n instanceof t))throw new TypeError("Cannot call a class as a function")}(this,n),document.writeTest("hello world")}})();
構建產物看著沒什么問題了，接下來看下在瀏覽器中的實際效果。要看效果，肯定離不開 html 文件。
瀏覽器中觀看效果
作為一個伸手黨直接從社區(qū)嫖來一個插件 html-webpack-plugin，這個插件的作用是將打包產物引入到我們提前準備好的模板 .html 文件中，我們訪問這個文件就能直觀的看到效果了
先來安裝下插件
- npm install html-webpack-plugin -D
接著創(chuàng)建一個 public 目錄， 用來存放靜態(tài)資源。新增一個 index.html 模板，放在 public 目錄下
- test-app
- ├── dist
- | ├── bundle.b8ba1739.js
- | ├── main.js
- ├── src
- | └── index.js
- + ├── public
- + | └── index.html
- ├── .babelrc
- ├── package.json
- ├── webpack.config.js
在 webpack.config.js 中配置 html-webpack-plugin
- // 省略 ...
- const HtmlWebpackPlugin = require('html-webpack-plugin');
- module.exports = {
- // 省略 ...
- plugins: [
- new HtmlWebpackPlugin({
- template: path.resolve(__dirname, './public/index.html'),
- inject: 'body',
- scriptLoading: 'blocking',
- }),
- ]
- }
再次執(zhí)行命令 npx webpack 來打個包。打完包發(fā)現 dist 目錄下多了一個 index.html 文件。瀏覽器中打開 index.html 看看對不對
作為一個 api 工程師，連 api 都能記錯。
修改下 src/index.js 代碼
- class Test {
- constructor() {
- document.write('hello world')
- }
- }
- new Test()
再次執(zhí)行命令 npx webpack 來打個包。老步驟，先檢查下打包產物對不對
- test-app
- ├── dist
- | ├── bundle.b8ba1739.js
- + | ├── bundle.dc044571.js
- | ├── index.html
- | ├── main.js
- ├── src
- | └── index.js
- ├── public
- | └── index.html
- ├── .babelrc
- ├── package.json
- ├── webpack.config.js
看樣子應該沒錯，代碼修改了，打包后多了個 .js 文件。再看看效果對不對
界面上也出現了 hello world。到這里為止，算是利用 webpack 走通了一個最小流程。
為什么說是最小，因為到目前為止這個配置在實際工作中 基本沒卵用 實用性不大。細心一點的人已經看出來了，上面存在三個問題
- 每修改一次代碼，都要走一遍打包流程，然后自己手動打開 html 文件，預覽效果
- 第一次調用錯誤 api 的時候，報錯信息定位不精確
- 打包目錄下面 上次構建產物 也仍舊存在，時間長了會存在越來越多的無用代碼
作為一個懶人，第三點可以忍，第一點和第二點忍不了。我們一個個來解決
實時更新并預覽效果針對第一點，查閱 webpack 官網，發(fā)現官網就給指了一條明路
按照官網教程，首先安裝下 webpack-dev-server
- npm install webpack-dev-server -D
再在 webpack.config.js 中添加相應的配置
- // 省略 ...
- module.exports = {
- // 省略 ...
- devServer: {
- port: '3001', // 默認是 8080
- hot: true,
- stats: 'errors-only', // 終端僅打印 error
- compress: true, // 是否啟用 gzip 壓縮
- proxy: {
- '/api': {
- target: 'http://0.0.0.0:80',
- pathRewrite: {
- '/api': '',
- },
- },
- },
- },
- }
在 package.json > script 中添加一個命令
- "dev": "webpack serve --open",
執(zhí)行 npm run dev，這個時候在動在瀏覽器中打開了 http://localhost:3001/ 頁面。光自動打開還不夠啊，我們的目標是每次修改后不用構建就能在瀏覽器中實時查看。為了測試這個功能是否生效，我們任意修改 src/index.js 文件并保存。發(fā)現瀏覽器中內容自動刷新生效了。
想了解更多關于 devServer 的可以閱讀以下兩篇文章
- 【Webpack】devServer 實驗報告
- 120 行代碼幫你了解 Webpack 下的 HMR 機制
sourcemap 配置
第一個問題好了，再來看看第二個問題 報錯信息定位不精確。我們仍舊在官網找找看，有沒有對應的解決方案。通過 1 小時的文檔閱讀和 7 小時的摸魚，終于在一天后找到了解決方法。
我們在 webpack.config.js 中添加配置
- // 省略 ...
- module.exports = {
- // 省略 ...
- devtool: 'eval-cheap-module-source-map',
- }
這個配置什么意思呢，它會告訴我們錯誤是在原始代碼的哪一行發(fā)生的。廢話不多說，先來看看效果
點進去看看是什么情況
這么精準的定位，一天可以改100個 bug 了。
但是!!!這玩意好歸好，生產環(huán)境可不能亂用。這里建議
開發(fā)環(huán)境 最佳：eval-cheap-module-source-map生產環(huán)境 最佳：hidden-source-map
什么?你上下嘴皮子吧嗒一合，說最佳就最佳?沒有拿得出手的理由我們是不會信的
造謠是不可能造謠的，這輩子都不會。我也是吸收了這篇文章 萬字長文：關于 sourcemap，這篇文章就夠了 的精華才總結出來的。
一萬字的文章總結成兩句話，10 秒鐘吸收
世事總是這么奇妙，按照上面的思路，在解決第二個問題的時候又帶出了一個新的問題，某些配置可能需要區(qū)分環(huán)境來設置，不同的環(huán)境設置合適的配置。就像在解決一個bug A的過程中，發(fā)現了一個新的 bug B?？磥碓诮鉀Q上面第三個問題之前，得先解決這個 區(qū)分環(huán)境配置 的問題了。
拆分環(huán)境
按照一般慣例，我們會有 開發(fā)、測試、預發(fā)、生產幾個環(huán)境。但是我個人很多情況下 開發(fā) 和 測試 環(huán)境是同一套配置，所以我這里直接省略 測試 這個環(huán)境。
修改下目錄結構
- test-app
- + ├── build
- + | ├── webpack.base.js
- + | ├── webpack.dev.js
- + | ├── webpack.pre.js
- + | ├── webpack.pro.js
- ├── dist
- ├── ├── bundle.b8ba1739.js
- ├── ├── bundle.dc044571.js
- | ├── index.html
- | ├── main.js
- ├── src
- | └── index.js
- ├── public
- | └── index.html
- ├── .babelrc
- ├── package.json
從目錄中就可以看出一點東西，我們刪除了原先根目錄下的 webpack.config.js 文件。新增了一個 build 目錄。在 build 目錄下我們需要建一個 webpack.base.js 文件。用來存放各個環(huán)境公共的配置，畢竟不可能所有配置在各個環(huán)境中都不一樣。然后按照我們各自項目實際的需求來建立不同環(huán)境的配置文件。
先修改公共配置文件 webpack.base.js。原先的 devServe 配置由于只有開發(fā)環(huán)境有;devtool 各個環(huán)境不一樣，所以這兩個配置從公共配置里移除了
- const path = require('path');
- const HtmlWebpackPlugin = require('html-webpack-plugin');
- const rootDir = process.cwd();
- module.exports = {
- entry: path.resolve(rootDir, 'src/index.js'),
- output: {
- path: path.resolve(rootDir, 'dist'),
- filename: 'bundle.[contenthash:8].js',
- },
- module: {
- rules: [
- {
- test: /\.(jsx|js)$/,
- use: 'babel-loader',
- include: path.resolve(rootDir, 'src'),
- exclude: /node_modules/,
- },
- ]
- },
- plugins: [
- new HtmlWebpackPlugin({
- template: path.resolve(rootDir, 'public/index.html'),
- inject: 'body',
- scriptLoading: 'blocking',
- }),
- ],
- }
接下來配置各個環(huán)境的配置，這里主要用到一個 webpack-merge 插件，用來合并公共配置，執(zhí)行 npm install webpack-merge -D
修改 webpack.dev.js
- const { merge } = require('webpack-merge');
- const baseConfig = require('./webpack.base');
- module.exports = merge(baseConfig, {
- mode: 'development',
- devtool: 'eval-cheap-module-source-map',
- devServer: {
- port: '3001', // 默認是 8080
- hot: true,
- stats: 'errors-only', // 終端僅打印 error
- compress: true, // 是否啟用 gzip 壓縮
- proxy: {
- '/api': {
- target: 'http://0.0.0.0:80',
- pathRewrite: {
- '/api': '',
- },
- },
- },
- },
- });
因為這里不涉及到實際的項目開發(fā)，所以這里預發(fā)和生產兩個環(huán)境的文件先配置成一樣的，大家可以根據自己的實際需要來進行不同的配置。
- webpack.pre.js
- webpack.pro.js
- const { merge } = require('webpack-merge');
- const baseConfig = require('./webpack.base');
- module.exports = merge(baseConfig, {
- mode: 'production',
- devtool: 'hidden-source-map',
- });
看到仔細的人已經發(fā)現，配置中多了一個 mode 屬性，這個會在后面解釋一波，這里先不講
修改 package.json 中的命令
- "scripts": {
- "dev": "webpack serve --config build/webpack.dev.js --open",
- "build:pro": "npx webpack --config build/webpack.pro.js",
- },
再次執(zhí)行 npm run dev 看看效果
看來是沒問題了，現在已經成功把 webpack.config.js 文件根據環(huán)境進行拆分成了多個文件。
現在來回顧下之前提出的第三個問題
這個項目小的時候其實問題不大，但是當項目大了之后，每次打包都增加幾百上千的文件，還是有點恐怖的。所以還是把這個問題也順帶解決下好了。
打包時清除上次構建產物
我們的目標是每次打包時刪除上次打包的產物，保證打包目錄下所有文件都是新的，社區(qū)查找一番后，找到一個插件clean-webpack-plugin ，來看下這個插件的介紹
比較懶，所以直接上截圖了。老步驟，先安裝 npm install clean-webpack-plugin -D 然后直接將文檔中的示例代碼借鑒到我們的項目中。修改 webpack.base.js
- // 省略...
- const { CleanWebpackPlugin } = require('clean-webpack-plugin');
- module.exports = {
- // 省略...
- plugins: [
- new HtmlWebpackPlugin({
- template: path.resolve(rootDir, 'public/index.html'),
- inject: 'body',
- scriptLoading: 'blocking',
- }),
- new CleanWebpackPlugin(),
- ],
- }
試下效果，執(zhí)行 npm run build:pro 打個包。查看目錄
- test-app
- ├── build
- | ├── webpack.base.js
- | ├── webpack.dev.js
- | ├── webpack.pre.js
- | ├── webpack.pro.js
- ├── dist
- | ├── bundle.fd44c2eb.js
- | ├── bundle.fd44c2eb.js.map
- | ├── index.html
- ├── src
- | └── index.js
- ├── public
- | └── index.html
- ├── .babelrc
- ├── package.json
dist 目錄下原先存在的 main.js、bundle.b8ba1739.js 等前幾次打包產物已經自動清除了。到這里第三個問題也解決了
功能完善
添加 css 和 less 支持
為什么不添加 sass 支持?因為我不用 sass
首先，在 src 目錄下添加一個 index.less 文件
- .test {
- color: red;
- }
修改 src/index.js 文件，在文件中引用剛才添加的 less 文件
- import './index.less'
- class Test {
- constructor() {
- this.renderDiv()
- }
- renderDiv() {
- const div = document.createElement('div')
- div.className = 'test'
- div.innerHTML = 'hello world'
- document.body.appendChild(div)
- }
- }
- new Test()
執(zhí)行 npm run dev
等待 10 分鐘后，頁面遲遲沒有加載任何東西，打開控制臺一看
英語 8 級的我立馬讀懂了報錯："你 可能 需要 一個 什么什么 loader 來 處理 這個 文件 類型， 目前 沒有 loaders 被配置 來 process 這個 文件"
再結合官網的說明
到了這里，我好像隱約明白了 webpack 的真諦：雖然很多時候我不行，但是很多大佬會讓我行。呸，什么叫不行?這叫 靈活可插拔，正是這種特性，讓 webpack 可靈活支持各種復雜場景的自定義配置。
忘了正事兒，既然問題找到了，就好解決了，找到幾個處理 css 和 less 的 loader 就行
首先安裝 loader
- npm install less style-loader css-loader less-loader -D
再修改 webpack.base.js 文件
- // 省略...
- module.exports = {
- // 省略...
- module: {
- rules: [
- // 省略...
- {
- test: /\.(le|c)ss$/,
- exclude: /node_modules/,
- use: ['style-loader', 'css-loader', 'less-loader']
- },
- ]
- },
- // 省略...
- }
再次執(zhí)行 npm run dev，查看效果
css module
這一塊是基于上面的模塊修改的，解決 css 命名混亂和沖突的。不需要的話可以直接跳過這一塊。
修改 webpack.base.js
- // 省略...
- module.exports = {
- // 省略...
- module: {
- rules: [
- // 省略...
- {
- test: /\.(le|c)ss$/,
- exclude: /node_modules/,
- use: [
- 'style-loader',
- {
- loader: 'css-loader',
- options: {
- modules: {
- compileType: 'module',
- localIdentName: "[local]__[hash:base64:5]",
- },
- },
- },
- 'less-loader'
- ]
- },
- ]
- },
- // 省略...
- }
執(zhí)行 npm run dev 來看看效果
給 class 樣式名稱后加上一個哈希串，具體的配置可以看 css-loader 官網
css 自動添加前綴
首先安裝插件
- npm install autoprefixer postcss postcss-loader -D
修改 webpack.base.js 配置文件
- // 省略...
- const autoprefixer = require('autoprefixer');
- module.exports = {
- // 省略...
- module: {
- rules: [
- // 省略...
- {
- test: /\.(le|c)ss$/,
- exclude: /node_modules/,
- use: [
- // 省略...
- 'less-loader',
- {
- loader: 'postcss-loader',
- options: {
- postcssOptions: {
- plugins: [
- ["autoprefixer"],
- ],
- },
- },
- }
- ]
- },
- ]
- },
- // 省略...
- }
打包后抽離 css 文件
首先安裝 mini-css-extract-plugin 插件
- npm install mini-css-extract-plugin -D
修改 webpack.base.js 配置文件
- // 省略...
- const MiniCssExtractPlugin = require('mini-css-extract-plugin');
- module.exports = {
- // 省略...
- module: {
- rules: [
- // 省略...
- {
- test: /\.(le|c)ss$/,
- exclude: /node_modules/,
- use: [
- MiniCssExtractPlugin.loader,
- // 省略...
- ]
- },
- ]
- },
- plugins: [
- // 省略...
- new MiniCssExtractPlugin({
- filename: 'css/[name].css',
- }),
- ],
- }
執(zhí)行 npm run build:pro 打個包看看效果。
可以看到 css 已經被抽離出來了
壓縮打包后的 css 文件
首先安裝 optimize-css-assets-webpack-plugin 插件
- npm install optimize-css-assets-webpack-plugin -D
修改 webpack.base.js 配置文件
- // 省略...
- const OptimizeCssPlugin = require('optimize-css-assets-webpack-plugin');
- module.exports = {
- // 省略...
- plugins: [
- // 省略...
- new MiniCssExtractPlugin({
- filename: 'css/[name].css',
- }),
- new OptimizeCssPlugin(),
- ],
- }
執(zhí)行 npm run build:pro 打個包看看效果。
- .test__1PSRs{color:red;transition-duration:.4s}
可以看出 css 已經被壓縮了
復制靜態(tài)資源到打包目錄
有些時候有些第三方的 js 插件沒有提供 npm 包，只提供了一個 cdn 地址或者一份文件需要自己下載下來。通常我們下載下來之后放在我們的 public/js 目錄下面，然后 public/index.html 文件里直接用 script 標簽引入。這個時候不管是 npm run dev 開發(fā)時，還是 npm run build:pro 構建后，這個 js 文件都是找不到的。我們可以嘗試下
在 public/js 新加一個 test.js 的空文件，啥內容都不用。然后在 public/index.html 中引入這個文件
- // 省略