webpack+react多頁面開發架構

秋雨發表於2019-02-16
WebReact架構

專案已經升級為最新版本參考react-multi-page-app

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

概覽

key value
名稱 webpack+react多頁面架構
描述 簡單易用的多頁面自動化開發架構
開發者 leinov
釋出日期 2018-11-07
版本 2.0
倉庫 github地址

特性

  • ?‍?‍?‍? 支援多頁面同時熱載入開發
  • ? 自動識別新建立頁面
  • ? 每個頁面生成個性化資訊
  • ? 分類打包
  • ? 靈活擴充套件

安裝&使用

// clone
git clone git@github.com:leinov/react-multi-page-app.git

// 安裝依賴包
npm install

// 開發
npm run dev

// 編譯打包
npm run build

// 啟動生產頁面
npm start

新建立頁面在src下新增資料夾並建立pageinfo.json 然後npm run dev 即可

|-- src
    |-- index/
    |-- page2/
        |-- index.js
        |-- pageinfo.json

專案架構

技術使用

  • 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
    • fs
  • git

目錄結構

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

wiki

webpack打包單頁面應用

webpack在單頁面打包上應用廣泛，以create-react-app為首的接觸腳手架眾多，單頁面打包通常指的是將業務js，css打包到同一個html檔案中，整個專案只有一個html檔案入口

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` index.js,about.js這兩個檔案
  }
};

上面在dist下打包出兩個與entry屬性名對應的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` index.js,about.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:["index"]
            })
    ]
})

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了呢，是的!

遍歷檔案目錄

/* eslint-env node */

/**
 * @file: getFilePath.js  遍歷檔案目錄
 * @author: leinov
 * @date: 2018-10-11
 */

const fs = require("fs");

/**
 * 【遍歷某檔案下的檔案目錄】
 *
 * @param {String} path 路徑
 * @returns {Array} ["about","index"]
 */
module.exports = function getFilePath(path){
    let fileArr = [];
    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"){ // component目錄下為元件 需要排除
                fileArr.push(item);
            }
        });
        return fileArr;
    }
};

比如在src下有index頁面專案，about專案 遍歷結果為[“index”,”about”];

遍歷生成打包入口陣列

/* eslint-env node */
/**
 * @file: getEntry.js 獲取entry檔案入口
 * @author: leinov
 * @date: 2018-10-11
 * @update: 2018-11-04 優化入口方法 呼叫getFilePath
 */
const getFilePath = require("./getFilepath");
/**
 * 【獲取entry檔案入口】
 *
 * @param {String} path 引入根路徑
 * @returns {Object} 返回的entry { "about/aoubt":"./src/about/about.js",...}
 */
module.exports = function getEnty(path){
    let entry = {};
    getFilePath(path).map((item)=>{
        /**
         * 下面輸出格式為{"about/about":"./src/aobout/index.js"}
         * 這樣目的是為了將js打包到對應的資料夾下
         */
        entry[`${item}/${item}`] = `${path}/${item}/index.js`;
    });
    return entry;
};

這裡我們使用getFilepath獲取的陣列，在獲取到每個目錄下的js檔案，組合成一個js入口檔案的如下格式的物件。

{
    "index/index":"./src/index/index.js",
    "about/about":"./src/about/index.js"
}

在webpack中使用getEntry

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

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

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

html-webpack-plugin自動配置

因為每個頁面都需要配置一個html，而且每個頁面的標題，關鍵字，描述等資訊可能不同，所以我們在每個頁面資料夾下建立一個pageinfo.json,通過fs模組獲取到json裡資訊再遍歷到對應得html-webpack-plugin中生成一個html外掛陣列。

index/pageinfo.json 生成index.html頁面資訊

{
    "title":"首頁",
     "keywords":"webpack多頁面"
}

about/pageinfo.json 生成about.html頁面資訊供

{
    "title":"關於頁面",
    "keywords":"webpack多頁面關於頁面"
}

通過fs遍歷讀取並生成HtmlWebpackPlugin陣列供webpack使用

遍歷html外掛陣列

/**
 * @file htmlconfig.js  頁面html配置
 * @author:leinov
 * @date: 2018-10-09
 * @update: 2018-11-05
 * @use: 動態配置html頁面，獲取src下每個檔案下的pageinfo.json內容,解析到HtmlWebpackPlugin中
 */

const fs = require("fs");
const HtmlWebpackPlugin = require("html-webpack-plugin");//生成html檔案
const getFilePath = require("./getFilepath");
let htmlArr = [];

getFilePath("./src").map((item)=>{
    let infoJson ={},infoData={};
    try{
        // 讀取pageinfo.json檔案內容，如果在頁面目錄下沒有找到pageinfo.json 捕獲異常
        infoJson = fs.readFileSync(`src/${item}/pageinfo.json`,"utf-8");//
        infoData = JSON.parse(infoJson);
    }catch(err){
        infoData = {};
    }
    htmlArr.push(new HtmlWebpackPlugin({
        title:infoData.title ? infoData.title : "webpack,react多頁面架構",
        meta:{
            keywords: infoData.keywords ? infoData.keywords : "webpack，react，github",
            description:infoData.description ? infoData.description : "這是一個webpack，react多頁面架構"
        },
        chunks:[`${item}/${item}`], //引入的js
        template: "./src/template.html",
        filename : item == "index" ? "index.html" : `${item}/index.html`, //html位置
        minify:{//壓縮html
            collapseWhitespace: true,
            preserveLineBreaks: true
        },
    }));
});

module.exports = htmlArr;

wbpack終極配置

const path = require("path");
const getEntry = require("./webpackConfig/getEntry"); //入口配置
const entry = getEntry("./src");
const htmlArr =require("./webpackConfig/htmlConfig");// html配置

module.exports = (env, argv) => ({
    entry: entry
    output: {
        path: path.resolve(__dirname, `dist`),
        filename: `[name].js`
    }
    ....//其他配置
    devServer: {
    port: 3100,
    open: true,
    },
    plugins: [
        ...htmlArr
    ]
})

這樣一個自動化完整的多頁面架構配置就完成了，如果我們要新建立一個頁面

    1. 在src下建立一個檔案目錄
    1. 在新建立的檔案目錄下新增index.js（必須，因為是webpack打包入口檔案）
    1. 在新建立資料夾下新增pageinfo.json（非必須） 供html外掛使用
    1. npm run dev開發

完整程式碼參考專案code

版本

版本 日期 分支 備註
2.0 2018-11-08 master 優化html外掛自動化
1.0 2018-10-07 version1.0 第一版

相關文章