Webpack多页面应用配置指南：动态入口与HTML插件实战

在Web开发中，使用Webpack搭建单页面应用（SPA）已十分普遍。然而在实际业务场景中，我们往往面临开发多页面应用（MPA）的需求。为此，本文深入探讨了基于Webpack构建多页面程序的具体实现方案。

原理

核心思路是将每个页面所在的文件夹视为一个独立的单页面应用目录。通过配置多个Entry入口以及多个html-webpack-plugin实例，即可实现多页面的打包处理。

下面为本项目目录结构


.
├─ src
│ └─ pages
│    ├─ about
│    │  ├─ index.css
│    │  ├─ index.html
│    │  └─ index.js
│    └─ index
│      ├─ index.css
│      ├─ index.html
│      └─ index.js
└─ webpack.config.js

单页面打包基础配置

首先回顾一下单页面应用的Webpack基础配置模式。


const HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
 entry: './src/index.js',
 plugins: [
  new HtmlWebpackPlugin({
   template: './src/index.html',
   filename: 'index.html',
  }),
 ],
 output: {
  path: path.resolve(__dirname, './dist'),
  filename: 'bundle.js',
 },
};

若要将单页面应用改造为多页面应用，关键在于将原有的单入口和单HTML模板，升级为多入口和多HTML模板的配置方式。

多页面打包基础配置

改造入口

传统的多入口配置通常采用键值对的形式进行定义。


module.exports = {
 entry: {
  index: './src/pages/index/index.js',
  about: './src/pages/about/index.js',
 },
 ...
}

这种手动编写的方式在页面数量增加时会显得繁琐。因此，我们可以定义一个函数，根据项目目录结构自动扫描并生成入口配置，从而简化操作流程。


const glob = require('glob');

function getEntry() {
 const entry = {};
 glob.sync('./src/pages/**/index.js').forEach((file) => {
  const name = file.match(/\/pages\/(.+)\/index.js/)[1];
  entry[name] = file;
 });
 return entry;
}

module.exports = {
 entry: getEntry(),
 ...
}

改造输出

在Output配置项中，硬编码输出文件名已不再适用。我们需要将输出文件名改为与源文件名称相匹配的动态格式，以确保每个页面生成独立的打包文件。


module.exports = {
 ...
 output: {
  path: path.resolve(__dirname, './dist'),
  filename: 'js/[name].[contenthash].js',
 },
 ...
}

配置多个 html-webpack-plugin

与入口配置类似，我们可以将不同的HTML模板直接写入插件配置中。需要注意的是，必须为每个插件实例配置对应的chunks参数，以防止JavaScript代码被错误地注入到不相关的HTML文件中。


const HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
 ...
 plugins: [
  new HtmlWebpackPlugin({
   template: './src/pages/index/index.html',
   chunks: ['index'],
   filename: 'index.html',
  }),
  new HtmlWebpackPlugin({
   template: './src/pages/about/index.html',
   chunks: ['about'],
   filename: 'about.html',
  }),
 ],
 ...
};

这种做法同样存在手动维护的弊端。因此，我们定义一个辅助函数来自动生成这些插件配置，以提高配置的灵活性和可维护性。


const HtmlWebpackPlugin = require('html-webpack-plugin');
const glob = require('glob');

function getHtmlTemplate() {
 return glob
  .sync('./src/pages/**/index.html')
  .map((file) => {
   return { name: file.match(/\/pages\/(.+)\/index.html/)[1], path: file };
  })
  .map(
   (template) =>
    new HtmlWebpackPlugin({
     template: template.path,
     chunks: [template.name.toString()],
     filename: `${template.name}.html`,
    })
  );
}

 
module.exports = {
 ...
 plugins: [...getHtmlTemplate()],
 ...
};

至此，一个基础的多页面项目配置便已完成。在此基础上，开发者还可以进一步添加热更新、代码分割等高级功能，有兴趣的读者可自行尝试扩展。

完整配置

项目地址：xmy6364/webpack-multipage


// webpack.config.js

const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const glob = require('glob');
const { CleanWebpackPlugin } = require('clean-webpack-plugin');

// 多页入口
function getEntry() {
 const entry = {};
 glob.sync('./src/pages/**/index.js').forEach((file) => {
  const name = file.match(/\/pages\/(.+)\/index.js/)[1];
  entry[name] = file;
 });
 return entry;
}

// 多页模板
function getHtmlTemplate() {
 return glob
  .sync('./src/pages/**/index.html')
  .map((file) => {
   return { name: file.match(/\/pages\/(.+)\/index.html/)[1], path: file };
  })
  .map(
   (template) =>
    new HtmlWebpackPlugin({
     template: template.path,
     chunks: [template.name.toString()],
     filename: `${template.name}.html`,
    })
  );
}

const config = {
 mode: 'production',
 entry: getEntry(),
 output: {
  path: path.resolve(__dirname, './dist'),
  filename: 'js/[name].[contenthash].js',
 },
 module: {
  rules: [
   {
    test: /\.css$/,
    use: ['style-loader', 'css-loader'],
   },
  ],
 },
 plugins: [new CleanWebpackPlugin(), ...getHtmlTemplate()],
 devServer: {
  contentBase: path.join(__dirname, 'dist'),
  compress: true,
  port: 3000,
  hot: true,
  open: true,
 },
};

module.exports = config;

到此这篇关于使用Webpack构建多页面程序的实现步骤的文章就介绍到这了,更多相关Webpack构建多页面内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站！

使用Webpack构建多页面程序的实现步骤

原理