React和Vue项目的webpack配置基本思路

本篇文章是自己通过搜集资料使用webpack4+react16+ts4搭建的一个React开发环境，目的主要是学习webpack整体搭建流程，以及各模块负责内容，然后准备使用这套环境使用react+ts+redux技术栈实现自己的移动端博客。

本文不是使用webpack搭建ts+react环境的开发教程，是搭建的一些前期规划与后期总结。

前期准备

首先使用npm init初始化一个项目在项目中创建一个config文件夹用来保存配置文件。

第一步区分环境
我的需求简单只是需要一个开发环境一个生产环境。因此在config文件夹下分别创建webpack.dev.js和webpack.prod.js两个文件。

第二步增加常量配置文件
在webpack.dev.js和webpack.prod.js文件中一些经常使用的变量，比如判断是否是dev环境的标志变量IS_DEV，还有项目根路径PROJECT_PATH，以及devServer里面要用的HOST,PORT等一些变量统一放到config.js文件中。

第三步独立BASE配置文件
第一步我们区分开了开发环境和生产环境，但是生产环境和开发环境有很多相同的配置项，因此将相同配置项抽出来放到同目录下的webpack.base.js文件中。最后使用webpack-merge插件将webpack.base.js文件和webpack-dev.js合并，还有将webpack.base.js和webpack.prod.js合并。

第四步独立build文件
为了在 build 时候方便做一些多余的处理，比如在build的时候在控制台使用一些提示插件提示正在打包文字提升开发体验等等，当打包完成后取消打包中显示。因此独立出来一个build.js文件，专门用来执行打包。

看下图结构：


config文件夹配置

通过上面四步，就在config文件夹下创建了build.js，config.js，webpack.base.js，webpack.dev.js，webpack.prod.js五个文件。
这五个文件分别是干什么的上面也说清楚了，然后说一下其他文件以及文件夹的作用吧。

config文件夹用来存放webpack配置文件；
dist是构建输出目录；
node_modules存放下载的node包；
public文件夹存放一些静态文件，以及html模板文件；
src文件夹用来存放开发时的代码；
.babelrc是babel的配置项；
.npmrc是对node包下载源的源配置，比如想用淘宝源，就在该文件中配置npm config set registry https://registry.npm.taobao.org；这样之后使用npm下载依赖包的时候，就默认使用淘宝源了。不用手动切换。
package.json存储项目信息；
README.md文件是我用来记录项目中遇到的一些问题一些解决方法等等。
tsconfig.json文件是typescript的配置文件。

好，整个文件目录介绍完了，现在就主要看webpack配置文件吧。

wepack配置规划图

配置文件内容

config.js
先从config文件夹下的config.js说起吧，直接看代码吧。

const path = require('path');
const IS_DEV = process.env.NODE_ENV !== 'production';
module.exports = {
    PROJECT_PATH: path.resolve(__dirname, "../"),
    IS_DEV,
    PORT: 8000,
    HOST: 'localhost'
}

这就是config.js中所有内容了，主要利用node的path模块对外暴露了项目根目录PROJECT_PATH，还通过process.env.NODE_ENV获取环境变量然后判断是否是development环境，并导出IS_DEV变量，这个环境变量问题稍后说。还导出了devServer要用的PORT和HOST，这里是自定义的一些东西，不必非得写在这里。假如devServer中的port和host完全可以就在devServer里面直接写死，不必再从这个文件中获取。

然后接着说一下环境变量的问题，环境变量我这里使用了cross-env插件，然后在package.js中配置run执行脚本命令的时候传递参数通过process.env.NODE_ENV动态获取参数内容，来做的。

npm i cross-env -D

package.json文件中：

{
    // ...
    "scripts":{
        "start": "cross-env NODE_ENV=development webpack-dev-server --config ./config/webpack.dev.js",
        "build": "cross-env NODE_ENV=production node ./config/build.js"
    }
    // ...
}

