語
在最近的項目開發中,涉及到了多頁面的 webpack 打包,以下是我項目過程中的一些踩坑總結。
前言
項目使用了 vue 作為框架來開發前端頁面,其中需要開發多個前端頁面,包括有登錄、進游戲、充值等等。作為vue最佳的打包工具—— webpack,需要將各個頁面分別打包到不同模板目錄里。
但默認的 vue 項目框架是單頁面應用的,并不能達到項目開發的目的。這就需要調整 webpack 的配置來實現多頁面的發布處理。
以下是目錄結構:
project
├───bin
│ └───vb.js
├───build
│ │ dev.js
│ │ release.js
│ │ webpack.config.base.js
│ │ webpack.config.build.js
│ └───webpack.config.dev.js
│ README.md
│ package.json
└───src
├───components
│ │ count.vue
│ │ dialog.vue
│ │ errortips.vue
│ └───...
├───game
│ │ game.htm
│ │ game.js
│ └───game.vue
├───login
│ │ login.htm
│ │ login.js
│ └───login.vue
├───pay
│ │ pay_result.htm
│ │ pay_result.js
│ │ pay_result.vue
│ │ pay.htm
│ │ pay.js
│ └───pay.vue
└───...
修改配置前的一些知識
我們知道webpack的核心是一切皆模塊,所以它本質上是一個靜態模塊打包器。當 webpack 處理應用程序時,它會遞歸地構建一個依賴關系圖,其中包含應用程序需要的每個模塊,然后將所有這些模塊打包成一個或多個 bundle。
官網顯示的這幅圖很形象地描述了這個過程。
從 webpack v4.0.0 開始,webpack 提供了一系列的配置默認項,讓開發者可以零配置打包,不再強制要求必須進行繁瑣的 webpack 配置,讓開發者可以從繁瑣的配置文件里抽出,專注應用的開發。但是若你需要有特殊的處理,webpack 仍然可以進行高度可配置來滿足你的需求。
在開始前需要了解四個核心概念:
本篇將會針對這4個核心配置的修改和優化來實現多頁面打包。在 webpack4 的版本,還新增了一個 mode 配置項。mode 有兩個值:development 或者是 production,用戶可以啟用相應模式下的 webpack 內置的優化。不同 mode 的區別與默認配置可以參考:https://segmentfault.com/a/1190000013712229
一、入口配置
在單頁面應用里,一般在根目錄下面會有一個 index.html 文件。它是頁面的 html 模板文件。但是在多頁面應用里,則會有多個應用模板文件,為了方便管理,可以將不同類的入口文件、邏輯處理和模板文件分別存放在相應的獨立目錄。若用到了組件,則單獨將組件存放在一個目錄。
project
└───src
├───components
│ │ count.vue
│ │ dialog.vue
│ │ errortips.vue
│ └───...
├───game
│ │ game.htm
│ │ game.js
│ └───game.vue
├───login
│ │ login.htm
│ │ login.js
│ └───login.vue
├───pay
│ │ pay_result.htm
│ │ pay_result.js
│ │ pay_result.vue
│ │ pay.htm
│ │ pay.js
│ └───pay.vue
└───...
webpack 的入口配置中是支持多入口的,給 entry 傳入對象即可,如下所示:
const config = {
entry: {
game: './src/game/game.js',
login: './src/login/login.js',
pay: './src/pay/pay.js',
pay_result: './src/pay/pay_result.js'
}
};
但這樣的配置對于未知頁面數量的項目并不友好,若每新增頁面都要重新配置和重啟程序,顯然是不合理的。而我們可以創建一個getEntry()的方法來遍歷文件夾來獲取入口。
const fs = require('fs');
const glob = require("glob");
function getEntry() {
const entry = {};
//讀取src目錄所有page入口
glob.sync('./src/*/*.js') //獲取符合正則的文件數組
.forEach(function (filePath) {
var name = filePath.match(/\/src\/(.+)\/*.js/);
name = name[1];
//須有配套的模板文件才認為是入口
if (!fs.existsSync('./src/' + name + '.htm')) {
return;
}
entry[name] = filePath;
});
return entry;
};
module.exports = {
// 多入口
entry: getEntry(),
}
二、輸出配置
輸出配置僅需指定一個
const config = {
output: {
path: path.join(__projectDir, __setting.distJs),
publicPath: __setting.domainJs, //自定義變量,用來定義公共靜態資源路徑
filename: '[name][hash].js'
},
};
https://www.webpackjs.com/configuration/output/#output-publicpath
https://www.webpackjs.com/configuration/output/#output-filename
在配置中有以下幾點需要注意:
publicPath 是指定在瀏覽器中所引用的「此輸出目錄對應的公開 URL」。
簡單的例子:
publicPath: "https://cdn.example.com/assets/"
輸出到html則變成
<script src="https://cdn.example.com/assets/bundle.js"></script>
這個屬性是整個項目共用的靜態資源路徑,若某個模塊需要使用其他的靜態資源路徑。webpack 提供了__webpack_public_path__來動態設置 publicPath,只需在入口文件的最頂部定義即可。
__webpack_public_path__ = myRuntimePublicPath; // 一定要寫在最頂部
filename的[hash]是以項目為維度的 hash 值,若輸出了多個文件,則文件名都會共用一個 hash 值。
filename的[chunkhash]是以chunk為維度生成的 hash 值,不同入口生成不同的 chunkhash 值。
filename的[contenthash]根據資源內容生成的 hash 值。
通常使用 hash 或 chunkhash,contenthash 通常用于某些特殊場景(官方文檔在使用 ExtractTextWebpackPlugin 插件時有使用)。
https://www.webpackjs.com/plugins/extract-text-webpack-plugin/
三、loader配置
由于 webpack 只能理解 JavaScript 和 JSON 文件。而配置 loader 就是讓 webpack 能夠去處理其他類型的文件,并將它們轉換為有效模塊。
loader 可以使開發者在 import 或"加載"模塊時預處理文件。例如,將內聯圖像轉換為 data URL,或者允許開發者直接在 JavaScript 模塊中 import CSS文件
1、js 模塊
加載js模塊,我們通常是為了引入babel,讓其能將ES6的語法轉成ES5,讓項目能在低版本的瀏覽器上運行。
js文件需要使用babel的話,引入babel-loader
const config = {
module: {
rules: [{
test: /\.js$/,
include: [path.resolve(__projectDir, 'src')], //通過include精確指定只處理哪些目錄下的文件
exclude: /node_modules/, //設置哪些目錄里的文件不進行處理
loader: "babel-loader"
}]
}
}
但僅僅配置了babel-loader還不夠,還需要配置 babel 的環境,需要引入 polyfill。
引入 polyfill 的方式有很多種,根據 vue 官方文檔在瀏覽器兼容性的處理,默認使用的是@vue/babel-preset-app ,它通過@babel/preset-env和browserslist配置來決定項目需要的 polyfill。
https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/babel-preset-app
browserslist
項目根目錄創建.browserslist文件
> 1%
last 2 versions
當然,你也可以在package.json文件里添加的browserslist字段來配置。
這個配置的目的是為了指定了項目的目標瀏覽器的范圍,配置的值會被 @babel/preset-env 用來確定需要轉譯的 JavaScript 特性。
詳細的說明可以查閱 https://github.com/browserslist/browserslist,了解如何指定瀏覽器范圍。
Polyfill
項目根目錄創建.babelrc文件
{
"presets": [
["@babel/preset-env",
{
"modules": false, // 對ES6的模塊文件不做轉化,以便使用tree shaking、sideEffects等
"useBuiltIns": "entry", // browserslist環境不支持的所有墊片都導入
"corejs": {
"version": 3, // 使用core-js@3
"proposals": true
}
}
]
]
}
這里特別說下的是配置里的useBuiltIns,可設置的值分別是"usage" | "entry" | false,3個值分別代表:
項目使用的是"useBuiltIns": "entry",所以需要指定corejs的版本,這里使用的版本是core-js@3,所以我們在 webpack 的入口配置里加上"core-js/stable"和 "regenerator-runtime/runtime"。
function getEntry() {
const entry = {};
//讀取src目錄所有page入口
glob.sync('./src/*/*.js') //獲取符合正則的文件數組
.forEach(function (filePath) {
var name = filePath.match(/\/src\/(.+)\/*.js/);
name = name[1];
//須有配套的模板文件才認為是入口
if (!fs.existsSync('./src/' + name + '.htm')) {
return;
}
entry[name] = ["core-js/stable", "regenerator-runtime/runtime", path.join(__projectDir, filePath)];
});
return entry;
};
2、css 模塊
我們通常使用style-loader和css-loader。css-loader用來處理 js 文件中引入的 css 模塊(處理@import和url()),style-loader是將css-loader打包好的css代碼以<style>標簽的形式插入到 html 文件中。而 webpack 對于 loader 的調用是從右往左的,所以通常是這樣配置:
{
test: /\.css$/,
use: [ 'style-loader', 'css-loader' ]
}
我們在項目中還經常會使用 sass 或者 scss。sass 是一種 CSS 的預編譯語言。因此 webpack 要將其處理會使用更多 loader。
{
test: /\.(sc|sa)ss$/,
use: [{
loader: 'vue-style-loader'
}, {
loader: 'css-loader',
options: {
sourceMap: true,
}
}, {
loader: 'postcss-loader',
options: {
sourceMap: true
}
}, {
loader: 'sass-loader',
options: {
sourceMap: true
}
}, {
loader: 'sass-resources-loader', //組件里面使用全局scss
options: {
sourceMap: true,
resources: [
path.resolve('./src/public/css/common.scss')
]
}
}]
}
在使用sass-loader的時候若某個 scss 文件(比如a.scss)@import 了其他 scss 文件(比如b.scss),如果b.scss里的url()的路徑是相對路徑,在sass-loader處理過后給css-loader處理時就會報錯,找不到url()里指定的資源。
這是因為sass-loader處理時,會將 scss 文件里 @import 路徑的文件一并合并進來,結合上面的例子就是b.scss會被sass-loader合并進a.scss。
如何解決呢?可以有兩個解決方法:
在項目中由于還用到了postcss-loader,我們還須要在根目錄創建postcss-loader的配置文件postcss.config.js
//自動添加css瀏覽器前綴
module.exports = {
plugins: [
require('autoprefixer')
]
}
3、圖片等靜態資源
對于圖片資源的打包,經常會使用file-loader來完成,配置也很簡單:
{
test: /\.(gif|png|jpe?g)$/,
loader: 'file-loader',
}
打包后,會將圖片移動到了 dist 目錄下,并將該圖片改名為[hash].[ext]格式的圖片。開發者也可以根據需要,修改輸出的文件名。
但在項目開發過程中,我們會創建很多張圖片,這就使得頁面在加載是時候會發送很多http請求,當頁面圖片過多,會影響的頁面的性能。所以,這里推薦使用url-loader。
{
test: /\.(png|jpg|jepg|svg|gif)$/,
use: [{
loader: 'url-loader',
options: {
limit: 10240, //這里的單位是b
name: 'image/[name][hash].[ext]' //打包后輸出路徑
}
}]
}
使用url-loader我們可以通過設置limit的值,將文件大小小于某個值的圖片打包成base64的形式存放在打包后的 js 中,若超過了這個設定值,默認會使用file-loader(所以雖然代碼沒有配置 file-loader,但還是需要使用安裝file-loader),并且會將配置的選項傳遞給file-loader。
4、import AMD 模塊
有時我們需要在項目里使用一些 AMD 模塊或者完全不支持模塊化的庫。例如移動端經常使用的 zepto。如果我們直接使用 import zepto 的方式引入是會報錯的:Uncaught TypeError: Cannot read property 'createElement' of undefined
要使用也很簡單,使用script-loader和exports-loader即可:
{
test: require.resolve('zepto'),
use: ['exports-loader?window.Zepto','script-loader']
}
四、plugins
webpack 可以使用插件(plugins)來讓開發者能夠在打包的過程中實現更多功能,插件會在整個構建過程中生效,并執行相關的任務。這里會介紹幾個比較實用的插件:
1、mini-css-extract-plugin
在使用style-loader處理后,css 文件會作為模塊打包進 js 文件里。若我們想將 js 文件和 css 文件分離。就可以使用mini-css-extract-plugin:
module: {
rules: [{
test: /\.css$/,
use: [{
loader: MiniCssExtractPlugin.loader
},
'css-loader'
]
}]
},
plugins: [
new MiniCssExtractPlugin({
filename: 'css/[hash].css'
})
]
2、copy-webpack-plugin
有時候我們會有一些沒經過打包的文件需要復制到我們的生產目錄里,copy-webpack-plugin就可以實現這個功能。
plugins: [
new CopyWebpackPlugin([
{
from: { glob: './src/public/*.htm', dot: true },
to: path.join(__setting.distTpl, 'public','[name].htm')
}
], { copyUnmodified: true })
]
3、html-webpack-plugin
我們前面介紹入口配置的時候會看到只配置了 js 文件,只是因為 webpack 現在入口只支持 js 文件,所以打包輸出的也是 js 文件,那如果我們需要將 js 文件引入到 html 里,就需要使用到html-webpack-plugin插件。
html-webpack-plugin在使用的時候,是必須一個入口對應一個配置的,所以我們前面使用了多頁面的配置,也需要進行相應的修改,修改后的getEntry方法:
const htmlPluginArray = [];
function getEntry() {
const entry = {};
//讀取src目錄所有page入口
glob.sync('./src/' + __setting.moduleId + '/*.js')
.forEach(function (filePath) {
var name = filePath.match(/\/src\/(.+)\/*.js/);
name = name[1];
if (!fs.existsSync(path.join(__projectDir, './src/' + name + '.htm'))) {
return;
}
entry[name] = ["core-js/stable", "regenerator-runtime/runtime", path.join(__projectDir, filePath)];
+ htmlPluginArray.push(new HtmlWebpackPlugin({
+ filename: `${__setting.distTpl}/${name}.htm`,
+ template: './src/' + name + '.htm',
+ inject: 'body',
+ minify: {
+ removeComments: true,
+ collapseWhitespace: true
+ },
+ chunks: [name],
+ inlineSource: '.(js|css)'
+ }))
});
return entry;
};
// 配置plugin,由于plugins通常使用數組類型來配置,
// 所以可以使用concat方法將配置好的html的數組添加進去。
plugins: [
new MiniCssExtractPlugin({
filename: 'css/[hash].css'
})
].concat(htmlPluginArray),
里面的一些配置是要注意一下的:
filename 是配置需要將 html 改成什么名字并輸出到哪里的配置。這里配置的的路徑是以 output 里配置的path為相對路徑的,我們上面 output 配置的是
path: path.join(__projectDir, __setting.distJs)
那最終的html輸出路徑就是
path.join(__projectDir, __setting.distJs,
`${__setting.distTpl}/${name}.htm`)
是將html里的代碼進行壓縮。如果 minify 選項設置為 true 或者配置對象 ( true 是 webpack 模式為 production 時的默認值),生成的 HTML 將使用 HTML-minifier壓縮代碼,更多具體的配置可以看這里minification。
template 生成 filename 文件的模版。重點:與 filename 的路徑不同, 當匹配模版路徑的時候將會從項目的根路徑開始。
inject 制定 webpack 打包的 js css 靜態資源插入到 html 的位置。
chunks 指定模板允許添加哪個入口文件。若不配置這個會將所有的入口都添加進來。
4、html-webpack-inline-source-plugin
若我們想將打包好的 js 代碼 inline 進 html 的話,就要使用到html-webpack-inline-source-plugin
可以看到上面html-webpack-plugin的配置里有inlineSource: '.(js|css)'
這就是告訴html-webpack-inline-source-plugin需要將打包好的代碼 inline 進 html 里,插件需要添加到html-webpack-plugin的配置后
plugins: [
new MiniCssExtractPlugin({
filename: 'css/[hash].css'
})
].concat(htmlPluginArray).concat([
new HtmlWebpackInlineSourcePlugin()
])
但是html-webpack-inline-source-plugin也僅能將打包后輸出的 js 文件引入 html,若你想將 html 碼其他使用 script 標簽加載的 js 文件或者 style 標簽加載的 css 文件也 inline 進 html 里的話,html-webpack-inline-source-plugin并不能實現。從html-webpack-plugin里的 Issues 來看,html-webpack-plugin的作者也無意做這樣的事情,但也給出了建議,可以借助html-webpack-plugin插件的 hooks html-webpack-plugin-before-html-processing達到我們需要的效果。
5、自定義插件
上面說到要將外部的靜態文件也 inline 進 html,我們可以編寫自定義插件,借助html-webpack-plugin插件的 hooks html-webpack-plugin-before-html-processing,再結合inline-source組件來實現我們的功能。
const {
inlineSource
} = require('inline-source');//加載inline-source組件
//定義方法
function scriptInlineHtml(options) {
// Configure your plugin with options...
this.options = options || {};
}
scriptInlineHtml.prototype.apply = function (compiler) {
let that = this;
(compiler.hooks ? //判斷webpack版本,4.0以上和4.0以下的處理不一樣
compiler.hooks.compilation.tap.bind(compiler.hooks.compilation, 'script-inline-html') :
compiler.plugin.bind(compiler, 'compilation'))(function (compilation) {
(compilation.hooks ?
compilation.hooks.htmlWebpackPluginBeforeHtmlProcessing.tapAsync.bind(compilation.hooks.htmlWebpackPluginBeforeHtmlProcessing, 'script-inline-html') :
compilation.plugin.bind(compilation, 'html-webpack-plugin-before-html-processing'))(async function (htmlPluginData, callback) {
//獲取的html內容處理后重新賦值;
try {
htmlPluginData.html = await inlineSource(htmlPluginData.html, that.options);
// Do something with html
} catch (err) {
// Handle error
}
//繼續執行下個插件
callback(null, htmlPluginData);
});
});
};
//webpack插件添加
plugins: [
new MiniCssExtractPlugin({
filename: 'css/[hash].css'
})
].concat(htmlPluginArray).concat([
new scriptInlineHtml(),
new HtmlWebpackInlineSourcePlugin()
])
使用
<script src="/src/public/js/px2rem.js" inline></script>
這里結合 inline 靜態資源,簡單介紹了自定義插件的使用,在html-webpack-plugin構建 html 過程中,還提供其他一系列的事件。
Async:
Sync:
這些事件可以讓我們在構建 html 的不同階段里,通過一些處理來達到我們的目的。例如:可以結合smarty.js將使用了 smarty 的模板,引入一些模擬數據后解析成正常的html代碼;讀取 HTML 文件進行翻譯文本的替換,實現頁面的多語言化。打包不同皮膚的html文件等等。
五、其他配置
1、resolve
resolve 配置規定了 webpack 如何尋找各個依賴模塊。
前面有講到使用 alias 設置路徑別名。在資源引用時,如果資源引用路徑太深,又比較常用,我們可以定義路徑別名,例如:
resolve: {
alias: {
'@': path.resolve(__projectDir, 'src')
}
}
我們就可以直接在代碼中這樣引用了:
let backimg = require("@/public/image/common/ico-back.png").default;
2、webpack dev server
webpack-dev-server是開發時的必備利器,它可以在本地起一個簡單的 web 服務器,當文件發生變化時,能夠實時重新加載。webpack-dev-server的配置也很簡單:
devServer: {
contentBase: __projectDir, //頁面的基礎目錄
publicPath:'/',
port: 8080,
host: '127.0.0.1',
open: true, //是否運行后自動打開瀏覽器
hot: true
}
啟動 webpack-dev-server 后,在目標文件夾中是看不到編譯后的文件的,實時編譯后的文件都保存到了內存當中。
1) HMR
hot設置為 true 是啟用 webpack 的 模塊熱替換( HMR )功能,但這里注意必須要添加插件webpack.HotModuleReplacementPlugin 才能完全啟用 HMR
2) publicPath
publicPath 路徑下的打包文件可以在瀏覽器中訪問,webpack-dev-server 打包的內容是放在內存中的,并沒有實際創建文件,這些打包后的資源對外的的根目錄就是 publicPath。
默認 devServer.publicPath 是 '/',所以你的包( bundle )可以通過 http://127.0.0.1:8080/bundle.js 訪問。注意:當這里的 publicPath 和 output 的 publicPath 同時設置時,這里的優先級更高。
總結
webpack 的配置能介紹的點其實還有很多,例如開發環境和生產環境進行配置分離;利用瀏覽器的緩存將公共的模塊抽離分開打包;還有很多常用 plugins 插件等等。
這篇文章是以我在開發某個多頁面應用項目為例,總結了一些我在webpack配置上的理解。希望能對瀏覽這篇文章的小伙伴有幫助。
作者:HZH
來源-微信公眾號:三七互娛技術團隊
出處:https://mp.weixin.qq.com/s/JzZDqe-f_NRMmdxDLXC7tQ
、概述
系統在啟動過程中會做很多事情,有時候我們感覺不到,例如系統在啟動的時候沒有看到畫面,就已經有打印信息出來了,那說明串口在uboot啟動過程中已經初始化完成。
二、版本
rk uboot分為兩個版本,一個是2014年的,一個是2017的,那么我們怎么區分系統目前是用的哪個版本?有兩種方法:
1、確認根目錄Makefile的版本號,列如:
#
## Chapter-1 SPDX-License-Identifier: GPL-2.0+
#
VERSION = 2017
PATCHLEVEL = 09
SUBLEVEL =
EXTRAVERSION =
NAME =
2、確認開機第一行正式打印信息,列如:
U-Boot 2017.09-01818-g11818ff-dirty (Nov 14 2019 - 11:11:47 +0800)
項目開源:v2017已開源且定期更新到Github:https://github.com/rockchip-linux/u-boot
內核版本:v2017要求RK內核版本 >= 4.4
三、2017版本uboot功能
v2017(next-dev) 是 RK 從 U-Boot 官方的 v2017.09 正式版本中切出來進行開發的版本,目前已經支持
RK 所有主流在售芯片。支持的功能主要有:
支持 RK Android 固件啟動;
支持 Android AOSP 固件啟動;
支持 Linux Distro 固件啟動;
支持 Rockchip miniloader 和 SPL/TPL 兩種 Pre-loader 引導;
支持 LVDS、EDP、MIPI、HDMI、CVBS、RGB 等顯示設備;
支持 eMMC、Nand Flash、SPI Nand flash、SPI NOR flash、SD 卡、 U 盤等存儲設備啟動;
支持 FAT、EXT2、EXT4 文件系統;
支持 GPT、RK parameter 分區表;
支持開機 LOGO、充電動畫、低電管理、電源管理;
支持 I2C、PMIC、CHARGE、FUEL GUAGE、USB、GPIO、PWM、GMAC、eMMC、NAND、
Interrupt 等;
支持 Vendor storage 保存用戶的數據和配置;
支持 RockUSB 和 Google Fastboot 兩種 USB gadget 燒寫 eMMC;
支持 Mass storage、ethernet、HID 等 USB 設備;
支持通過硬件狀態動態選擇 kernel DTB;
四、驅動開發模型
DM (Driver Model) 是 U-Boot 標準的 device-driver 開發模型,跟 kernel 的 device-driver 模型非常類 似。v2017版本也遵循 DM 框架開發各功能模塊。建議讀者先閱讀DM文檔,了解DM架構原理和實現。
核心代碼位于:
./drivers/core/
五、安全
U-Boot在ARM TrustZone的安全體系中屬于Non-Secure World,無法直接訪問任何安全的資源(如:
安全 memory、安全 otp、efuse...),需要借助 trust 間接訪問。RK平臺上U-Boot的CPU運行模式:
者:Lefex
轉發鏈接:https://mp.weixin.qq.com/s/6J9X8s_QfQcv2g5Wr-qn-A
*請認真填寫需求信息,我們會在24小時內與您取得聯系。