webpack4+react多頁面架構

leinov發表於2018-10-15
WebReact架構

webpack在單頁面打包上應用廣泛，以create-react-app為首的腳手架眾多，單頁面打包通常是將業務js，css打包到同一個html檔案中，整個專案只有一個html檔案入口,但也有許多業務需要多個頁面不同的入口，比如不同的h5活動，或者需要支援seo的官方網站，都需要多個不同的html，webpack-react-multi-page架構讓你可以實現多頁面架構，在專案開發中保證每個頁面都可以熱更新並且打包後有清晰的檔案層次結構。

Github地址

專案架構

技術使用

  • react16
  • webpack4
    • html-webpack-plugin 生成html檔案
    • mini-css-extract-plugin css分離打包
    • uglifyjs-webpack-plugin js壓縮
    • optimize-css-assets-webpack-plugin css壓縮
  • es6
  • babel
  • node
    • opn 開啟瀏覽器
    • compression 開啟gzip壓縮
    • express
  • git

目錄結構github

|-- webpack-react-multi-page //專案
    |-- dist //編譯生產目錄
        |-- index
            |-- index.css
            |-- index.js
        |-- about
            |-- about.css
            |-- about.js
        |-- images
        |-- index.html
        |-- about.html
    |-- node_modules //node包
    |-- src //開發目錄
        |-- index //index頁面打包入口
            |-- images/
            |-- app.js// index業務js
            |-- index.scss
            |-- index.js //index頁面js入口
        |-- about //about頁面打包入口
            |-- images/
            |-- app.js// about業務js
            |-- index.scss
            |-- index.js //about頁面js入口
        |-- template.html // html模板 
        |-- style.scss //公共scss
    |-- webpackConfig //在webpack中使用
        |-- getEntry.js //獲取入口
        |-- getFilepath.js //遍歷資料夾
        |-- htmlconfig.js //每個頁面html注入資料
    |-- package.json
    |-- .gitignore
    |-- webpack.config.js //webpack配置檔案
    |-- www.js //生產啟動程式
複製程式碼

wiki

webpack單頁面打包配置

webpack.config.js

module.exports = (env, argv) => ({
    entry: ".src/index.js",
    output: {
        path: path.join(__dirname, "dist"),
        filename: "bundle.js"
	},
    module: {
        rules: [
            ...
	   ],
    },
    plugins: [
        new HtmlWebpackPlugin({
    	    title: "首頁",
    	    filename:"index.html",
    	    favicon:"", 
    	    template: "./src/template.html", 
        })
    ]
});
複製程式碼

這樣就可以在dist資料夾下打包出一個下面這樣的檔案

<!DOCTYPE html>
<html lang="en">
    <head>
    <title>首頁</title>
    <body>
        <div id="root"></div>
        <script type="text/javascript" src="bundle.js"></script>
    </body>
</html>

複製程式碼

webpack多頁面打包配置

webpack 的entry支援兩種種格式

打包單個檔案

module.exports = {
    entry: '.src/file.js',
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: 'bundle.js' 
  }
};
複製程式碼

在dist下打包出一個bundle.js

打包出多個檔案

module.exports = {
    entry: {
        index:"./src/index.js",
        about:"./src/about.js"
    },
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: '[name].js' 
    }
};
複製程式碼

上面在dist下打包出兩個與entry屬性名對應的index.js,about.js這兩個檔案

將每個js掛載到相應的html檔案上

這裡我們需要用到html-webpack-plugin這個webpack外掛,每新增一個頁面就需要在plugins新增一個new HtmlWebpackPlugin({....})

const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = (env, argv) => ({
    entry: {
        index:"./src/index.js",
        about:"./src/about.js"
    },
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: '[name].js' 
    }
    ....//其他配置
    plugins: [
        new HtmlWebpackPlugin(
            {
        	filename:"index.html",//生成的index.html
        	template: "./src/template.html",}) //模板
        	chunks:["index"]
            }),
	new HtmlWebpackPlugin(
            {
                filename:"about.html",//生成的index.html
        	template: "./src/template.html",}) //模板
        	chunks:["about"]
            })
	]
})
複製程式碼

html-webpack-plugin會通過template.html模板生成對應的filename名的html檔案，並一併打包到output中對應的資料夾下，注意，所有打包的檔案都是對應到output中path這個目錄下，也包括html。這裡的chunks需要注意，它是確定該html需要引入哪個js，如果沒寫的話，預設會引出所有打包的js，當然這不是我們想要的。

上面的配置最終可以在dist下打包出下面的檔案結構

