(做大佬必备)webpack打包优化

611 阅读8分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第11天,点击查看活动详情

1、打包优化-整体介绍

项目开发完成

打包

  • 用webpack做打包(把.vue, .js, .less -----------> .js, .css, .html)
  • 在项目中都会提供命令: npm run build

打包优化:

  • 在保证功能可用的前提下,让我们的文件尽可能小
  • 在保证功能可用的前提下,让我们的页面显示出来的速度更快一些

打包之后,会得到dist目录,如果希望可以双击打开index.html,则需要提前在vue.config.js中配置:vue.config.js中

{
    publicPath: './'
}

2、打包优化-路由懒加载

问题

{
    path: '/login',
    component: () => import('@/views/login/index'),
    hidden: true
  },

上边 component: () => import('@/views/login/index')是什么意思呢?

与下边的写法有何不同?

const Login = import('@/views/login/index')
{
    path: '/login',
    component: Login,
    hidden: true
  },

什么是路由懒加载

一个路由对一个组件,表示一个页面。懒加载的意思是:只有在路由进入这个页面时,才去加载这个组件对应的资源。

路由懒加载中的魔法注释

通过在注释中指定webpackChunkName,可以人为设置这个文件的名字。如下是一个示例。

components = () => import(/* webpackChunkName:"login"*/ "../component/Login.vue");

小结

  • 没设置路由懒加载前:所有页面对应的组件会全部打包到一个.js文件中
  • 设置在路由懒加载后:页面对应的组件会全部打包到一个独立.js文件中,而且只有在进入这个路由页面之后才会加载。

3、打包优化-包大小分析

目标

对开发的应用进行包大小分析

包大小分析

我们集成了功能,写了很多组件,最终都会打包成一堆文件(js目录下会有很多.js文件),每个包大小如何呢?

我们可以使用vue-cli本身提供的性能分析工具,对我们开发的所有功能进行打包分析,它的使用非常简单

npm run preview -- --report

这个命令会从我们的入口**main.js**进行依赖分析,分析出各个包的大小,方便我们进行观察和优化

执行完这个命令,我们会看到控制台中如下类似的输出

访问:http://localhost:9526/report.html

image.png

如图所示,方块越大,说明该文件占用的文件越大,文件越大,对于网络带宽和访问速度的要求就越高,这也就是我们优化的方向。

4、打包优化-去掉console-log

在vue.config.js中,配置:

chainWebpack(config) {
    config.optimization.minimizer('terser').tap((args) => {
      args[0].terserOptions.compress.drop_console = true
      return args
    })
}

5、webpack配置排除打包-整体分析

回顾

打包过程:从main.js开始出发,由webpack进行打包

image.png

疑问

我们是否需要把第三方的库全部打包到自己的项目中呢?

不需要!

xlsx这个包就很大(715K),而且这类插件长期不需要我们进行更新,所以没有必要打包进来

思路

  1. 打包时,不要把这些包打进来 image.png
  2. 从网络上引入这些包

6、webpack配置排除打包-打包瘦身

目标

通过配置vue-cli把一些平常不需要用的包排除在打包文件之外。

例如:让 webpack 不打包 vue xlsxelement

使用方式

先找到 vue.config.js, 添加 externals 项,具体如下:

configureWebpack: {
  // 配置单页应用程序的页面的标题
  // 省略其他....
  externals: {
     /**
      * externals 对象属性解析。
      *  基本格式:
      *     '包名' : '在项目中引入的名字'
      *  
    */
    'vue': 'Vue',
    'element-ui': 'ElementUI',
    'xlsx': 'XLSX'
  },
    
    
  resolve: {
    alias: {
      '@': resolve('src')
    }
  }
}

再次运行打包,我们会发现包的体积已经大幅减小:上面的三个包已经不在打包的目标文件中了。

7、webpack配置排除打包-引用网络资源

目标

做相关配置:通过公共网络资源方式把除在外的包引入在index.html

具体配置-在生产环境时生效

