[Vue CLI 3] 多頁(yè)應(yīng)用實(shí)踐和源碼設(shè)計(jì)

我們看一下官網(wǎng)給的 multi-page 的配置:需要在 vue.config.js 配置 pages,示例如下:

pages: {
    index: {
      // page 的入口
      entry: 'src/index/main.js',
      // 模板來(lái)源
      template: 'public/index.html',
      // 在 dist/index.html 的輸出
      filename: 'index.html',
      // 當(dāng)使用 title 選項(xiàng)時(shí),
      // template 中的 title 標(biāo)簽需要是 <title><%= htmlWebpackPlugin.options.title %></title>
      title: 'Index Page',
      // 在這個(gè)頁(yè)面中包含的塊蒙兰,默認(rèn)情況下會(huì)包含
      // 提取出來(lái)的通用 chunk 和 vendor chunk姻采。
      chunks: ['chunk-vendors', 'chunk-common', 'index']
    },
    // 當(dāng)使用只有入口的字符串格式時(shí)两残,
    // 模板會(huì)被推導(dǎo)為 `public/subpage.html`
    // 并且如果找不到的話,就回退到 `public/index.html`逢捺。
    // 輸出文件名會(huì)被推導(dǎo)為 `subpage.html`。
    subpage: 'src/subpage/main.js'
  }

每一個(gè)頁(yè)面中就是一個(gè)對(duì)象癞季,包含了如下配置:

  • entry 入口文件的路徑
  • template 模板文件的路徑
  • filename 編譯之后的 html 文件名
  • title html 中的 title
  • chunks 打包的 chunk 文件蒸甜,數(shù)組格式,包含入口文件

首先余佛,我們需要設(shè)計(jì)一下 src 目錄下面放置 multi-page 的文件:

看了很多多頁(yè)項(xiàng)目柠新,有 2 個(gè)方案:

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

大家自行選擇或者定義就好了,這里我們選 pages

我們?cè)倏匆幌吕锩娴奈募?/p>

  • 入口文件:文件名可以叫 main.js 或者 index.js
  • 模板文件:可以用統(tǒng)一的 'public/index.html'辉巡,或者目錄內(nèi)放置一個(gè)自己的恨憎,取名 index.html
  • title:可以從一個(gè)文件里面取
src
  pages
    page1
      index.html
      main.js
      App.vue
    page2
      index.html
      main.js
      App.vue 

下面就是通過(guò)函數(shù)來(lái)生成 pages 的配置:

第一步:找到入口文件

可以用 glob

const glob = require('glob')

pages 目錄的位置,可以用相對(duì)路徑郊楣,也可以用絕對(duì)路徑

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

定義一個(gè) pages 對(duì)象:

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

這里就是去設(shè)置對(duì)應(yīng)幾個(gè) key 了憔恳,很多項(xiàng)目基本多是通過(guò)

/ 分隔符來(lái)對(duì)字符串進(jìn)行數(shù)組話,然后簡(jiǎn)單地獲取

但是熟悉 node.js path 模塊的會(huì)如下處理:

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

往 pages 里面循環(huán)設(shè)置:

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

關(guān)于 template 稍微復(fù)雜一點(diǎn)净蚤,我們需要做判斷钥组,如果存在就用自定義的,如果不存在就用通用的

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

然后通過(guò) fs.existsSync 會(huì)判斷自定義文件是否存在:

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

當(dāng)然后面我們分享了源碼之后今瀑,你就會(huì)發(fā)現(xiàn)你做了無(wú)用功


下面我們看一下源碼實(shí)現(xiàn)部分:

每個(gè)版本的 cli-service 多有微小的改動(dòng)

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

定義了一個(gè)變量 multiPageConfig 獲取 vue.config.js 取出來(lái)的 pages

const multiPageConfig = options.pages

清空一次 entry

webpackConfig.entryPoints.clear()