|-- dist
    |-- index.js
    |-- about.js
    |-- index.html //內掛載index.js
    |-- about.html //內掛載about.js
複製程式碼

通過上面這樣的配置，再加上devServer，我們已經可以實現多頁面的配置開發了，但這樣很不智慧，因為你每增加一個頁面，就要在wepback裡面配置一次，會非常繁瑣，所以我們來優化下，讓我們只專注於開發頁面，配置交給webpack.

webpack多頁面配置優化

我們看下src下面的檔案結構

|-- src
    |-- index
        |-- app.js
        |-- index.scss
        |-- index.js
    |-- about
        |-- app.js
        |-- index.scss
        |-- index.js
複製程式碼

src下面每個資料夾對應一個html頁面的js業務，如果我們直接把資料夾對應入口js找到並把他們合併生成對應的entry，那是不是就不用手動寫entry了呢，是的

  • getEntry.js
/* eslint-env node */
/**
 * @project: 獲取entry檔案入口
 * @author: leinov
 * @date: 2018-10-11
 */
const fs = require("fs");

/**
 * 【獲取entry檔案入口】
 *
 * @param {String} path 路徑
 * @returns {Object} 返回的entry { "about/aoubt":"./src/about/about.js",...}
 */
module.exports = function getEnty(path){
    let entry = {};
    let existpath = fs.existsSync(path); //是否存在目錄
    if(existpath){
	let readdirSync = fs.readdirSync(path);  //獲取目錄下所有檔案
	readdirSync.map((item)=>{
	    let currentPath = `${path}/${item}`;
	    let isDirector = fs.statSync(currentPath).isDirectory(); //判斷是否是一個資料夾
	    if(isDirector && item !== "component"){
		/**
                 * 下面輸出格式為{"about/about":".src/aobout/index.js"}
                 * 這樣目的是為了將js打包到對應的資料夾下
                 */
		 entry[`${item}/${item}`] = `${currentPath}/index.js`;
	    }
	});
	return entry;
    }
};

複製程式碼

在webpack中使用getEntry

const getEntry = require("./webpackConfig/getEntry");
const entry = getEntry();

module.exports = (env, argv) => ({
    entry: entry,
})

複製程式碼

這樣我們就自動獲取到了entry

html-webpack-plugin配置

因為每個頁面都需要配置一個html，所以我們也通過fs模組獲取src下的目錄，遍歷出對應得html-webpack-plugin中

  • getFilepath.js

/* eslint-env node */

/**
 * @project: 遍歷檔案目錄
 * @author: leinov
 * @date: 2018-10-11
 */

const fs = require("fs");

/**
 * 【遍歷某檔案下的檔案目錄】
 *
 * @param {String} path 路徑
 * @returns {Array} ["about","index"]
 */
module.exports = function getFilePath(path){
    let arr = [];
    let existpath = fs.existsSync(path); //是否存在目錄
    if(existpath){
	let readdirSync = fs.readdirSync(path);  //獲取目錄下所有檔案
	readdirSync.map((item)=>{
	    let currentPath = path + "/" + item;
	    let isDirector = fs.statSync(currentPath).isDirectory(); //判斷是不是一個資料夾
	    if(isDirector){
		arr.push(item);
	    }
	});
        return arr;
    }
};

複製程式碼
  • htmlconfig.js
/**
 * @project 頁面html配置
 * @author:leinov
 * @date: 2018-10-09
 */

module.exports={
    index:{
        title: "首頁",//網站標題
	filename:"index.html",
	template: "./src/template.html",  
        chunks:["index/index"],
    },
    about:{
	title: "關於頁面",//網站標題
	filename:"about.html",	
        template: "./src/template.html", 
	chunks:["about/about"]
    }
};

複製程式碼

通過上面一系列的封裝webpack最終的配置如下

const HtmlWebpackPlugin = require("html-webpack-plugin");
const getEntry = require("./webpackConfig/getEntry");
const getFilePath = require("./webpackConfig/getFilepath");
const htmlconfig =require("./webpackConfig/htmlconfig");

const entry = getEntry("./src");
const htmlarr=[];//注入html模板
getFilePath("./src").map(pathname => {
	htmlarr.push(new HtmlWebpackPlugin(htmlconfig[pathname]));
});

module.exports = (env, argv) => ({
    entry: entry
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: '[name].js' 
    }
    ....//其他配置
    devServer: {
	port: 3100,
	open: true,
    },
    plugins: [
        ...htmlarr
    ]
})
複製程式碼

這樣一個完整的多頁面架構配置就完成了，完整程式碼參考專案code

相關文章