Webpack生成企业站静态页面 - 项目搭建

        现在Web前端流行的三大框架有Angular、React、Vue，很多项目经过这几年的洗礼，已经都 转型使用这三大框架进行开发，那为什么还要写纯静态页面呢？比如Vue中除了SPA单页面开发，也可以使用nuxt.js实现SSR服务端渲染，满足SEO优化。但是对于那些还是在维护老项目，使用MVC、MVP进行开发，或者觉得使用nuxtjs成本较高小型项目，从历史原因和项目实际情况考虑，会退而求其次，让前端快速完成页面框架和样式，交付后端进行数据渲染。

        虽然现在市面上开发静态页面需求量不大，作为个学习和了解，还是决定写下使用webpack如果快速完成静态页面搭建，并能像三大框架一样能实现组件化开发，并使用less/sass/styuls完成样式的预编译，提升静态页面开发效率。

一、环境搭建

1.1 创建项目

        在您的电脑上创建一个项目目录，这里命名为“island"，如下图：

1.2 初始化项目

        打开cmd或者IDE编辑工具，打开命令控制台操作界面，初始化生成package.json文件，输入命令”npm init“，如下图：

        命令执行完毕后，目录中就已生成了package.json，如下较：

1.3 安装webpack

        操作命令如下：

npm i -D webpack webpack-cli

        待命令执行完毕后，项目目录中则会生成node_modules，此时webpack已安装成功，如下图：

二、webpack配置文件

2.1 创建配置文件

        在island目录下面创建webpack.config.js文件，以及源文件目录src，先在src目录下创建一个index.js文件作测试，如下l图：

        代码如下：

const { resolve } = require('path');module.exports = {entry: [resolve(__dirname, './src/index.js')],mode: 'production'
}

        此时webpack已经可以正常运行了，在命令行中输入webpack即可，如下图：

        此时island目录中则会多出一个dist目录，在不配置情况下，默认输出目录名称为“dist”。由于output还未配置，webpack默认输出入口文件为main.js，如下图：

2.2  output配置

        output 位于对象顶级键(key)，包括了一组选项，指示 webpack 如何去输出、以及在哪里输出你的「bundle、asset 和其他你所打包或使用 webpack 载入的任何内容」。

        将output对js文件输出结果进行修改，代码如下：

const { resolve } = require('path');module.exports = {entry: [resolve(__dirname, './src/index.js')],output: {filename: 'app.bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},mode: 'production'
}

        此时运行结果生成入口的js则从main.js变成app.bundle.js，如下图：

2.3 js资源输出

        如下图，当我们写静态页面时，全有首页、列表页、详情页、联系我们、预约等页面，每个页面有公共资源，也有独有资源，所以这时就需要进行多谁的输出了。

        首衔根据上图，把所有html页面和对应页面的js创建好，如下图：

        然后在webpack.config.js中，配置好多入口文件，即可生成对应js文件了（注意：因为现在entry中是多入口文件，所以output中filename不能写死，需要改成[name]动态取对应入口文件名称），代码如下：

const { resolve } = require('path');module.exports = {entry: {index: resolve(__dirname, './src/js/index.js'),list: resolve(__dirname, './src/js/list.js'),article: resolve(__dirname, './src/js/article.js'),contact: resolve(__dirname, './src/js/contact.js'),message: resolve(__dirname, './src/js/message.js'),},output: {filename: '[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},mode: 'production'
}

        此时执行webpack命令，则dist会生成对应的js文件。由于chunkfilename是根据chunk发送的请示去生成的，所以现在还不是根据此格式进行命名，这块后面再讲。如下图：

2.4 提取html页面

        提取生成html文件，需要安装html-loader和html-webpack-plugin，命令如下：

npm i -D html-loader html-webpack-plugin

       html-webpack-plugin配置参数：

        首先我们使用html-webpack-plugin来提取html文件，在webpack.config.js中引用，代码如下：

const { resolve } = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');module.exports = {entry: {index: resolve(__dirname, './src/js/index.js'),list: resolve(__dirname, './src/js/list.js'),article: resolve(__dirname, './src/js/article.js'),contact: resolve(__dirname, './src/js/contact.js'),message: resolve(__dirname, './src/js/message.js'),},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},plugins: [new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/index.html`),filename: 'index.html',chunks: ['index'],minify: false}),new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/list.html`),filename: 'list.html',chunks: ['list'],        // chunk发送请求生成对应js文件，并引入html中minify: false})],mode: 'production'
}

        如上，先生成首页和列表页的html页面，执行webpack，结果如下图：

        此时在dist目录中已生成了index.html和list.html页面，并且打开index.html页面发现index.bundle.js也自动添加到html页面中了。

2.5 html中图片资源处理

        首先，在src目录下创建images目录用于存储图片资源，并且在index.html页面中添加几张图片引入代码，如下图：

        执行webpack命令后，结果如下图：

        从上图可以看出生成的index.html页面中，资源路径还是和源文件index.html中路径一样，未根据dist目录重构，而且dist目录中也没生成对应images目录及图上资源。从而得出结论html-webpack-plugin并未处理html内容中的图片资源，这里我们将使用html-loader来实现图片资源的提取。

        html-loader配置参数：

        代码如下：

const { resolve } = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');module.exports = {entry: {index: resolve(__dirname, './src/js/index.js'),list: resolve(__dirname, './src/js/list.js'),article: resolve(__dirname, './src/js/article.js'),contact: resolve(__dirname, './src/js/contact.js'),message: resolve(__dirname, './src/js/message.js'),},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/index.html`),filename: 'index.html',chunks: ['index'],minify: false}),new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/list.html`),filename: 'list.html',chunks: ['list'],minify: false})],mode: 'production'
}

        此时再运行webpack命令，图片资源就可以构建到dist目录指定位置了，并且index.html中图片资源也一起更新成dist目录中新路径，如下图：

