webpack基础

模块化相关规范

  1. 模块化概述
    1. 传统开发模式的主要问题
      1. 命名冲突:多个js之间变量名冲突问题
      2. 文件依赖: js引入顺序以及js文件之间无法相互引用
    2. 通过模块化解决上述问题
      1. 模块化就是把单独的一个功能封装到一个模块(文件)中,模块之间相互隔离,但是可以通过特定的接口公开内部成员,也可以依赖别的模块
      2. 模块化开发的好处:方便代码的重用,从而提升开发效率,并且方便后期的维护
  2. 浏览器端模块化规范(AMD/CMD)
    1. AMD:Require.js (http://www.requirejs.cn/)
    2. CMD: Sea.js (https://seajs.github.io/seajs/docs/)
  3. 服务器端(nodejs)模块化规范-CommonJS
    1. 模块分为单文件模块与包
    2. 模块成员导出:module.exportsexports
    3. 模块成员导入:require('模块标识符')
  4. 大一统的模块化规范 – ES6模块化
    1. 在 ES6 模块化规范诞生之前,Javascript 社区已经尝试并提出了 AMD、CMD、CommonJS 等模块化规范。
    2. 但是,这些社区提出的模块化标准,还是存在一定的差异性与局限性、并不是浏览器与服务器通用的模块化标准,例如:
      1. AMD 和 CMD 适用于浏览器端的 Javascript 模块化
      2. CommonJS 适用于服务器端的 Javascript 模块化
    3. 因此,ES6 语法规范中,在语言层面上定义了 ES6 模块化规范,是浏览器端与服务器端通用的模块化开发规范。
    4. ES6模块化规范中定义:
      1. 每个 js 文件都是一个独立的模块
      2. 导入模块成员使用 import 关键字
      3. 暴露模块成员使用 export 关键字
    5. Node.js 中通过 babel 体验 ES6 模块化
      1. node环境支持CommonJS模块化规范,但是对于ES6的模块化规范node支撑的不是很好,因此通常需要结合babel这个第三方插件,在node中体验高级的ES6模块化规范
      2. bable是一个语法转化工具,可以将高级的有兼容性的js代码转化为低级没有兼容性的js代码
      3. 如何在项目中配置bable(下面命令都是在项目根目录执行)
        1. npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/node
        2. npm install --save @babel/polyfill
        3. 项目根目录创建文件 babel.config.js
        4. babel.config.js 文件内容如下面代码
        5. 通过 npx babel-node 目标文件.js 执行代码

           const presets = [
               ["@babel/env", {
                   targets: {
                       edge: "17", 
                       firefox: "60", 
                       chrome: "67", 
                       safari: "11.1"
                   }
               }]
           ];
           module.exports = { presets };
          
  5. ES6 模块化的基本语法
    1. 默认导出 与 默认导入
      1. 默认导出语法 export default 默认导出的成员
      2. 默认导入语法 import 接收名称 from '模块标识符'
      3. 代码举例:

         // 当前文件模块为 m1.js
         // 定义私有成员 a 和 c 
         let a = 10 
         let c = 20 
         // 外界访问不到变量 d ,因为它没有被暴露出去 
         let d = 30
         function show() {}
         // 将本模块中的私有成员暴露出去,供其它模块使用
         export default {
             a,
             c,
             show
         }
                    
         //当前文件为m2.js
         // 导入模块成员
         import m1 from './m1.js'
         console.log(m1)
         // 打印输出的结果为:
         // { a: 10, c: 20, show: [Function: show] }
        
        1. 注意:每个模块中,只允许使用唯一的一次 export default,否则会报错!
    2. 按需导出 与 按需导入
      1. 按需导出语法export let s1 = 10
      2. 按需导入语法 import { s1 } from '模块标识符'
      3. 代码举例:

         // 当前文件模块为 m1.js
         // 向外按需导出变量 s1
         export let s1 = 'aaa'
         // 向外按需导出变量 s2
         export let s2 = 'ccc'
         // 向外按需导出方法 say
         export function say = function() {}
                    
         //当前文件为m2.js
         // 导入模块成员 ,as作用给s2起一个别名为ss2
         import { s1, s2 as ss2, say } from './m1.js'
         console.log(s1) 
         // 打印输出 aaa 
         console.log(ss2) 
         // 打印输出 ccc 
         console.log(say) 
         // 打印输出 [Function: say]
        
        1. 注意:每个模块中,可以使用多次按需导出
    3. 直接导入并执行模块代码
      1. 有时候,我们只想单纯执行某个模块中的代码,并不需要得到模块中向外暴露的成员,此时,可以直接导入并执行模块代码。
      2. 代码举例:

         // 当前文件模块为 m2.js
         // 在当前模块中执行一个 for 循环操作
         for(let i = 0;i<3;i++){
             console.log(i)
         }
                    
         //m1.js文件
         // 直接导入并执行模块代码 
         import './m2.js'
        

webpack

  1. 当前 Web 开发面临的困境
    1. 文件依赖关系错综复杂
    2. 静态资源请求效率低
    3. 模块化支持不友好
    4. 浏览器对高级 Javascript 特性兼容程度较低
    5. etc…
  2. webpack 概述
    1. webpack 是一个流行的前端项目构建工具(打包工具),可以解决当前 web 开发中所面临的困境。
    2. webpack 提供了友好的模块化支持,以及代码压缩混淆、处理js兼容问题、性能优化等强大的功能,从而让程序员把工作的重心放到具体的功能实现上,提高了开发效率和项目的可维护性。
    3. 目前绝大多数企业中的前端项目,都是基于 webpack 进行打包构建的。

webpack 的基本使用

  1. 创建列表隔行变色项目
    1. 新建项目空白目录,并运行 npm init –y 命令,初始化包管理配置文件 package.json
    2. 新建 src 源代码目录
    3. 新建 src -> index.html 首页
    4. 初始化首页基本的结构:src -> index.js 首页对应的js文件
    5. 运行 npm install jquery –S 命令,安装 jQuery
    6. 效果:通过模块化的形式,实现列表隔行变色效果
  2. 在项目中安装和配置 webpack
    1. 运行 npm install webpack webpack-cli -D 命令,安装 webpack 相关的包
    2. 在项目根目录中,创建名为 webpack.config.js 的 webpack 配置文件
    3. 在 webpack 的配置文件中,初始化如下基本配置:

       module.exports = {
           //mode: 'production' // 上线的时候使用 
           mode: 'development' // mode 用来指定构建模式 
       }
      
      1. mode的值有2个:production/development
      2. production:会对代码进行压缩、混淆,减小文件大小
      3. development:不会对代码进行压缩、混淆
    4. 在 package.json 配置文件中的 scripts 节点下,新增 dev 脚本如下:

       "scripts": { 
           "dev": "webpack" // script 节点下的脚本,可以通过 npm run 执行 
       }
      
    5. 在终端中运行 npm run dev 命令,启动 webpack 进行项目打包。
      1. 项目根目录下会自动生成一个dist文件夹,用于存放打包后的文件
      2. 打包后dist文件夹内部多了一个main.js文件,打包后的文件
      3. 疑问:上面执行npm run dev命令,生成一个main.js文件,那么webpack怎么知道该打包哪一个文件呢? 打包出来的main.js是打的谁呢?
    6. 代码示例:实现隔行变色的样式
      1. 在src中的index.html代码如下

         <head>
             <meta charset="UTF-8">
             <meta name="viewport" content="width=device-width, initial-scale=1.0">
             <title>Document</title>
             <!-- 没有通过webpack转化的js文件,浏览器打开报错,原因index.js内部导入jquery不识别 -->
             <!-- <script src="./index.js"></script> -->
             <!-- 通过webpack转化之后的js文件,浏览器打开正常 -->
             <script src="../dist/main.js"></script>
         </head>
         <body>
             <ul>
                 <li>这是第1个li</li>
                 <li>这是第2个li</li>
                 <li>这是第3个li</li>
                 <li>这是第4个li</li>
                 <li>这是第5个li</li>
                 <li>这是第6个li</li>
                 <li>这是第7个li</li>
                 <li>这是第8个li</li>
                 <li>这是第9个li</li>
             </ul>
         </body>
        
      2. 在src中的index.js代码如下

         // ES6的模块语法,不支持jquery导入,直接导入html会报错
         import $ from 'jquery'
        
         // 隔行变色
         $(function(){
             $('li:odd').css('backgroundColor','pink');
             $('li:even').css('backgroundColor','lightblue');
         })
        
  3. 配置打包的入口与出口
    1. webpack 的 4.x 版本中默认约定
      1. 打包的入口文件为 src -> index.js
      2. 打包的输出文件为 dist -> main.js
    2. 如果要修改打包的入口与出口,可以在 webpack.config.js 中新增如下配置信息:

       const path = require('path') // 导入 node.js 中专门操作路径的模块
       module.exports = {
           entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径 
           output: {
               path: path.join(__dirname, './dist'), // 输出文件的存放路径
               filename: 'bundle.js' // 输出文件的名称 
           }
       }
      
    3. 执行命令npm run dev,则dist文件中会多出一个bundle.js文件
    4. 在index.html文件中导入<script src="../dist/bundle.js"></script>,然后重新刷新页面即可
    5. 疑问:
      1. 如果每次修改index.js文件中的内容,那必须要从新执行npm run dev命令,然后再刷新html页面才可以修改,这样比较麻烦
      2. 那么有没有一种方法,每次修改完js文件之后,自动打包,然后甚至不用刷新html,自动更新呢?
  4. 配置 webpack 的自动打包功能
    1. 运行 npm install webpack-dev-server -D 命令,安装支持项目自动打包的工具
    2. 修改 package.json -> scripts 中的 dev 命令如下:

       "scripts": { 
       "dev": "webpack-dev-server" // script 节点下的脚本,可以通过 npm run 执行 
       }
      
    3. 将src -> index.html中,script 脚本的引用路径,修改为 /buldle.js: <script src="/bundle.js"></script>
    4. 运行 npm run dev 命令,重新进行打包
    5. 在浏览器中访问 http://localhost:8080 地址,查看自动打包效果
    6. 修改index.js文件中的代码,保存,会发现页面自动变化,不需要刷新
    7. 注意:
      1. webpack-dev-server 会启动一个实时打包的 http 服务器
      2. webpack-dev-server 打包生成的输出文件,默认放到了项目根目录中,而且是虚拟的、看不见的,这就是为什么html引入的js文件是根路径/buldle.js
    8. 疑问
      1. 本地服务运行之后,访问http://localhost:8080 地址查看的整个项目根路径下面的文件夹,并不是网页界面,还需要打开文件夹找到html文件才能预览,那么有没有办法直接就展示我们开发的html页面呢?
      2. 只要将我们要显示的index.html也生成一个虚拟的根路径下面就好了/index.html,跟/buldle.js一样
  5. 配置 html-webpack-plugin 生成预览页面
    1. 运行 npm install html-webpack-plugin –D 命令,安装生成预览页面的插件
    2. 修改 webpack.config.js 文件头部区域,添加如下配置信息:

       // 导入生成预览页面的插件,得到一个构造函数 
       const HtmlWebpackPlugin = require('html-webpack-plugin') 
       const htmlPlugin = new HtmlWebpackPlugin({ // 创建插件的实例对象
           template: './src/index.html', // 指定要用到的模板文件
           filename: 'index.html' // 指定生成的文件的名称,该文件存在于内存根目录中,在目录中不显示,跟bundle.js一样
       })
      
    3. 修改 webpack.config.js 文件中向外暴露的配置对象,新增如下配置节点:
      1. 将上面创建的htmlPlugin实例对象存放到module.exports中
       module.exports = { 
           plugins: [ htmlPlugin ] // plugins 数组是 webpack 打包期间会用到的一些插件列表 
       }
      
    4. 从新执行npm run dev,再次访问http://localhost:8080 ,显示的就是index.html文件的内容了。
    5. 疑问:
      1. 上面本地服务运行之后,还需要手动复制http://localhost:8080在浏览器中打开,那么如果我们想自动打开呢?
  6. 配置自动打包相关的参数
    1. 配置完成以后,服务启动后自动打开页面
     // package.json中的配置 
     // --open 打包完成后自动打开浏览器页面 
     // --host 配置 IP 地址 
     // --port 配置端口 
     "scripts": { 
     "dev": "webpack-dev-server --open --host 127.0.0.1 --port 8080" 
     },
    

webpack 中的加载器

  1. 通过 loader 打包非 js 模块
    1. 在实际开发过程中,webpack 默认只能打包处理以.js后缀名结尾的模块,其他非 .js 后缀名结尾的模块,webpack 默认处理不了,需要调用 loader 加载器才可以正常打包,否则会报错!
    2. loader 加载器可以协助 webpack 打包处理特定的文件模块,比如:
      1. less-loader 可以打包处理 .less 相关的文件
      2. sass-loader 可以打包处理 .scss 相关的文件
      3. url-loader 可以打包处理 css 中与 url 路径相关的文件
    3. 注意:
      1. webpack默认只能打包js文件,其他文件不支持
      2. 如果支持打包其他文件必须使用第三方加载器loader协助打包
      3. 其他格式文件必须导入js文件中,才能通过加载器loader协助打包
      4. 因此,html文件中也不需要导入css文件了
      5. 导入js文件的css样式,项目运行后会自动导入html文件的head标签中去
  2. loader 的调用过程

    pic

  3. webpack 中加载器的基本使用
    1. 打包处理 css 文件
      1. 运行 npm i style-loader css-loader -D 命令,安装处理 css 文件的 loader
      2. 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:

         // 所有第三方文件模块的匹配规则 
         module: {
             rules: [ 
                 {test: /\.css$/, use: ['style-loader','css-loader']}
             ]
         }
        
        1. 其中,test 表示匹配的文件类型, use 表示对应要调用的 loader
        2. 注意:
          1. use 数组中指定的 loader 顺序是固定的
          2. 多个 loader 的调用顺序是:从后往前调用
          3. \.代表点.,转义字符
          4. css$代表以css结尾,$就是表示以什么结尾
    2. 打包处理 less 文件
      1. 运行 npm i less-loader less -D 命令
      2. 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:

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

         // 所有第三方文件模块的匹配规则 
         module: {
             rules: [ 
                 { test: /\.scss$/, use: ['style-loader', 'css-loader', 'sass-loader'] }
             ]
         }
        
      3. scss也跟less一样的样式处理文件
    4. 配置 postCSS 自动添加 css 的兼容前缀
      1. 当某些css属性对不同的浏览器有不同的兼容性时,就需要自带各自浏览器的兼容前缀
      2. 运行 npm i postcss-loader autoprefixer -D 命令
      3. 在项目根目录中创建 postcss 的配置文件 postcss.config.js,并初始化如下配置:

         const autoprefixer = require('autoprefixer') // 导入自动添加前缀的插件 
         module.exports = { 
             plugins: [ autoprefixer ] // 挂载插件 
         }
        
      4. 在 webpack.config.js 的 module -> rules 数组中,修改 css 的 loader 规则如下:添加一个postcss-loader插件

         // 所有第三方文件模块的匹配规则 
         module: {
             rules: [ 
                 {test:/\.css$/, use: ['style-loader', 'css-loader', 'postcss-loader']}
             ]
         }
        
    5. 打包样式表中的图片和字体文件
      1. 运行 npm i url-loader file-loader -D 命令
      2. 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
         // 所有第三方文件模块的匹配规则 
         module: {
             rules: [ 
                 {test: /\.jpg|png|gif|bmp|ttf|eot|svg|woff|woff2$/, 
             use: 'url-loader?limit=16940'}                
             ]
         }
        
        1. 其中?之后的是 loader 的参数项
        2. limit 用来指定图片的大小,单位是字节(byte),只有小于 limit 大小的图片,才会被转为 base64 图片
      3. 注意:
        1. css中引用的图片当大小小于16940时会被转化成base64图片嵌入
        2. use接收的参数当时几个时用数组,当仅有一个时,可以直接用字符串,不需要用数组
    6. 打包处理 js 文件中的高级语法
      1. 安装babel转换器相关的包:npm i babel-loader @babel/core @babel/runtime -D
      2. 安装babel语法插件相关的包:npm i @babel/preset-env @babel/plugin-transform-runtime @babel/plugin-proposal-class-properties -D
      3. 在项目根目录中,创建 babel 配置文件 babel.config.js 并初始化基本配置如下:

         module.exports = {
             presets: ['@babel/preset-env'],
             plugins: ['@babel/plugin-transform-runtime','@babel/plugin-proposal-class-properties']
         }
        
      4. 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:

         // exclude 为排除项,表示 babel-loader 不需要处理 node_modules 中的 js 文件
         {test: /\.js$/, use: 'babel-loader', exclude: /node_modules/}
        

webpack 打包发布

  1. 上线之前需要通过webpack将应用进行整体打包,可以通过 package.json 文件配置打包命令:

     // 在package.json文件中配置 webpack 打包命令 
     // 该命令默认加载项目根目录中的 webpack.config.js 配置文件 
     "scripts": {
         // 用于打包的命令
         "build": "webpack -p",
         // 用于开发调试的命令
         "dev": "webpack-dev-server --open --host 127.0.0.1 --port 3000", 
     },
    
  2. 运行npm run build打包
  3. 打包完成,生成dist文件,该文件中有html、js、图片等这几种文件
  4. 把打包生成的dist文件发给后台服务器人员即可
  5. 线上查看打包后的项目文件http://127.0.0.1:8080/webpack-dev-server

webpack项目如何用手机访问

  1. 默认情况下 webpack-dev-server只能通过 localhost 访问
  2. 如果需要通过 ip 地址访问,修改 npm 配置文件中的 scripts 属性中对应的启动脚本
  3. 例如 start 或 dev 项,在配置项后面添加 --host 192.168.3.136(本地局域网IP地址),启动服务直接:npm start

     "scripts": {
       "dev": "webpack-dev-server --open --host 192.168.3.136",
       "start": "npm run dev",
     },
    
  4. 然后, 将手机连入同一个局域网, 输入host的ip即可在手机上访问该项目
  5. 如果换成--host 0.0.0.0,则本地既可以用本地ipv4地址访问, 还可以用localhost(127.0.0.1)访问;

     "scripts": {
         "dev": "webpack-dev-server --open --host 0.0.0.0",
       },
    

gulp与webpack的区别

  1. glup是nodejs的一个第三方模块,专门用来打包压缩前端代码的
  2. webpack也是nodejs的一个第三方模块,它的作用不仅仅可以用来打包压缩前端代码,还可以同时创建一个web服务器,开发者可以直接通过浏览器访问打包后的web前端代码,边开发边调试
Table of Contents