以上就是通过cross-env指定NODE_ENV的值之后在配置文件中可以通过process.env.NODE_ENV来获取。

这个环境变量还要其他的设置方式，比如在本地配置环境变量文件，可以参考creat-react-app配置。

webpack.base.js

webpack.base.js文件中主要做了webpack的基础配置项，代码如下：

// base 
const {resolve} = require('path');
const {PROJECT_PATH, IS_DEV} = require('./config');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const CopyPlugin = require('copy-webpack-plugin');
const WebpackBar = require('webpackbar');
const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const getCssLoaders = () => {
    return [
        IS_DEV ? 'style-loader' : MiniCssExtractPlugin.loader,
        {
            loader: 'css-loader',
            options: {
                sourceMap: IS_DEV,
            }
        },
        {
            loader: 'postcss-loader',
            options: {
                ident: 'postcss',
                plugins: [
                    require('postcss-flexbugs-fixes'),
                    require('postcss-preset-env')({
                        autoprefixer:{
                            grid: true,
                            flexbox: 'no-2009'
                        },
                        stage: 3
                    }),
                    require('postcss-normalize')
                ],
                sourceMap: IS_DEV
            }
        }
    ]
}
module.exports = {
    entry: {
        app: resolve(PROJECT_PATH, './src/index.tsx')
    },
    output: {
        filename: `js/[name]${IS_DEV ? '' :'.[hash:8]'}.js`,
        path: resolve(PROJECT_PATH, './dist')
    },
    module: {
        rules: [
            {
                test: /\.(tsx|js)$/,
                loader: 'babel-loader',
                options: {cacheDirectory: true},
                exclude: /node_modules/
            },
            {
                test: /\.css$/,
                use: getCssLoaders(),
            },
            {
                test: /\.less$/,
                use: [
                    ... getCssLoaders(),
                    {
                        loader: 'less-loader',
                        options: {
                            sourceMap: IS_DEV
                        }
                    }
                ]
            },
            {
               test: /\.scss$/,
               use: [
                   ...getCssLoaders(),
                   {
                       loader: 'sass-loader',
                       options: {
                           sourceMap: IS_DEV
                       }
                   }
               ] 
            },
            {
                test: /\.(png|jpg|jpeg|gif|svg)$/i,
                use: [
                    {
                        loader: 'url-loader',
                        options: {
                            limit: 10 * 1024,
                            name: '[name].[contenthash:8].[ext]',
                            outputPath: 'images'
                        }
                    }
                ]
            },
            {
                test: /\.(ttf|woff|woff2|eot|otf)$/,
                use: [
                    {
                        loader: 'url-loader',
                        options: {
                            name: '[name].[contenthash:8].[ext]',
                            outputPath: 'fonts'
                        }
                    }
                ]
            }
        ]
    },
    plugins: [
        new HtmlWebpackPlugin({
            template: resolve(PROJECT_PATH, './public/index.html'),
            filename: 'index.html',
            cache: false,
            minify: IS_DEV ? false : {
                removeAttributeQuotes: true,
                collapseWhitespace: true,
                removeComments: true,
                collapseBooleanAttributes: true,
                collapseInlineTagWhitespace: true,
                removeRedundantAttributes: true,
                removeScriptTypeAttributes: true,
                removeStyleLinkTypeAttributes: true,
                minifyCSS: true,
                minifyJS: true,
                minifyURLs: true,
                useShortDoctype: true,
            }
        }),
        new CopyPlugin({ // 拷贝静态资源
            patterns: [
                {
                    context: resolve(PROJECT_PATH, './public'),
                    from: '*',
                    to: resolve(PROJECT_PATH, './dist'),
                    toType: 'dir'
                },
                {
                    context: resolve(PROJECT_PATH, './public/static'),
                    from: '*',
                    to: resolve(PROJECT_PATH, './dist/static'),
                    toType: 'dir'
                }
            ]
        }),
        new WebpackBar({ // 显示启动进度
            name: IS_DEV ? '正在启动' : '正在打包'
        }),
        new ForkTsCheckerWebpackPlugin(), // 编译时typescript类型检查
    ],
    resolve: {
        extensions: ['.tsx', '.ts', '.js', '.json'],
        alias: {
            'Src': resolve(PROJECT_PATH, './src'),
            'Components': resolve(PROJECT_PATH, './src/components'),
            'Containers': resolve(PROJECT_PATH, './src/containers')
        }
    },
    devtool: IS_DEV ? 'cheap-module-eval-source-map' : 'cheap-module-source-map'
}