2.6 优化配置文件

         由于后期项目中页面会不断增加，webpack.config.js中同需不断在entry和plugins中添加新内容，久而久之代码会显示的很臃肿，这里将页面部分独立出来，在island目录中新建static.config.js文件，如下图：

        static.config.js文件代码如下，后期有新增页面时，在此配置即可。

const { resolve } = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');// 引用JS文件
const scripts = ["index", "list", "article", "contact", "message"];
// 需要生成的静态页面
const htmls = [{name: "index.html", chunks: ['index']},{name: "list.html", chunks: ['list']},{name: "article.html", chunks: ['article']},{name: "contact.html", chunks: ['contact']},{name: "message.html", chunks: ['message']}
];
/*** 静态页面配置*/
module.exports = {// 重组js入口文件entrys: () => {let params = {};scripts.forEach(name => {params[name] = resolve(__dirname, `./src/js/${name}.js`);})return params;},// 重组静态页面文件staticHtmls: () =>  htmls.map(item => {return new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/${item.name}`),filename: item.name,chunks: item.chunks,minify: false});})
}

        webpack.config.js文件代码如下：

const { resolve } = require('path');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [...staticHtmls()],mode: 'production'
}

        优化完成后，此时再运行webpack，所有页面则全部生成，如下图：

2.7 css文件引入

        处理css样式文件，需要安装三个loader，命令如下：

npm i -D style-loader css-loader less-loader

        webpack.config.js中添加处理样式文件的loader，代码如下：

const { resolve } = require('path');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// style-loader 把 CSS 插入到 DOM 中。// css-loader 会对 @import 和 url() 进行处理，就像 js 解析 import/require() 一样。{test: /\.css$/i,use: ["style-loader", 'css-loader']},// webpack 将 Less 编译为 CSS 的 loader。{test: /\.less$/i,use: ["style-loader", 'css-loader', 'less-loader']},// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [...staticHtmls()],mode: 'production'
}

        在src目录下创建css目录用于存储样式文件，并创建index.less文件，在js/index.js中引入。

        index.less代码如下：

#app{margin: 0;padding: 0;
}

        js/index.js代码如下：

import '../css/index.less';

        添加后，运行webpack.config.js会发现，构建后的css内容是写在js/index.js文件中，并且index.html在浏览器中打开时，样式内容被动态注入到html页面中，如下图：

