欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

脚手架vue-cli系列四:vue-cli工程webpack的基本用法

程序员文章站 2022-06-11 11:48:04
webpack的打包依赖于它的一个重要配置文件webpack.config.js,在这个配置文件中就可以指定所有在源代码编译过程中的工作了,就一个配置就可以与冗长的Gruntfile或者Gulpfile说再见了。 一个完整的工程项目中的webpack的配置远远没有这么简单,随着工程的构建要求的增加, ......

webpack的打包依赖于它的一个重要配置文件webpack.config.js,在这个配置文件中就可以指定所有在源代码编译过程中的工作了,就一个配置就可以与冗长的gruntfile或者gulpfile说再见了。

一个完整的工程项目中的webpack的配置远远没有这么简单,随着工程的构建要求的增加,webpack.config.js内的配置项目也会随之增加,webpack还有许许多多的选项提供给我们进行灵活配置,它只是一个构建工具,我们只需要了解在vue项目中它基本能为我们做到的工作、最小化的配置是如何的就足够了,在以后需要对它进行扩展与优化时,带着问题去查官方文档也是非常容易的事。

●  样式表引用

某些页面或者组件可能具有特定的样式定义,这些样式对于其他页面来说是冗余的,我们只希望这些组件在应用时才自动加载这些特定的样式,此时用webpack我们就能在源代码中加入以下代码来动态加载css:

    import vue from 'vue'
    // ... 省略
    // 引用指定的样式源文件
    import './app/assets/less/dark.less'
    
    export default {
      // ... 省略
    }
    

此时我们只需要在webpack的配置中加入less-loader,那么webpack在打包的时候就会自动将less转换为css,并将css的动态代码生成到js文件中。当vue组件被加载到页面并实例化后,将在dom内插入这个特定的行内样式<style>以实现动态样式的应用。

对于*.css文件同样也是适用的,例如导入某个第三方库中必需的样式表:

import 'uikit/dist/css/components/tabs.css'

●  字体的引用

假设在dark.less内加入对自定义字体文件的样式定义:

@font-face {
       font-family: 'darkenstone';
       src: url('./darkenstone.eot');
       src: url('./darkenstone.eot?#iefix') format('embedded-opentype'),
           url('./darkenstone.woff2') format('woff2'),
           url('./darkenstone.woff') format('woff'),
           url('./darkenstone.ttf') format('truetype'),
           url('./darkenstone.svg#darkenstone') format('svg');
           font-weight: normal;          
           font-style: normal;
}

.header{
       display: flex;
       flex-flow: row nowrap;

       & > h1 {
          font: 16pt 'darkenstone';
       }
}

这里.header>h1指定了一个darkenstone的自定义字体,这个字体浏览器一定是不能识别的,以前我们在样式表中先定义这个字体样式并指定加载位置(如上文@font-face的定义),然后在页面中引用这个样式表,这是多么麻烦的一件事,不是吗?

如果用了webpack后,我们只是在配置文件内加入了一个url-loader:

{
      test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
      loader: 'url'
}

我们并不需要在源代码中做任何改变,因为之前已经引用过样式表dark.less,而字体是在样式表中的,webpack将在打包的时候为我们识别并在代码中引入字体的动态加载。这样一来极大地解决了我们对资源引用的依赖问题!

vue-cli的webpack模板已经为我们配置好了绝大多数常用的loader,在实际运用中我们只需要了解它们是怎么来的,应该怎么用,需要的时候如何修改就够了。

●  用别名取代路径引用

在项目开发过程中有可能有许多包是没有放在npm上的,有一些较老的可能还依然只存在于bower上,某些甚至在bower与npm上都找不到,而不得不通过下载的方式在项目内引用,这样一来我们的代码可能通过require就得在代码内引用一段很长的文件路径,如下所示

import selector from '../../bower_components/bootstrap-select/dist/js/select'