注意,在开发项目时,文件资源还是可以从本地node_modules中取出,而只有项目上线了,才需要去使用外部资源。此时我们可以使用环境变量来进行区分。具体如下:

在**vue.config.js**文件中:

let externals = {}
let cdn = { css: [], js: [] }
const isProduction = process.env.NODE_ENV === 'production' // 判断是否是生产环境
if (isProduction) {
  externals = {
      /**
      * externals 对象属性解析:
      * '包名' : '在项目中引入的名字'
    */
      'vue': 'Vue',
      'element-ui': 'ELEMENT',
      'xlsx': 'XLSX'
  }
  cdn = {
    css: [
      'https://unpkg.com/element-ui/lib/theme-chalk/index.css' // element-ui css 样式表
    ],
    js: [
      // vue must at first!
      'https://unpkg.com/vue@2.6.12/dist/vue.js', // vuejs
      'https://unpkg.com/element-ui/lib/index.js', // element-ui js
      'https://cdn.jsdelivr.net/npm/xlsx@0.16.6/dist/xlsx.full.min.js', // xlsx
    ]
  }
}

webpack配置externals配置项

configureWebpack: {
  // 配置单页应用程序的页面的标题
  name: name,
 externals: externals,
  resolve: {
    alias: {
      '@': resolve('src')
    }
  }
}

注入CDN配置到html模板

之后通过 html-webpack-plugin注入到 index.html之中:

在vue.config.js中,设置

chainWebpack(config) {
  config.plugin('preload').tap(() => [
    {
      rel: 'preload',
      fileBlacklist: [/.map$/, /hot-update.js$/, /runtime..*.js$/],
      include: 'initial'
    }
  ])
  // 省略其他......
  
  // 注入cdn变量 (打包时会执行)
  config.plugin('html').tap(args => {
    args[0].cdn = cdn // 配置cdn给插件
    return args
  })
  // 省略其他...
}

找到 public/index.html 通过配置CDN Config 依次注入 css 和 js。

修改head的内容如下:

<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <link rel="icon" href="<%= BASE_URL %>favicon.ico">
    <title><%= webpackConfig.name %></title>

      <!-- 引入样式 -->
+      <% for(var css of htmlWebpackPlugin.options.cdn.css) { %>
+        <link rel="stylesheet" href="<%=css%>">
+        <% } %>


    <!-- 引入JS -->
+    <% for(var js of htmlWebpackPlugin.options.cdn.js) { %>
+      <script src="<%=js%>"></script>
+    <% } %>
  </head>

打包 ,检查效果

npm run build:prod

检查生成的index.html中是否有css引入和js引入

更改publicPath

publicPath: './',

再次打开,就可以双击dist/index.html查看效果了

整体思路小结

image.png

8、了解CDN

疑问

上边引用的网络资源可靠吗?还有其他的地址可以使用吗?

CDN

CDN全称叫做“Content Delivery Network”,中文叫内容分发网络。我们用它来提高访问速度

1.免费的:公共CDN

2.购买云服务

image.png 之后 image.png 把一些静态资源:css, .js,图片,视频放在第三方的CDN服务器上,可以加速访问速度

前端项目中使用CDN好处

  1. 减少应用打包出来的包体积
  2. 加快静态资源的访问

9、在nodejs环境中布署应用

image.png

目标

将打包好的代码打包上线(本地模拟)

前端修改生产环境下的baseUrl

前端修改生产环境的 baseUrl

.env.production

VUE_APP_BASE_API = 'http://ihrm-java.itheima.net'

重新打包

使用 koa 框架部署项目