2.8 提取CSS为单独文件

        如何提出CSS为单独文件，并能像js文件一样，将引用链接自动添加到html内容中呢？这里就要用到一个新插件：mini-css-extract-plugin，通过命令进行安装，代码如下：

npm i -D mini-css-extract-plugin

        安装完成后，也是通过new实例并放在pugins。另外需要注意的是module中style-loader要替换成mini-css-extract-plugin插件的loader，这个插件将CSS提取到单独的文件中，为每个包含CSS的JS文件创建一个CSS文件，它支持按需加载CSS和SourceMaps。

        它建立在webpack v4新特性(模块类型)之上，需要webpack 4及以上版本才能工作。

        webpack.config.js 代码如下：

const { resolve } = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// style-loader 把 CSS 插入到 DOM 中。// MiniCssExtractPlugin.loader 提取CSS为独立文件// css-loader 会对 @import 和 url() 进行处理，就像 js 解析 import/require() 一样。{test: /\.css$/i,use: [MiniCssExtractPlugin.loader, 'css-loader']},// webpack 将 Less 编译为 CSS 的 loader。{test: /\.less$/i,use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader']},// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [...staticHtmls(),// 提取css文件new MiniCssExtractPlugin({filename: 'css/[name]_bundle.css',      //输出文件})],mode: 'production'
}

        此时运行webpack，样式文件则提取了来了，结果如下图：

2.9 alias别名

        创建 import 或 require 的别名，来确保模块引入变得更简单。例如，指定样式文件src/css 文件夹下的常用模块：

const { resolve } = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// style-loader 把 CSS 插入到 DOM 中。// MiniCssExtractPlugin.loader 提取CSS为独立文件// css-loader 会对 @import 和 url() 进行处理，就像 js 解析 import/require() 一样。{test: /\.css$/i,use: [MiniCssExtractPlugin.loader, 'css-loader']},// webpack 将 Less 编译为 CSS 的 loader。{test: /\.less$/i,use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader']},// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [...staticHtmls(),// 提取css文件new MiniCssExtractPlugin({filename: 'css/[name]_bundle.css',      //输出文件})],resolve: {alias: {// 样式目录路径别名$css: resolve(__dirname, 'src/css')}},mode: 'production'
}

        将index.js中引入的样式文件路径，用$css替换，代码如下：

import '../css/index.less';替换为import '$css/index.less';

        此时再运行webpack，结果还是一样的，样式文件正常构建成功。

2.10 本地服务(devServer)

        webpack-dev-server 能够用于快速开发应用程序，创建本地服务运行；当服务启动时，会解析指定dist目录。

        要想使用devServer，要先安装webpack-dev-server，安装命令：

npm i -D webpack-dev-server

        webpack.config.js 代码如下：

const { resolve } = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// style-loader 把 CSS 插入到 DOM 中。// MiniCssExtractPlugin.loader 提取CSS为独立文件// css-loader 会对 @import 和 url() 进行处理，就像 js 解析 import/require() 一样。{test: /\.css$/i,use: [MiniCssExtractPlugin.loader, 'css-loader']},// webpack 将 Less 编译为 CSS 的 loader。{test: /\.less$/i,use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader']},// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},]},plugins: [...staticHtmls(),// 提取css文件new MiniCssExtractPlugin({filename: 'css/[name]_bundle.css',      //输出文件})],resolve: {alias: {// 样式路径目录别名$css: resolve(__dirname, 'src/css')}},mode: 'production',devServer: {static: {// 指定服务运行目录directory: resolve(__dirname, 'dist')},compress: true,     //gzip压缩port: 3000,         //指定端口号open: true,         //服务启动后自动在浏览器打开hot: true           //开启热更}
}

        devServer添加完成后，在控制台输入命名npx webpack serve，等待服务开始即可。运行结果如下：

2.11 公共文件

        在项目中，会有公共的样式和js功能，所以创建common.js和common.less文件（注意common.less文件需要在common.js文件中引入），如下图：

        common.js文件代码如下：

import '$css/common.less';

        另外将common.js放入到htmlWebpackPlugin的chunks中（注意：entry入口中也要添加common，这里放在scipts数组中）。

        static.config.js 代码如下：

