Webpack在”多頁“開發(fā)中遇到的問題
在開發(fā)時(shí)我們經(jīng)常使用Webpack官方提供的webpack-dev-server
插件酿联。我們只需要通過一個(gè)入口main.js
和入口頁面HTML茸苇,用webpack-dev-server
就能夠提供熱更新“Live Reload”以及熱替換“Hot Module Replacement”(即HMR) 瘦麸,這很方便央星,但是在實(shí)際項(xiàng)目中我們遇到了更復(fù)雜的場(chǎng)景。
舉例來說,我們現(xiàn)在的一個(gè)項(xiàng)目中不僅僅只是一個(gè)SPA應(yīng)用了,它可能是由多個(gè)SPA應(yīng)用構(gòu)成的一個(gè)項(xiàng)目致板,每個(gè)SPA應(yīng)用可能會(huì)由不同的人維護(hù)。因此它會(huì)有多個(gè)入口JS和入口HTML咏窿。由于沒有提供唯一的入口js和html斟或,僅僅使用webpack-dev-server
的方案就行不通了。對(duì)于這種”多頁應(yīng)用“的項(xiàng)目集嵌,最好的方案是在開發(fā)時(shí)能通過路由切換到對(duì)應(yīng)的SPA應(yīng)用下萝挤,即對(duì)應(yīng)的入口JS和HTML下御毅,為此我們需要一些小技巧。
解決方案
其實(shí)在使用Webpack以前其實(shí)我們不會(huì)有這種煩惱怜珍,也許這就是“螺旋式上升”的必經(jīng)之路端蛆。總之酥泛,我一開始能想到的方案有以下三種今豆。
- 在開發(fā)模式下通過Gulp監(jiān)聽文件變化,然后直接使用Webpack打包出文件揭璃,用Gulp-Server處理路由晚凿。
- 任然使用webpack-dev-server亭罪,通過proxy代理另一個(gè)Server處理路由瘦馍。
- 只起一個(gè)Server + WebpackMiddleware 在保留熱更新和熱替換的基礎(chǔ)上,增加多路由应役。
三種方法各有利弊情组。在此我們選擇第三種方式,通過獨(dú)立Server我們能夠更方便的處理Mock中Post請(qǐng)求以及Prox等問題箩祥,自由度更大院崇。
![server.png](https://img.alicdn.com/tps/TB1rSsdOFXXXXbiXpXXXXXXXXXX-1026-598.png)
圖片中的
multientry-dev-server
就是接下來我們要?jiǎng)?chuàng)造的server。
Webpack Dev\Hot Middleware
官方提供的webpack-dev-server
也只是一個(gè)用Express起的Server而已袍祖,其中使用了webpack-dev-middleware
和 webpack-hot-middleware
作為中間件提供Hot Module Replacement/Hot Reloading
能力底瓣。Webpack Hot Middleware 必須要搭配Webpack Dev Middleware才能使用,因此同樣的我們也可以用Express啟動(dòng)一個(gè)有熱替換功能的服務(wù)器蕉陋,webpack-dev-server
只是做了一個(gè)簡(jiǎn)單的封裝而已捐凭。
var http = require('http');
var express = require('express');
var path = require('path');
var webpackMiddleware = require('webpack-dev-middleware');
var webpackHotMiddleware = require('webpack-hot-middleware');
通過下面的代碼建立Webpack的實(shí)例以及使用中間件
var app = express();
var compiler = webpack(webpackConfig);
var middleware = webpackMiddleware(compiler, {
publicPath: webpackConfig.output.publicPath
});
app.use(middleware);
app.use(webpackHotMiddleware(compiler));
通過路由獲取內(nèi)存中的Webapck打包文件
使用webpack中間件打包并不會(huì)真正的生成文件,它會(huì)把文件載入到內(nèi)存中凳鬓。
為了能通過路由指定跳轉(zhuǎn)到對(duì)應(yīng)的入口JS和HTML茁肠,我們?cè)谛柙陧?xiàng)目中做一些約定。假設(shè)項(xiàng)目入口為apps
目錄缩举,該目錄下的每一個(gè)子目錄對(duì)應(yīng)一個(gè)SPA應(yīng)用垦梆,在子目錄中需要通過一個(gè)package.json
指定該SPA應(yīng)用的入口JS和這個(gè)SPA應(yīng)用的其他信息,比如名字和子應(yīng)用負(fù)責(zé)人等仅孩。
![基礎(chǔ)模板1.png](https://img.alicdn.com/tps/TB1svDMOFXXXXXbapXXXXXXXXXX-753-497.png)
package.json文件格式類似如下:
{
"name": "app1",
"main": "./main.js",
"author": "左倫"
}
middleware提供了middleware.fileSystem.readFileSync
方法讀取內(nèi)存中的文件托猩,文件的地址就是在webpack中配置的輸出地址。
app.get('/:appName', function (req, res) {
var result = '';
var htmlPath = path.join(__dirname, webpackConfig.output.path + req.params.appName + '/index.html');
console.log(htmlPath);
try {
result = middleware.fileSystem
.readFileSync(htmlPath);
} catch (err) {
result = err.toString();
}
res.write(result);
res.end();
});
OK, 至此便可以通過路由指定到對(duì)應(yīng)App的入口辽慕。
Mock數(shù)據(jù)以及“首頁”
由于是獨(dú)立啟動(dòng)的Server站刑,我們可以很方便的在Server中指定任意目錄作為我們的靜態(tài)目錄,同時(shí)處理好對(duì)應(yīng)的Post請(qǐng)求鼻百。
// 靜態(tài)資源绞旅,Mock GET請(qǐng)求
app.use(express.static(path.join(__dirname, '../')));
// Mock POST請(qǐng)求
app.post('/api/*', function (req, res) {
res.sendFile(path.join(__dirname, '../api', req.params[0]));
});
當(dāng)越來越多的子App在項(xiàng)目中后摆尝,通過手動(dòng)在瀏覽器中輸入路由再進(jìn)行跳轉(zhuǎn)會(huì)顯得十分麻煩。因此可以在Server中新增一個(gè)“首頁”因悲,列出當(dāng)前項(xiàng)目下的所有子應(yīng)用以及開發(fā)時(shí)的對(duì)應(yīng)路由堕汞,具體實(shí)現(xiàn)并不難,通過遍歷目錄下每個(gè)應(yīng)用中的Packge.json即可晃琳,最后效果如下:
![屏幕快照 2016-12-11 下午7.11.20.png](https://img.alicdn.com/tps/TB1pwkrOFXXXXbuXXXXXXXXXXXX-840-562.jpg)
終于不用每次在瀏覽器中敲地址了..
到目前為止讯检,已經(jīng)成功解決了Webpack在“多頁“應(yīng)用下的開發(fā)問題,接下來是時(shí)候更進(jìn)一步了卫旱。
使用target
指定入口應(yīng)用
之前說到Webpack中間件在構(gòu)建時(shí)會(huì)把文件都讀取到內(nèi)存中人灼,但是當(dāng)我們的項(xiàng)目越來越大的時(shí)候,項(xiàng)目下會(huì)有越來越多的子應(yīng)用顾翼,這就造成了另一問題投放。有時(shí)我們只是在開發(fā)某一個(gè)子App下的代碼,但是Webpack每次都會(huì)把整個(gè)項(xiàng)目打包進(jìn)內(nèi)存适贸,非常浪費(fèi)資源灸芳。因此這里我們可以在webpack的配置文件中做點(diǎn)文章,想辦法只打包我們需要的目錄下的JS拜姿。
在執(zhí)行npm start
的時(shí)候烙样,通過在命令行里用
target=appName1,appName2 npm start
其中appName為你想要啟動(dòng)的應(yīng)用名稱(名稱在package.json中定義),此時(shí)Webpack配置中的Entry只會(huì)包含target指定應(yīng)用名下的入口JS和HTML蕊肥,大大縮短了Webpack啟動(dòng)時(shí)間并且減少了內(nèi)存占用谒获。這個(gè)想法最初是在團(tuán)隊(duì)的另一位師兄的代碼中看到的,十分巧妙壁却,關(guān)鍵代碼如下:
var targetEntries = process.env.target;
targetEntries = targetEntries ? targetEntries.split(',') : '';
targetEntries.forEach(function (value) {
console.log('應(yīng)用: ', value);
entryPath = path.join(viewsDir, value);
entryJson = fse.readJsonSync(path.join(entryPath, '/package.json'));
entryMap[value] = [path.resolve(path.join(entryPath, entryJson.main))];
var appName = entryJson.name;
var tplPath = path.join(entryPath, '/index.html');
var conf = {
template: tplPath,
filename: path.join(appName, 'index.html'),
inject: 'body',
chunks: [appName]
};
htmlPluginsArr.push(new HtmlWebpackPlugin(conf));
});
_.extend(webpackConfig, {
entry: entryMap,
output: {
path: path.join(__dirname, '../build/'),
filename: '[name]/[name].min.js'
},
plugins: [
new ExtractTextPlugin('[name]/[name].css'),
new webpack.optimize.UglifyJsPlugin({
compress: {
warnings: false,
drop_console: true
}
})
].concat(htmlPluginsArr)
});
通過這樣一個(gè)簡(jiǎn)單的服務(wù)批狱,我們完全不用再使用Webpack-Dev-Server了,甚至我們也可以封裝成一個(gè)相似的plugin儒洛。整個(gè)問題的思路和解決方案到此為止咯精耐,如果大家有更好的想法可以補(bǔ)充。
文章首發(fā)于alisec-ued 琅锻,個(gè)人博客地址卦停。