常用的导入以及配置细节就不多说了，都是遵循webpack配置规则，有配置疑问的可以在webpack官网或者npm官网查资料，看一下里面有个getCssLoaders函数，如下：

const getCssLoaders = () => {
    return [
        IS_DEV ? 'style-loader' : MiniCssExtractPlugin.loader,
        {
            loader: 'css-loader',
            options: {
                sourceMap: IS_DEV,
            }
        },
        {
            loader: 'postcss-loader',
            options: {
                ident: 'postcss',
                plugins: [
                    require('postcss-flexbugs-fixes'),
                    require('postcss-preset-env')({
                        autoprefixer:{
                            grid: true,
                            flexbox: 'no-2009'
                        },
                        stage: 3
                    }),
                    require('postcss-normalize')
                ],
                sourceMap: IS_DEV
            }
        }
    ]
}

这个函数的作用主要是将loader配置中的公共部分 style-loader，css-loader，postcss-loader这些配置提取出来，这样的话就可以将css,less,sass中多余的配置项都抽取出来，也可以将该函数放到外面的config.js文件中去维护，尤其是base.js文件特别多的时候，目前我就暂且这么放了。

webpack.dev.js
在dev环境中最重要的就是devServer了，因此在该文件中主要做了devServer的配置还有热更新的配置。

const {merge} = require('webpack-merge');
const baseConfig = require('./webpack.base');
const {PORT, HOST} = require('./config');
const webpack = require('webpack');
module.exports = merge(baseConfig, {
    mode: 'development',
    devServer: {
        host: HOST,
        port: PORT,
        open: true,
        hot: true,
        stats: 'errors-only', // 终端仅打印 error
    },
    plugins: [
        new webpack.HotModuleReplacementPlugin()
    ]
})

当该文件配置内容完成时，需要将最终结果导出的时候，这个时候需要将base的配置和当前dev配置进行merge然后再导出。这里使用了webpack.HotModuleReplacementPlugin插件。同时在使用热更新插件时，需要在项目入口文件（也就是src/index.tsx）中添加如下代码：

if ((module as any) && (module as any).hot) {
  // 热更新设置 as any解决 Property 'hot' does not exist on type 'NodeModule'.
  (module as any).hot.accept();
}

webpack.prod.js
在生产环境比较重要的就是代码体积压缩，分包优化，缓存处理。更好的支持tree-shaking等。