const { resolve } = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');// 引用JS文件
const scripts = ["common", "index", "list", "article", "contact", "message"];
// 需要生成的静态页面
const htmls = [{name: "index.html", chunks: ['index']},{name: "list.html", chunks: ['list']},{name: "article.html", chunks: ['article']},{name: "contact.html", chunks: ['contact']},{name: "message.html", chunks: ['message']}
];
/*** 静态页面配置*/
module.exports = {// 重组js入口文件entrys: () => {let params = {};scripts.forEach(name => {params[name] = resolve(__dirname, `./src/js/${name}.js`);})return params;},// 重组静态页面文件staticHtmls: () =>  htmls.map(item => {return new HtmlWebpackPlugin({inject: 'body',template: resolve(__dirname, `./src/${item.name}`),filename: item.name,chunks: ['common', ...item.chunks],minify: false});})
}

        此时运行webpack，common.js和common.css则已生成出来，并且引入到所有html内容中，如下图：

2.12 引用jquery

        由于静态页面中资源都打包到一个文件中，体积会越积越大，所以这里将jquery整体暴露给window，这就需要使用到另个loader，首先先安装jquery和expose-loader，命令如下:

// 安装jquery插件
npm i -S jquery

// 安装expose-loader
npm i -D expose-loader

        安装完成后，我们先在common.js文件中添加浏览器控制台输入，并且将jquery构建到dist/js目录中。

        webpack.config.js文件中添加jquery入口文件，如下图：

        static.config.js文件中将jquery添加到每个html谁的的chunks中，如下图

        common.js文件代码如下：

import '$css/common.less';console.log('jquery', jQuery);

        此是运行npx webpack serve，在浏览器打开控制台查看，如下图：

        结果显示jquery不存在，这是因为我们安装的jquery还没有暴露给window对象，现在把expose-loader添加到webpack.config.js中再看看效果，代码如下：

const { resolve } = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { entrys, staticHtmls } = require('./static.config');module.exports = {entry: {jquery: ['jquery'],...entrys()},output: {filename: 'js/[name].bundle.js',      // 对入口名称进行命名,clean: true                     // 在生成文件之前清空 output 目录},module: {rules: [// style-loader 把 CSS 插入到 DOM 中。// MiniCssExtractPlugin.loader 提取CSS为独立文件// css-loader 会对 @import 和 url() 进行处理，就像 js 解析 import/require() 一样。{test: /\.css$/i,use: [MiniCssExtractPlugin.loader, 'css-loader']},// webpack 将 Less 编译为 CSS 的 loader。{test: /\.less$/i,use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader']},// 匹配图片资源，指定构建后存储位置和命名{test: /\.(png|jpg|jpeg|svg|gif)$/i,type: 'asset/resource',generator: {filename: 'images/[name].[ext]'}}, // 匹配html页面，并提取内部资源文件{test: /\.html$/i,loader: "html-loader",exclude: /node_modules/,options: {minimize: false,        // 不压缩html内容}},// 将jquery暴露给全局对象（self、window 和 global）{test: require.resolve('jquery'),loader: "expose-loader",options: {exposes: ["$", "jQuery"]}}]},plugins: [...staticHtmls(),// 提取css文件new MiniCssExtractPlugin({filename: 'css/[name]_bundle.css',      //输出文件})],resolve: {alias: {// 样式路径目录别名$css: resolve(__dirname, 'src/css')}},mode: 'production',devServer: {static: {// 指定服务运行目录directory: resolve(__dirname, 'dist')},compress: true,     //gzip压缩port: 3000,         //指定端口号open: true,         //服务启动后自动在浏览器打开hot: true           //开启热更}
}

        expose-loader添加完成后，再运行npx webpack serve，此时jquery在浏览器中则可以全局调用了，如下图：

三、package.json

        最后整理一下项目中所需要的loader、plugin，以及其对应的版本和功能描述。

        本篇内容就先讲到这，如果还需其他功能做进一步完善，可以去webpack了解，地址：webpack 中文文档(@印记中文) https://docschina.org/