图解Webpack——基础篇

本节主要用于入门webpack，首先用一张利用MindMaster绘制思维导图开篇来阐述本文的主要内容，读者可在此基础上进行扩展自己的思维导图。

一、Entry

定义：指示webpack应该使用哪个模块，来作为构建其内部依赖图的开始。（从入口开始，搜寻并递归解析出所有入口依赖的模块）

1.1 单入口

对于单入口文件，其值为string类型，打包形成一个chunk，输出一个bundle文件。

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

1.2 多入口

1. 输入为一个数组，但是入口文件最终只会形成一个chunk，输出出去只有一个bundle文件。

module.exports = {
    entry: ['./src/index.js','./src/add.js']
}

1. 输入为对象，有几个入口文件就形成几个chunk，输出几个bundle1文件

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

1.3 动态入口

输入为一个函数（同步或异步），用于动态的返回上面所需的入口内容。

module.exports = {
    entry: () => new Promise((resolve) => resolve(['./src/index.js','./src/add.js']))
}

二、Output

指示webpack如何去输出、以及在哪里输出你的bundle、asset 和其他你所打包或使用 webpack载入的任何内容。

2.1 名称

对于输出的名字，常用的主要有两类:filename(输出bundle名称)和chunkFilename(非入口chunk名称)。

1. filename（配置输出文件的名称，为string类型）

module.exports = {
    //文件名称（指定名称+目录）
    filename: '[name].js'
}

1. chunkFilename（配置非入口chunk的名称）

对于非入口文件，产生方式有两种：方式一是通过import语法会将一个文件单独分割成一个chunk；方式二是利用optimization将node_modules分割成chunk。（见后续博客）

module.exports = {
    //非入口chunk名称
    chunkFilename: '[name]_chunk.js'
}

2.2 路径

对于配置的输出路径，常用的主要有两个：path和publicPath。

1. path(配置输出文件存放的目录，必须是string类型的绝对路径)

module.exports = {
    path: path.resolve(__dirname, 'dist_[hash]')
}

1. publicPath（所有资源引入公共路径前缀）

module.exports = {
    publicPath: 'https://cdn.example.com/'
}

2.3 输出库

当用webpack去构建一个可以被其它模块导入使用的库时，需要用到libraryTarget和library。其中libraryTarget配置何种方式导出库；library配置导出库名称。

module.exports = {
    library: '[name]',
    libraryTarget: 'window',//var、assign、this、window、global、commonjs、commonjs2、amd、umd……
}

三、Loader

webpack只能理解JavaScript和JSON文件，通过loader让webpack能够去处理其它类型的文件，并将它们转换为有效 模块，以供应用程序使用，以及被添加到依赖图中。

3.1 样式资源

对于css和less这样的样式资源，webpack不能直接进行处理，所以需要经过webpack翻译后才可以使用。此外不同浏览器对CSS的支持不同，为了CSS解决兼容性问题，可借助postcss-loader进行处理。

module.export = {
    ……
    module: {
        rules: [
            {
                test: /\.css$/,
                use: [
                    //创建style标签，将js中的样式资源插入到html文件中。
                    'style-loader',
                    // 将css文件变成commonjs模块加载到js中
                    'css-loader',
                    'postcss-loader',
                ]
            },
            {
                test: /\.less$/,
                use: [
                    'style-loader',
                    'css-loader',
                    // 将less文件编译成css文件
                    'less-loader',
                ]
            }
        ]
    }
}

3.2 图片资源

对于图片资源来说，主要可以分为html中图片和非html中图片。对于url-loader或file-loader能够处理js、css等中的图片资源，但是不能直接处理html中的图片资源，所以需要引用html-loader，负责引入img，从而能被url-loader进行处理。

module.exports = {
    module: {
        rules: [
            {
                test: /\.(png|jpg|gif)$/,
                loader: 'url-loader',
                options: {
                    limit: 8 * 1024,
                    name: '[hash:10].[ext]',
                    outputPath: 'asset/images'
                }
            },
            {
                test: /\.html/,
                loader: 'html-loader',
            },
        ]
    }
}

3.3 js文件

1. 因为每个人写代码的风格不同，为了统一js文件的风格，规范代码，可以采用eslint-loader进行处理。

module.exports = {
    ……
    module: {
        rules: [
            {
                test: /\.js$/,
                exclude: /node_modules/,
                // 优先执行
                enfore: 'pre',
                loader: 'eslint-loader',
                options: {
                    // fix: true
                }
            }
        ]
    }
}

此处可以用比较权威的Airbnb来进行语法检查，需要在package.json中添加:

"eslintConfig": {
    "extends": "airbnb-base",
    "env": {
      "browser": true
    }
}

1. 不同浏览器对js代码的支持性不同，所以需要对js代码进行兼容性处理，可以利用babel-loader，配置方式主要有三种：

（1） 基本js兼容性处理-->@babel/preset-env<br/>
问题：只能转换基本语法，如Promise不能转换<br/>
（2）全部js兼容性处理--> @babel/polyfill<br/>
对于这个文件，只需要在js文件中直接引入即可
import '@babel/polyfill';
这会将js有兼容性的东西全部带进来。<br/>
问题：我只要解决部分兼容性问题，但是将所有兼容性代码全部引入，导致文件体积太大了<br/>
（3）需要做兼容性处理的就做：按需加载 --> core-js<br/>此时要把第二种方案的代码注释掉。

module.exports = {
    ……
    module: {
        rules: [
            {
                test: /\.js$/,
                exclude: /node_modules/,
                loader: 'babel-loader',
                options: {
                    // 预设：指示babel做怎么样的兼容性处理
                    presets: [
                        '@babel/preset-env',
                        {
                            // 按需加载
                            useBuiltIns: 'usage',
                            // 指定core-js版本
                            corejs: {
                                version: 3
                            },
                            // 指定兼容性做到哪个版本浏览器
                            targets: {
                                chrome: '60',
                                firefox: '60',
                                edge: '17',
                                safari: '10',
                            }
                        }
                    ]
                }
            }
        ]
    }
}

3.4 其它资源

对于不需要进行优化、压缩等进行处理的文件，例如字体图标、SVG等，可以直接被引入使用，这个时候用file-loader直接处理即可。

module.exports = {
    module: {
        rules: [
            {
                exclude: /\.(css|js|html|less|jpg|png|gif)$/,
                loader: 'file-loader',
                options: {
                    name: '[hash:10].[ext]',
                }
            }
        ]
    }
}

四、Plugin

插件目的是解决loader无法实现的其他事，可用于执行范围更广的任务，为webpack带来很大的灵活性。

4.1 HTML文件

为了简化HTML文件的创建，方便为webpack包提供服务，所以可以利用html-webpack-plugin插件。通过利用该插件可以自动引入JS、CSS等文件，可以对HTM代码进行压缩；此外，该插件还可以利用提供的HTML模板。

module.exports = {
    plugins: [
        // html-webpack-plugin插件，默认会创建一个空的HTML，自动引入打包输出的所有资源（JS、CSS）
        new HtmlWebpackPlugin({
            // 需要有结构的HTML文件，可以通过配置template，复制该html文件，并自动引入自动引入打包输出的所有资源（JS、CSS）
            template: './src/index.html',
            // 压缩html代码
            minify: {
                // 移除空格
                collapseWhitespace: true,
                // 移除注释
                removeComments: true,
            }
        })
    ],
}

4.2 CSS文件

对于CSS文件，利用插件主要需要处理三个方面：提取CSS文件、兼容性处理（配合postcss-loader）和对CSS文件进行压缩。

• 提取CSS文件：mini-css-extract-plugin
• 兼容性处理：post-preset-env
• 压缩：optimize-css-assets-webpack-plugin

module.exports = {
    ……
    module: {
        rules: [
            {
                test: /\.css$/,
                use: [
                    // 'style-loader',
                    MiniCssExtractPlugin.loader,// 用这个loader取代style-loader。作用：提取js中的css成单独文件
                    'css-loader',
                    {
                        loader: 'postcss-loader',
                        options: {
                            ident: 'postcss',
                            plugins: () => [
                                require('postcss-preset-env')()
                            ]
                        }
                    }
                ]
            },
        ]
    },
    plugins: [
        new MiniCssExtractPlugin({
            // 对输出的css文件进行重命名
            filename: 'css/[name].css'
        }),
        // 压缩css
        new OptimizeCssAssetsWebpackPlugin(),
    ]
}

五、Mode

指示wenpack使用相应模式进行配置。

选项	描述
development	会将 DefinePlugin 中 process.env.NODE_ENV 的值设置为 development。启用 NamedChunksPlugin 和 NamedModulesPlugin。
production	会将 DefinePlugin 中 process.env.NODE_ENV 的值设置为 production。启用 FlagDependencyUsagePlugin, FlagIncludedChunksPlugin, ModuleConcatenationPlugin, NoEmitOnErrorsPlugin, OccurrenceOrderPlugin, SideEffectsFlagPlugin 和 TerserPlugin。
none	退出任何默认优化选项