# webpack-learning

**Repository Path**: william_ning/webpack-learning

## Basic Information

- **Project Name**: webpack-learning
- **Description**: webpack learning
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-12
- **Last Updated**: 2021-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

    学习记录
    视频资源: https://www.bilibili.com/video/BV15D4y1d7fF
    推荐进阶视频: https://www.bilibili.com/video/BV1e7411j7T5?p=1

    0.初始化项目
        0.1 git init // 创建.git文件, 添加版本控制.
        0.2 创建.gitignore文件, 添加排除非加入版本控制的文件目录.
        0.3 npm init -y // 创建package.json文件, 前端项目模块描述文件.
        0.4 创建README.md文件, 记录过程[笔记](https://github.com/ningxiaofa/webpack-learning)

    1.模块化相关规范
        1.1 模块化概述
        传统开发模式的主要问题:
            ① 命名冲突
            ② 文件依赖

        通过模块化解决上述问题
        -- 模块化就是把单独的一个功能封装到一个模块(文件)中, 但是可以通过特定的接口公开内部成员, 也可以依赖别的模块.
        -- 模块化开发的好处: 方便代码的重用, 从而提升开发效率, 并且方便后期的维护.

        1.2 浏览器端模块化规范
            1. AMD
            require.js(http://www.requirejs.cn/)

            2.CMD
            Sea.js(https://seajs.github.io/seajs/docs)

            Note:
            这两种模块化规范已经落伍, 有了更好的替代方案, 不推荐使用!

        1.3 服务器端模块化规范
            1. CommonJS
            ① 模块分为单文件模块与包
            ② 模块成员到处: module.exports 和 exports.
            ③ 模块成员导入: require('模块标识符')

        1.4 大一统的模块化规范 -- ES6模块化
            在ES6模块化规范诞生之前, JavaScript社区已经尝试并提出了AMD, CMD, CommonJS等模块化规范.
            但是, 这些社区提出的模块化标准, 还是存在一定的差异性与局限性, 并不是浏览器与服务器通用的模块化标准,
            例如:
                -- AMD 和 CMD 社用于浏览器端的JavaScript模块化
                -- CommonJS 适用于服务器端的JavaScript模块化
            因此, ES6 语法规范中, 在语言层面上定义了ES6模块化规范, 是浏览器端与服务器端通用的模块化开发规范.

            ES6模块化规范中定义:
            -- 每个js文件都是一个独立的模块
            -- 导入模块成员使用 import 关键字
            -- 暴露模块成员使用 export 关键字

        1.5 Node.js中通过 babel 体验ES6模块化
        -- NodeJS中默认支持CommonJS服务器端的模块化规范, 但是, NodeJS对ES6模块化规范支持不是很好, 需要结合babel这个第三方插件在NodeJS中体验高级的ES6特性.
        -- babel是一个语法转换工具, 可以将高级的, 有兼容性的JavaScript代码转换为低级的, 没有兼容性的JavaScript代码

            1.5.1 配置:
            ① npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/node
            ② npm install --save @babel/polyfill
            ③ 项目根目录创建文件 babel.config.js
            ④ babel.config.js文件内容如下代码:
                const presets = [
                    ["@babel/env", {
                        targets: {
                            edge: "17",
                            firefox: "60",
                            chrome: "67",
                            safari: "11.1"
                        }
                    }]
                ];
                module.exports = { presets };
            ⑤ 通过 npx babel-node ./src/index.js 执行代码
            
            Note:
            -- npm install --save-dev / --save some-package-name // 可以简写: npm i -D / -S some-package-name 
            -- npx默认在高版本的npm中就默认提供了, 可以直接通过npx运行某些cli命令.
            -- npx babel-node ./src/index.js 意味着有些代码可以直接通过, node ./src/index.js 直接运行, 但是有些, 直接使用node运行会报错.

        1.6 ES6模块化的基本语法
            1. 默认导出 与 默认导入
            -- 默认导出语法 export default 默认导出的成员
            例如:
                // 当前的文件模块为 m1.js

                // 定义私有成员 a 和 c
                let a = 10
                let c = 20
                //外界访问不到变量d, 因为它没有被暴露出去
                let d = 30
                function show() {}

                // 将本模块中的私有成员暴露出去, 供其他模块使用
                export default {
                    a,
                    c,
                    show
                }

                // Note:
                // 每个模块中, 只允许使用唯一的一次export default, 否则会报错.
                // 如果没有导出[export], 则默认导出空对象 {}

                -- 默认导入语法 import 接收名称 from '模块标识符'
                例如:
                    // 导入模块成员
                    import m1 from './m1/js'

                    console.log(m1)
                    // 打印输出的结果为:
                    // { a: 10, c: 20, show: [Function: show] }
        
                2. 按需导出 与 按需导入
                -- 按需导出语法 export let s1 = 10
                -- 按需导入语法 import { s1 } from '模块标识符'

                // 当前文件模块为 m1.js
                    // 向外按需导出变量 s1,
                    export let s1 = 'aaa'
                    // 向外按需导出变量 s2
                    export let s2 = 'ccc'
                    // 向外按需导出方法 say
                    export function say = function() {}

                // 导入模块成员
                    import m1, { s1, s2 as ss2, say } from './m1'
                    console.log(s1); // aaa
                    console.log(s2); // ccc
                    console.log(say); // [Function: say]
                
                Note:
                每个模块中, 可以使用多次按需导出.

                3. 直接导入并执行模块代码
                有时候, 我们只是想单纯执行某个模块中的代码, 并不需要得到模块中向外暴露的成员, 此时, 可以直接导入并执行模块代码.

                // 当前文件模块为 m1.js
                    // 在当前模块中执行一个for循环操作
                    for (let i = 0; i < 3; i++) {
                        console.log(i)
                    }

                // 直接导入并执行模块代码
                import './m2'

    2. webpack
        2.1 当前Web开发面临的困境
        -- 文件依赖关系错综复杂
        -- 静态资源请求效率低
        -- 模块化支持不友好
        -- 浏览器对高级JavaScript特性兼容程度较低
        -- etc...

        webpack概述
        官网: https://webpack.js.org/ 
        webpack是一个流行的 前端项目构建工具(打包工具), 可以解决当前web开发中面临额困境.
        webpack提供了友好的模块化支持, 以及代码压缩混淆, 处理js兼容问题, 性能优化等强大的功能, 从而让程序员把工作的重心放到具体的功能实现上,
        提高了开发效率与项目的可维护性.

        目前绝大多数企业中的前端项目, 都是基于webpack进行打包构建的.
        功能图参见:
        src\static\webpack_functions_picture_20201211170127.png
        或 https://webpack.js.org/

        在该图中:
        中间表示webpack, 即webpack的logo,
        左侧表示经过webpack打包之前的项目状态,
        右侧表示经过webpack打包之后的项目状态.

        可以看到:
        打包之前的项目文件依赖关系错综复杂, 文件较多, 体积较大, 性能不是很好.
        经过webpack打包之后, 输出一个打包构建好的新项目, 文件之间依赖关系就不再错综复杂, 同时合并文件, 处理兼容性问题, 以及做了一些性能优化.

        总结:
        webpack在前端项目开发起到的作用: webpack提供了友好的模块化支持, 以及代码压缩混淆, 处理js兼容问题, 性能优化等强大的功能. [即概述中的内容]

        2.2 webpack的基本使用
            1. 创建列表的隔行变色项目
            ①  创建项目空白目录, 并运行 npm init -y 命令, 初始化包管理配置文件, package.json
            ②  新建 src 源代码目录
            ③  新建 src -> index.html 首页
            ④  初始化首页基本的结构
            ⑤  运行 npm i jquery -S 命令, 安装jQuery

            Note:
            这里新建一个webpack-real-learning目录, 作为学习实践webpack的项目根目录.
            即: webpack-real-learning 可作为一个单独的项目.

            2. 在项目中安装和配置 webpack
            ①  运行 npm install webpack webpack-cli -D 命令, 安装 webpack 相关的包
            ②  在项目根目录中, 创建名为 webpack.config.js 的 webpack 配置文件
            ③  在 webpack 的配置文件中, 初始化如下基本配置:
                module.exprots = {
                    mode: 'development' // mode 用来指定构建模式 value: development | production, 
                    // 两者区别:
                    // 后者用于生产环境, 打包上线, 打包压缩混淆代码. 体积更小, 加载速度更快.
                    // 前者用于开发环境. 开发调试, 打包速度更快, 因为省去压缩混淆的步骤, 体积较大.
                }
            ④  在 package.json 配置文件中的 scripts 节点下, 新增 dev 脚本如下:
                "scripts: {
                    "dev": "webpack" // scripts 节点下的脚本, 可以通过 npm run 执行
                }
            ⑤  在终端中运行 npm run dev 命令, 启动 webpack 进行项目打包.

            3. 配置打包的入口与出口
               webpack 4.x 版本中默认约定: // webpack 5也是
               -- 打包的入口文件为 src -> index.js
               -- 打包的出口文件为 dist -> main.js

               如果要修改打包的入口与出口, 可以在webpack.config.js 中新增如下配置信息:

               const path = require('path') // 导入 node.js 中专门操作路径的模块

               module.exports = {
                   entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径
                   output: {
                       path.join(__dirname, './dist'), // 输出文件的存放路径
                       filename: 'bundle.js' // 输出文件的名称
                   }
               }

            1. 配置 webpack 的自动打包功能
            ①  运行 npm i webpack-dev-server -D 命令， 安装支持项目自动打包的工具.
            ②  修改 package.json -> scripts 中的 dev 命令如下：
                "scripts": {
                    "dev": "webpack-dev-server" // webpack 4.x 
                    // "dev": "webpack serve" // webpack 5.x
                    // https://github.com/webpack/webpack-dev-server
                }
            ③  将 src -> index.html中, script 脚本的引用路径，修改为 "/bundle.js"
            ④  运行 npm run dev 命令, 重新进行打包
            ⑤  浏览器中访问 http://localhost:8080/ 地址, 查看自动打包效果.

            Note:
            -- webpack-dev-server 会启动一个实时打包的 http 服务器.
            -- webpack-dev-sercer 打包生成的输出文件， 默认放了项目根目录中, 而且是虚拟的, 看不见的[存在于内存中].
            
            5. 配置 html-webpack-plugin 生成预览页面
            ①  运行 npm i html-webpack-plugin -D 命令, 安装生成预览页面的插件
            ②  修改 webpack.config.js 文件头部, 添加如下配置信息:
                // 导入生成预览页面的插件, 得到一个构造函数
                const HtmlWebpackPlugin = require('html-webpack-plugin')
                const htmlPlugin = new HtmlWebpackPlugin({ // 创建插件的实例对象
                    template: './src/index.html', // 指定要用到的模板文件
                    filename: 'index.html' // 指定生成文件名称, 该文件存在于内存中, 在目录中不显示
                });
            ③   修改 webpack.config.js 文件中向外暴露的配置对象, 新增如下配置节点:
                module.exports = {
                    plugins: [ htmlPlugin ] // plugins 数组是 webpack 打包期间会用到的一些插件列表
                }
            Note:
            http://localhost:8080/
            http://localhost:8080/src/
            上面链接在浏览器中是一样的.

            6. 配置自动打包相关的参数 -- 自动打开浏览器
            // package.json
            // --open 打包完成后自动打开的浏览器【系统默认的浏览器, 也可指
            // --host 配置IP地址
            // --port 配置端口
            "scripts": {
                // "dev": "webpack-dev-server --open --host localhost --port 8080", // webpack 4.x
                // "dev": "webpack serve --open http://localhost:8080" // webpack 5.x
            }

        2.3 webpack 中的加载器
            1. 通过loader打包非js模块
            
            在实际开发过程中, webpack默认只能打包处理以 .js 后缀名结尾的模块, 其他非 .js 后缀名结尾的模块, webpack 默认处理不了, 需要调用 loader 加载器才可以正常打包, 否则会报错.

            loader 加载器可以协助 webpack 打包处理特定的文件模块, 比如:
            -- less-loader 可以打包处理 .less 相关的文件
            -- sass-loader 可以打包处理 .scss 相关的文件
            -- url-loader 可以打包处理 css 与 url 路径相关的文件

            loader的调用过程
            参见: webpack-real-learning\src\static\imgs\loader的调用过程_20201212203009.png

            Note:
            webpack 也可以处理json文件, 不需要借助 loader 处理

        2.4 webpack 中加载器的基本使用
            1. 打包处理 css 文件
            ①  运行 npm i style-loader css-loader -D 命令, 安装处理 css 文件的loader
            ②  在 webpack.config.js 的module -> rules 数组中, 添加 loader 规则如下:
                // 所有第三方文件模块的匹配规则
                module: {
                    rules: [
                        { test: /\.css$/, use: ['style-loader', 'css-loader']}
                    ]
                }
            其中, test 表示匹配的文件类型, use 表示对应要调用的 loader
            注意:
            -- use 数组中的指定的 loader 顺序是固定的.
            -- 多个 loader 的调用顺序是: 从后往前调用的.

            2. 打包处理less文件
            ①  运行 npm i less less-loader -D 命令
            ②  在 webpack.config.js 的module -> rules 数组中, 添加 loader 规则如下:
                // 所有第三方文件模块的匹配规则
                module: {
                    rules: [
                        { test:  /\.less$/, use: ['style-loader', 'css-loader', 'less-loader']}
                    ]
                }

            3. 打包处理scss文件
            ①  运行 npm i sass sass-loader -D 命令
            ②  在 webpack.config.js 的module -> rules 数组中, 添加 loader 规则如下:
                // 所有第三方文件模块的匹配规则
                module: {
                    rules: [
                        { test:  /\.scss$/, use: ['style-loader', 'css-loader', 'sass-loader']}
                    ]
                }
            
            4. 配置 postCSS 自动添加 css 的兼容前缀
            ①  运行 npm i postcss-loader autoprefixer -D 命令
            ②  在项目根目录中创建 postcss 的配置文件 postcss.config.js, 并初始化如下配置:
                const autoprefixer = require('autoprefixer') // 导入自动添加前缀的插件
                module.exports = {
                    plugins: [ autoprefixer ] // 挂载插件
                }                    

            ③  在 webpack.config.js 的module -> rules 数组中, 修改 css 的 loader 规则如下
                module: {
                    rules: [
                        { test:  /\.scss$/, use: ['style-loader', 'css-loader', 'postcss-loader']}
                    ]
                }
            Note:
            在 IE11 下测试, 依然有兼容性问题. TBD

            5. 打包样式表中的图片与字体文件
            ①  运行 npm i url-loader file-loader -D 命令
            ②  在 webpack.config.js 的module -> rules 数组中, 添加 loader 规则如下:
                module: {
                    rules: [
                        { test:  /\.jpg|jpeg|png|gif|bmp|ttf|eot|svg|woff|woff2$/, use: 'url-loader?limit=86059'}
                    ]
                }
                Note:
                其中 ? 之后的是 loader 的参数项
                limit 用来指定图片的大小, 单位是字节(byte), 只有小于/等于limit大小的图片, 才会被转为 base64 图片
            
            6. 打包处理 js 文件中的高级语法
            ①  安装Babel转换器相关的包： npm i babel-loader @babel/core @babel/runtime -D
            ②  安装babel语法相关插件的包： npm i @babel/preset-env @babel/plugin-transform-runtime @babel/plugin-proposal-class-properties -D
            ③  在项目根目录中， 创建 babel 配置文件 babel.config.js 并初始化基本配置如:
                module.exports = {
                    presets: [ '@babel/preset-env' ],
                    plugins: [ '@babel/plugin-transform-runtime',  '@babel/plugin-proposal-class-properties' ],
                }
            ④  在webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下:
                // exclude 为排除项，表示 babel-loader 不需要处理 node-modules 中的 js 文件
                { test: /\.js$/, use: 'babel-loader', exclude: /node-modules/ }