const {merge} = require('webpack-merge');
const {resolve} = require('path');
const {PROJECT_PATH} = require('./config');
const baseConfig = require('./webpack.base');
const {CleanWebpackPlugin} = require('clean-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const PurgeCSSPlugin = require('purgecss-webpack-plugin');
const glob = require('glob');
const TerserWebpackPlugin = require('terser-webpack-plugin');
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
module.exports = merge(baseConfig, {
    mode: 'production',
    plugins: [
        new CleanWebpackPlugin(), // 清理构建产物
        new MiniCssExtractPlugin({
            filename: 'css/[name].[contenthash:8].css',
            chunkFilename: 'css/[name].[contenthash:8].css',
            ignoreOrder: false
        }),
        new PurgeCSSPlugin({ // 剔除没有用到的css样式
            paths: glob.sync(`${resolve(PROJECT_PATH, './src')}/**/*.{tsx,scss,less,css}`, {nodir: true}),
            whitelist: ['html', 'body']
        })
    ],
    optimization: {
        minimize: true,
        minimizer: [
            new TerserWebpackPlugin({ // js压缩
                extractComments: false,
                terserOptions: {
                    compress: {
                        pure_funcs: ['console.log']
                    }
                }
            }),
            new OptimizeCSSAssetsPlugin() // css压缩整合
        ].filter(Boolean),
        splitChunks:{ // 分包优化
            chunks: 'async',
            minSize: 30000,
            minChunks: 1,
            maxAsyncRequests: 5,
            maxInitialRequests: 3,
            name: false,
            cacheGroups: {
              vendor: {
                name: 'vendor',
                chunks: 'initial',
                priority: -10,
                reuseExistingChunk: false,
                test: /node_modules\/(.*)\.js/
              },
              styles: {
                name: 'styles',
                test: /\.(scss|css)$/,
                chunks: 'all',
                minChunks: 1,
                reuseExistingChunk: true,
                enforce: true
              }
            }
        }
    }
})

以上文件中常用的生产环境内容简单的说一下。
clean-webpack-plugin插件用来在每次build之前自动清理构建产物。
mini-css-extract-plugin插件用来将css内容提取出来到一个.css文件中（使用style-loader的css样式文件是默认被插入到html文件的style标签里的，这样不利于做缓存），然后加入文件指纹（hash，chunkHash，contentHash）可以用来配合浏览器做样式缓存。
purgecss-webpack-plugin插件主要用来剔除在文件中没有用到的样式内容，类似于tree-shaking将死代码剔除掉。可以减小代码体积。
terser-webpack-plugin插件主要是webpack4中用来替换UglifyJs插件，更好支持ES6语法压缩，也可以额外配置多进程压缩。
optimize-css-assets-webpack-plugin插件主要是对css样式文件进行压缩处理。
splitChunks中的一些配置项主要是针对被多次引用文件，体积较大文件进行分包单独抽离，减小文件打包体积。

build.js
将build的文件单独拎出来，在执行webpack函数时可以做一些额外操作。

const ora = require('ora')
const webpack = require('webpack');
const webpackConfig = require('./webpack.prod.js');
const spinner = ora('building for production...')
spinner.start()
webpack(webpackConfig, (err, stats) => {
    spinner.stop()
})

比如在build的时候，执行提示，执行完成之后提示消失。

还有就是配置文件中的mode，它不仅仅是用来区分开发环境与生产环境的，而是在不同的模式下webpack会默认根据不同模式执行不同的内置函数。执行内置函数对项目进行优化等操作。
设置mode可以自动触发webpack中的某些函数

Mode的内置函数功能

选项 描述
development 设置 process.env.NODE_ENV的值为development.
开启NameChunksPlugin和NameModulesPlugin.
production 设置process.env.NODE_ENV的值为production.
开启FlagDependencyUsagePlugin, FlagIncludeChunksPlugin，
ModileConcatentationPlugin，NoEmitOnErrorsPlugin，
OccurrenceOrderPlugin，SideEffectsFlagPlugin和TerserPlugin.
none 不开启任何优化选项

到这里整个webpack里面的配置文件就完成了，该文章提供一个webpack配置思路，可以用来配置Vue应用配置，也可以用来配置React应用配置。

我会用这套配置自己写一下个人移动端小博客，技术栈使用webpack+react+redux+typescript

webpack配置代码库 https://github.com/Mstian/webpack-config-react

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 199,519评论 5赞 468
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 83,842评论 2赞 376
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 146,544评论 0赞 330
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 53,742评论 1赞 271
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 62,646评论 5赞 359
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,027评论 1赞 275
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,513评论 3赞 390
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,169评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,324评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,996评论 3赞 315
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,591评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1赞 255
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2赞 345
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2赞 341