通過(guò) Object.keys 獲取 keys程梦,然后 forEach 循環(huán)

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

循環(huán)內(nèi)部:

先定義要用的變量,從 multiPageConfig[name] 的每一個(gè)對(duì)象乳佘:

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

normalizePageConfig 函數(shù)如下:

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

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

設(shè)置 entry

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

hasDedicatedTemplate 是判斷

用戶傳遞的多頁(yè)配置自定義模板路徑是否存在:

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

templatePath 的處理細(xì)節(jié):

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')

如果:

1屿附、用戶自定義的模板存在就直接給 templatePath
2、如果不存在哥童,先取 public/index.html挺份,再不行就取 node_modules 里面的

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

最終通過(guò) html-webpack-plugin 插件來(lái)生成指定名字的 html 文件到指定目錄

1、指定目錄:

vue.config.js 中的 outputDir 來(lái)決定

const outputDir = api.resolve(options.outputDir)

2贮懈、生成 webpack config 關(guān)于 html-webpack-plugin 的部分:

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

pageHtmlOptions 的處理細(xì)節(jié):

傳遞給 html-webpack-plugin 插件的參數(shù)匀泊,這里默認(rèn)會(huì)設(shè)置 chunks 的,所以上面實(shí)戰(zhàn)中配置也是無(wú)用功

const pageHtmlOptions = Object.assign({}, htmlOptions, {
          chunks: chunks || ['chunk-vendors', 'chunk-common', name],
          template: templatePath,
          filename: ensureRelative(outputDir, filename),
          title
        })
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末朵你,一起剝皮案震驚了整個(gè)濱河市各聘,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌撬呢,老刑警劉巖伦吠,帶你破解...
    沈念sama閱讀 221,888評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡毛仪,警方通過(guò)查閱死者的電腦和手機(jī)搁嗓,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,677評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)箱靴,“玉大人腺逛,你說(shuō)我怎么就攤上這事『饣常” “怎么了棍矛?”我有些...
    開(kāi)封第一講書(shū)人閱讀 168,386評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)抛杨。 經(jīng)常有香客問(wèn)我够委,道長(zhǎng),這世上最難降的妖魔是什么怖现? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,726評(píng)論 1 297
  • 正文 為了忘掉前任茁帽,我火速辦了婚禮,結(jié)果婚禮上屈嗤,老公的妹妹穿的比我還像新娘潘拨。我一直安慰自己,他們只是感情好饶号,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,729評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布铁追。 她就那樣靜靜地躺著,像睡著了一般茫船。 火紅的嫁衣襯著肌膚如雪琅束。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,337評(píng)論 1 310
  • 那天透硝,我揣著相機(jī)與錄音狰闪,去河邊找鬼。 笑死濒生,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的幔欧。 我是一名探鬼主播罪治,決...
    沈念sama閱讀 40,902評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼礁蔗!你這毒婦竟也來(lái)了觉义?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,807評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤浴井,失蹤者是張志新(化名)和其女友劉穎晒骇,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,349評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡洪囤,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,439評(píng)論 3 340
  • 正文 我和宋清朗相戀三年徒坡,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瘤缩。...
    茶點(diǎn)故事閱讀 40,567評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡喇完,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出剥啤,到底是詐尸還是另有隱情锦溪,我是刑警寧澤,帶...
    沈念sama閱讀 36,242評(píng)論 5 350
  • 正文 年R本政府宣布府怯,位于F島的核電站刻诊,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏牺丙。R本人自食惡果不足惜则涯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,933評(píng)論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望赘被。 院中可真熱鬧是整,春花似錦、人聲如沸民假。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,420評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)羊异。三九已至事秀,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間野舶,已是汗流浹背易迹。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,531評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留平道,地道東北人睹欲。 一個(gè)月前我還...
    沈念sama閱讀 48,995評(píng)論 3 377
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像一屋,于是被迫代替她去往敵國(guó)和親窘疮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,585評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容