[Vue CLI 3] 多頁應用實踐和源碼設計

咱們看一下官網給的 multi-page 的配置：須要在 vue.config.js 配置 pages，示例以下：

pages: {
    index: {
      // page 的入口
      entry: 'src/index/main.js',
      // 模板來源
      template: 'public/index.html',
      // 在 dist/index.html 的輸出
      filename: 'index.html',
      // 當使用 title 選項時，
      // template 中的 title 標籤須要是 <title><%= htmlWebpackPlugin.options.title %></title>
      title: 'Index Page',
      // 在這個頁面中包含的塊，默認狀況下會包含
      // 提取出來的通用 chunk 和 vendor chunk。
      chunks: ['chunk-vendors', 'chunk-common', 'index']
    },
    // 當使用只有入口的字符串格式時，
    // 模板會被推導爲 `public/subpage.html`
    // 而且若是找不到的話，就回退到 `public/index.html`。
    // 輸出文件名會被推導爲 `subpage.html`。
    subpage: 'src/subpage/main.js'
  }

每個頁面中就是一個對象，包含了以下配置：

• entry 入口文件的路徑
• template 模板文件的路徑
• filename 編譯以後的 html 文件名
• title html 中的 title
• chunks 打包的 chunk 文件，數組格式，包含入口文件

首先，咱們須要設計一下 src 目錄下面放置 multi-page 的文件：

看了不少多頁項目，有 2 個方案：

• 一種叫 pages 文件夾
• 一種叫 views 或者其餘名字的文件夾

你們自行選擇或者定義就行了，這裏咱們選 pages

咱們再看一下里面的文件：

• 入口文件：文件名能夠叫 main.js 或者 index.js
• 模板文件：能夠用統一的 'public/index.html'，或者目錄內放置一個本身的，取名 index.html
• title：能夠從一個文件裏面取

src
  pages
    page1
      index.html
      main.js
      App.vue
    page2
      index.html
      main.js
      App.vue

下面就是經過函數來生成 pages 的配置：

第一步：找到入口文件

能夠用 glob

const glob = require('glob')

pages 目錄的位置，能夠用相對路徑，也能夠用絕對路徑：

const path = require('path')
const PAGES_PATH = path.resolve(__dirname, './src/pages')

定義一個 pages 對象：

const pages = {}

glob.sync(PAGES_PATH + '/*/main.js').forEach(filepath => {
  // ...
})

這裏就是去設置對應幾個 key 了，不少項目基本可能是經過

/ 分隔符來對字符串進行數組話，而後簡單地獲取

可是熟悉 node.js path 模塊的會以下處理：

const pageName = path.basename(path.dirname(filepath))

往 pages 裏面循環設置：

pages[pageName] = {
    entry: filepath,
    filename: `${pageName}.html`,
    chunks: ['chunk-vendors', 'chunk-common', pageName]
  }

關於 template 稍微複雜一點，咱們須要作判斷，若是存在就用自定義的，若是不存在就用通用的

const templatePath = path.dirname(filepath) + '/index.html'

而後經過 fs.existsSync 會判斷自定義文件是否存在:

if (!fs.existsSync(templatePath)) {
    // 入口若是不配置直接使用
    templatePath = 'public/index.html'
  }

固然後面咱們分享了源碼以後，你就會發現你作了無用功

---

下面咱們看一下源碼實現部分:

每一個版本的 cli-service 多有微小的改動

cli-service/lib/config/app.js 文件

定義了一個變量 multiPageConfig 獲取 vue.config.js 取出來的 pages：

const multiPageConfig = options.pages

清空一次 entry

webpackConfig.entryPoints.clear()

經過 Object.keys 獲取 keys，而後 forEach 循環

const pages = Object.keys(multiPageConfig)
pages.forEach(name => {
})

循環內部：

先定義要用的變量，從 multiPageConfig[name] 的每個對象取：

const {
          title,
          entry,
          template = `public/${name}.html`,
          filename = `${name}.html`,
          chunks
        } = normalizePageConfig(multiPageConfig[name])

normalizePageConfig 函數以下：

處理 subpage: 'src/subpage/main.js' 的狀況

const normalizePageConfig = c => typeof c === 'string' ? { entry: c } : c

設置 entry

webpackConfig.entry(name).add(api.resolve(entry))

hasDedicatedTemplate 是判斷

用戶傳遞的多頁配置自定義模板路徑是否存在：

const fs = require('fs')
const hasDedicatedTemplate = fs.existsSync(api.resolve(template))

templatePath 的處理細節：

htmlPath 路徑是：

/Users/ */public/index.html

const htmlPath = api.resolve('public/index.html')

defaultHtmlPath 路徑是：

/Users/ */node_modules/@vue/cli-service/lib/config/index-default.html

const defaultHtmlPath = path.resolve(__dirname, 'index-default.html')

若是：

一、用戶自定義的模板存在就直接給 templatePath
二、若是不存在，先取 public/index.html，再不行就取 node_modules 裏面的

const templatePath = hasDedicatedTemplate
          ? template
          : fs.existsSync(htmlPath)
            ? htmlPath
            : defaultHtmlPath

最終經過 html-webpack-plugin 插件來生成指定名字的 html 文件到指定目錄：

一、指定目錄：

由 vue.config.js 中的 outputDir 來決定

const outputDir = api.resolve(options.outputDir)

二、生成 webpack config 關於 html-webpack-plugin 的部分：

const HTMLPlugin = require('html-webpack-plugin')
webpackConfig
          .plugin(`html-${name}`)
            .use(HTMLPlugin, [pageHtmlOptions])

pageHtmlOptions 的處理細節：

傳遞給 html-webpack-plugin 插件的參數，這裏默認會設置 chunks 的，因此上面實戰中配置也是無用功

const pageHtmlOptions = Object.assign({}, htmlOptions, {
          chunks: chunks || ['chunk-vendors', 'chunk-common', name],
          template: templatePath,
          filename: ensureRelative(outputDir, filename),
          title
        })