webpack+react多頁面開發架構

時間  2019-11-08
標籤 webpack+react webpack react 頁面 開發 架構 欄目 React 简体版
原文   原文鏈接

項目已經升級爲最新版本參考react-multi-page-app

webpack在單頁面打包上應用普遍，以create-react-app爲首的腳手架衆多，單頁面打包一般指的是將業務js，css打包到同一個html文件中，整個項目只有一個html文件入口,但也有許多業務須要多個頁面不一樣的入口，好比不一樣的h5活動，或者須要支持seo的官方網站，都須要多個不一樣的html。webpack-react-multi-page架構讓你能夠在多頁面在項目開發中自動化打包新建立頁面並保證每一個頁面均可以熱更新 ，build打包後有清晰的文件層次結構。javascript

概覽

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 便可css

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

項目架構

技術使用

  • react16

  • webpack4html

    • html-webpack-plugin 生成html文件
    • mini-css-extract-plugin css分離打包
    • uglifyjs-webpack-plugin js壓縮
    • optimize-css-assets-webpack-plugin css壓縮
  • es6
  • babel

  • node java

    • 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文件入口node

webpack單頁面打包配置

webpack.config.jsreact

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文件夾下打包出一個下面這樣的文件webpack

<!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支持兩種種格式git

打包單個文件

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

這樣就會在dist下打包出一個bundle.jses6

打包出多個文件

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文件github

將每一個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 初版
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程