到现在为止,我们已经完成了一个前端工程师的开发流程,按照常规的做法,此时,运维/后端会将我们的代码部署到阿里云的nginx服务上,对于我们而言,我们可以将其部署到本机的nodejs环境中

  1. 建立web服务文件夹 hrServer

  2. 在该文件夹下,初始化npm

    npm init -y
    
  3. 安装服务端框架koa(也可以采用express或者egg)

    npm install koa koa-static
    
  4. hrServer中新建public目录,并拷贝上小节打包的dist目录内容,到**hrServer/public**下

  5. 在根目录下创建app.js,代码如下

    const Koa  = require('koa')
    const serve = require('koa-static');
    ​
    const app = new Koa();
    app.use(serve(__dirname + "/public")); //将public下的代码静态化
    app.listen(3333, () => {
      console.log('人资项目启动: 3333端口')
    })
    

10、history路由模式-熟悉两种路由模式

目标

了解两种单页应用的路由模式,清楚它们的区别

两种单页应用的路由模式

hash模式

hash模式 :使用 URL 的 hash 来模拟一个完整的 URL, 其显示的网络路径中会有 “#” 号

hash 虽然出现URL中,但不会被包含在HTTP请求中,对后端完全没有影响,因此改变hash后刷新, 也不会有问题

原理: hashChange

history模式

history模式: 美化后的hash模式,路径中不包含“#”。依赖于Html5 的 history api

由于改变了地址, 刷新时会按照修改后的地址请求后端, 需要后端配置处理, 将地址访问做映射, 否则会404

原理: popState, pushState()

vue项目修改路由模式

修改路由模式从hash转变为history模式

开发到现在,我们一直都在用hash模式,打包我们尝试用history模式

改成history模式非常简单,只需要将路由的mode类型改成history即可。在src/router/index.js

// 创建路由实例
const createRouter = () => new Router({
  mode: 'history', // require service support
  scrollBehavior: () => ({ y: 0 }),
  // 指定路由规则
  routes: [
    ...constantRoutes // 静态路由, 首页
  ]
})

配置好之后,我们访问路径不再需要加#号同样运行正常,这是因为 webpack 默认配好了对于 history 模式的处理

11、在nodejs环境中布署应用-解决history

问题

将history模式下打包的代码放置服务器运行,出错:浏览器一刷新就会出现页面丢失的问题

原因

首次运行

image.png

再次刷新

image.png

为什么hash模式刷新不报错

image.png

解决history页面访问问题

安装 koa中间件

npm install koa2-connect-history-api-fallback #专门处理history模式的中间件

注册中间件

const Koa  = require('koa')
const serve = require('koa-static');
const { historyApiFallback } = require('koa2-connect-history-api-fallback');
const app = new Koa();
// 这句话 的意思是除接口之外所有的请求都发送给了 index.html
app.use(historyApiFallback({ 
  whiteList: ['/api']
}));  // 这里的whiteList是 白名单的意思
​
app.use(serve(__dirname + "/public")); //将public下的代码静态化
​
app.listen(3333, () => {
  console.log('人资项目启动')
})

此时解决了刷新 404 的问题 (注意: 如果点了登录, 记得清除cookies 再测试)

12、在nodejs环境中解决生产环境跨域问题

问题

此时我们点击登录,接口是不通的,我们需要在生产环境配置一下跨域,原理和我们之前用vue-cli配置的原理是一致的,都是通过中间的服务器经过转发去代理真实的接口

修改环境变量

.env.production

VUE_APP_BASE_API = '/api'

安装跨域代理中间件

hr-serve

npm install koa2-proxy-middleware

配置跨越代理

image.png

const Koa  = require('koa')
const serve = require('koa-static');
const { historyApiFallback } = require('koa2-connect-history-api-fallback');
const proxy = require('koa2-proxy-middleware')
const app = new Koa();
​
app.use(proxy({
  targets: {
    '/api/(.*)': {
        target: 'http://ihrm-java.itheima.net', //后端服务器地址
        changeOrigin: true
    }
  }
}))
// 这句话 的意思是除接口之外所有的请求都发送给了 index.html
app.use(historyApiFallback({ 
  whiteList: ['/api']
}));  // 这里的whiteList是 白名单的意思
app.use(serve(__dirname + "/public")); //将public下的代码静态化
​
app.listen(3333, () => {
  console.log('人资项目启动')
})

image.png