这种包的引用方式明显违反了commonjs的编程规范,对于这些长路径,甚至还具有“../..”这些相对路径搜索的定义,我们可以通过webpack的resolve配置项来解决。就以select这个组件为例,在webpack.base.config.js中加入以下的这个别名的定义:

    module.exports = {
       entry:{ ... },
       output: { ... },
       module:{ ... },
       resolve: {
          extensions:['','.js'],
          alias:{ // 别名
             'bs-select':'bower_components/bootstrap-select/dist/js/select.js'
          }
       }
    }

有了这个定义以后,我们就可以将上面那个长引用改为下面的写法:

 import selector from 'bs-select';

绝对不要让路径引用进入到我们的代码,因为这是代码的“癌症”,一旦开始植入并生长起来,以前的代码将难以维护!

●  配置多入口程序

多数情况下我们的程序入口不单单只有一个,举一个最简单的例子,前台提供给最终用户使用(http://www.domain.com/index),后台提供给登录用户使用(http://www.domain.com/admin/),那么自然需要多个与main.js类似的程序入口了。

首先在build/webpack.base.conf.js配置文件中的entry配置属性上加上新的入口文件:

    module.exports = {
      entry: {
        app: './src/main.js',
        admin : './src/admin-main.js'
      },
      // ... 省略
    }

这是用于告诉webpack哪几个是入口文件,这些文件需要被生成到启动页的<script>内。

vue-cli的webpack模板使用htmlwebpackplugin插件,生成html入口页面并自动将生成后的js文件和css文件的引用地址写入到页内的<script>中。

这里就需要在build/webpack.dev.config.js文件内的plugins配置项内多配置一个htmlwebpackplugin插件,用于生成admin.html入口页。

     plugins:[
      // ... 省略

      // 这是原有的配置项,用于匹配注入app.js的输出脚本
      new htmlwebpackplugin({
        filename: process.env.node_env === 'testing'
          ? 'index.html'
          : config.build.index,
        template: 'index.html',
        chunks: ['app'], // 与原配置的不同的是要用chunks指定对应的entry
        inject: true,
        minify: {
          removecomments: true,
          collapsewhitespace: true,
          removeattributequotes: true
        },
        chunkssortmode: 'dependency'
      }),

      // 这是新增项,用于匹配注入admin.js的输出脚本
      new htmlwebpackplugin({
        filename: process.env.node_env === 'testing'
          ? 'admin.html'
          : config.build.admin,
        template: 'index.html',
        chunks: ['admin'],
        inject: true,
        minify: {
          removecomments: true,
          collapsewhitespace: true,
          removeattributequotes: true
        },
        chunkssortmode: 'dependency'
      }),
    ]

需要强调一点的是,这里的htmlwebpackplugin配置必须用chunks指定在上文entry内对应的入口文件的别名。

关于htmlwebpackplugin更多配置内容可以参考:https://github.com/kangax/html-minifier#options-quick-reference。

还有就是得将同样的配置加入到生产环境专用的webpack配置文件webpack.prod.conf.js中,否则当我们运行npm run build时是不会输出admin.js和admin.html这两个入口文件的(由于配置内容相同这里就不再重复了)。

最后,如果使用了vue-router就得对connect-history-api-fallback插件的配置进行修改,否则原有的默认配置只会将所有的请求转发给index.html,这样就会导致history api没有办法正确地将请求指向admin.html,导致热加载失败,具体做法如下所述。

打开dev-server.js文件,将app.use(require('connect-history-api-fallback')())配置改为以下的方式:

    // handle fallback for html5 history api
    var history = require('connect-history-api-fallback')
    // app.use(require('connect-history-api-fallback')())

    app.use(history({
      rewrites: [
        { from: /^\/admin\/.*$/, to: '/admin.html' }
      ]
    }));

新入口需要有明确区分的路由规则,否则还是会产生热加载失败的情况,这样就非常不便于开发了。