【vite】你不知道的小妙招，確定不看一下嗎？

作者：梁曉瑩 2021-06-24 07:54:20

publicDir 限定直接訪問的靜態資源本文通過列舉處理點，逐一提供案例+debug 截圖+源碼分析的方式，讓大家理解靜態處理的使用和底層原理。

分析 version：2.3.7。本文將整理 vite 靜態資源的幾種處理方式，應用案例和源碼分析相結合，帶你 10mins 通關該模塊知識~

一.處理的五種方式

(1) 使用根絕對路徑引入 public 中的資源

<img alt="Vue logo" src="/wy-logo.png" />

敲重點!

publicDir 放靜態資源的目錄，默認為 public
引入 public 中的資源永遠應該使用根絕對路徑 —— 舉個🌰，public/wy-logo.png 應該在源碼中被引用為 /wy-logo.png。在開發時能直接通過${yourHost}/wy-logo.png根路徑訪問到。
public 中的資源不應該被 JavaScript 文件引用。

接下來我們來康康代碼處理：當我們直接/wy-logo.png 訪問資源：

以下是 public 靜態資源中間件處理入口 - vite/src/node/server/index.ts:

if (config.publicDir) { 
    middlewares.use(servePublicMiddleware(config.publicDir)) 
 }

這時候大家就有疑問了，怎樣才會走到 isImportRequest,以及為什么這么干?別急，下面我們慢慢嘮~

(2)通用 import 靜態資源, 返回[解析后]的公共路徑

首先，啥子是通用靜態資源嘞~~

是 vite 支持的默認資源類型：

KNOWN_ASSET_TYPES = ["png", "jpe?g", "gif", "svg", "ico", "webp", "avif", "mp4", "webm", "ogg", "mp3", "wav", "flac", "aac", "woff2?", "eot", "ttf", "otf", "wasm"]

是你自定義的放到 assetsInclude 配置中的文件

其次，我們來康康，靜態資源的導入

<template> 
    <img alt="Vue logo" :src="starImg" /> // 解析后的公共路徑作為 src 來請求資源 
</template> 
<script> 
  import starImg from '../assets/star.png' // 導入靜態資源 - 圖片 
  export default defineComponent({ 
    data () { 
      return { 
        starImg 
      } 
    } 
  }) 
</script>

這是我們的輸入和輸出：我們可以看到每個 import 都會被處理成 xxx?import 請求，返回解析后的代碼，得到一個公共可訪問 url

然后，我們依舊根據 wy-logo 圖片來對比分析~ 之前是直接靜態文件訪問，提前返回資源，不會被解析成 import 依賴反之如果作為 js 文件 import 引入，則不會當成正常靜態資源，都得優先處理成通用&import js 文件，：

import logo from '../../public/wy-logo.png' 
console.log(logo)

關鍵代碼：

// 從初始執行 cli 處啟動 createServer - vite/src/node/server/index.ts 
// 會調用 resolveConfig()獲取 config, 而該方法里會調用 resolvePlugins(), 
// 其中有個 plugin 處理是: importAnalysisPlugin(config) 
// 所在文件如下： 
import { importAnalysisPlugin } from './importAnalysis' 
 
// 在 importAnalysic.js 里有個關鍵方法： 
async transform(source, importer, ssr) { 
  // 用`?import`標識非 js/css 的 import 依賴 
  url = markExplicitImport(url) 
}

可以看到 public 下的靜態資源直接請求會直接返回，反之 import 靜態資源的話 - 處理成/public/wy-logo.png?importwy-logo.png?import。需要后續通過返回解析后的 url 再去訪問資源。👇🏻es-module-lexer 解析處理：

這時候大家就理解了之前的疑問，isImportRequest 需要區分是否是直接的靜態資源請求，如果是 import xxx 來引入的，都統一處理成依賴，給到你最終需要的一個 URL => 【公共靜態資源訪問路徑】。這就是為什么 public 中的資源不建議被 JavaScript 文件引用，因為 publicDir 資源文件的定義就是直接可以請求，沒有必要解析獲取 url 后再請求!!!

(3)非通用靜態資源?可顯式 URL

引入 ?url通用靜態資源可以直接處理獲取 url，那要是想要處理其他資源，怎么顯式導入為一個 URL 來用 (⊙_⊙)? 答案是用?url后綴 ../data/name.js：

export const nameList = ['Tim', 'John', 'Bob', 'Catherine'] 
console.log(`名稱列表 = `, nameList.join('  '))

components/name.vue

import nameListUrl from '../data/name.js?url' 
console.log(nameListUrl) // 解析成'/src/data/name.js'

源碼解析: 同理，也是在resolvePlugins()里面有對 asset 處理的assetPlugin

const urlRE = /(\?|&)url(?:&|$)/ 
async load(id) { 
 ... 
  // 如果沒有被配置到靜態資源 assetsInclude 并且 沒有?url 后綴的，直接返回 
  if (!config.assetsInclude(cleanUrl(id)) && !urlRE.test(id)) { 
    return 
  } 
 
  id = id.replace(urlRE, '$1').replace(/[\?&]$/, '') 
  const url = await fileToUrl(id, config, this) // 獲取公共可訪問路徑 
  return `export default ${JSON.stringify(url)}` // 返回解析后的代碼 
}

(4)將資源引入為字符串 ?raw

同一個例子，我們要獲取 name.js 的數據：1.場景 1 是獲取執行 name.js 后輸出的數據 2.場景 2 是僅僅要獲取 name.js 的文本，比如我們可以做 template 的字符串，那就需要使用到?raw后綴了。

import nameString from '../data/name.js?raw' 
console.log(nameString) // 解析出 export default "xxxxx" 文本

上源碼。。。。。依舊是assetPlugin

const rawRE = /(\?|&)raw(?:&|$)/ 
async load(id) { 
 ... 
  // raw requests, read from disk 
  if (rawRE.test(id)) { 
    // publicDir 存在同名靜態文件，優先返回 
    const file = checkPublicFile(id, config) || cleanUrl(id) 
    // ?raw 作為 query, 讀取對應的文件并且返回其字符串 
    return `export default ${JSON.stringify( 
      await fsp.readFile(file, 'utf-8') 
    )}` 
  } 
  ... 
}

(5)導入腳本作為 Worker ?worker

腳本可以通過 ?worker 或 ?sharedworker 后綴導入為 web worker。上案例：/data/name-worker.js

export const nameList = ['Tim', 'John', 'Bob', 'Catherine'] 
addEventListener('message', (e) => { 
  console.log('主線程: ', e.data) 
  postMessage({ 
    word: `Hi，我是 worker~~ 老大，這是你要的名單：${nameList.join(' ')}`, 
    nameList 
  }) 
  close() // 關閉 worker 
}, false)

/components/name.vue

import NameWorker from '../data/name-worker.js?worker' 
export default defineComponent({ 
  mounted () { 
    const worker = new NameWorker() 
    worker.postMessage('Hi, 我是主線程~') // 主線程向 Worker 發消息 
    worker.onmessage = (e) => { // 接收子線程發回來的消息 
      if (e.data) { 
        console.log('Worder: ' + e.data.word) 
        this.workerNameList = e.data.nameList 
        worker.terminate() // Worker 完成任務以后，主線程就可以把它關掉 
      } 
    } 
    worker.onerror = (e) => { 
      console.log([ 
        'ERROR: Line ', e.lineno, ' in ', e.filename, ': ', e.message 
      ].join('')) 
    } 
  } 
})

這里，就是給 name-worker.js 封裝了一層，提供了 WorkerWrapper 函數幫你新建了一個 worker 對象

debug 圖如下：

源碼。。。?！景““?!!源碼可真多，我可太暴躁了】

resolvePlugins()里執行webWorkerPlugindev 開發環境下：

async transform(_, id) { 
    const query = parseWorkerRequest(id) 
    let url: string 
    url = await fileToUrl(cleanUrl(id), config, this) // 原始 url 
    url = injectQuery(url, WorkerFileId) // 加上&worker_file 的 query 標識 
 
    const workerConstructor = 
      query.sharedworker != null ? 'SharedWorker' : 'Worker' 
    const workerOptions = { type: 'module' } 
 
    return `export default function WorkerWrapper() { // 輸出新建 worker 對象的 template 
      return new ${workerConstructor}(${JSON.stringify( 
      url 
    )}, ${JSON.stringify(workerOptions, null, 2)}) 
    }` 
}

build 生產下：inline 模式和非 inline 模式

if (query.inline != null) { 
  // 打包文件作為入口去支持 import 導入 worker 或者行內寫入 
  const rollup = require('rollup') as typeof Rollup 
  const bundle = await rollup.rollup({ 
    input: cleanUrl(id), 
    plugins: config.plugins as Plugin[] 
  }) 
  try { 
    // 在生產構建中將會分離出 chunk,worker 腳本將作為單獨的塊發出 
    const { output } = await bundle.generate({ 
      format: 'es', 
      sourcemap: config.build.sourcemap 
    }) 
  
    return `const blob = new Blob([atob(\"${Buffer.from(output[0].code).toString('base64')}\")], { type: 'text/javascript;charset=utf-8' }); 
    export default function WorkerWrapper() { 
      const objURL = (window.URL || window.webkitURL).createObjectURL(blob); 
      try { 
        return new Worker(objURL); 
      } finally { 
        (window.URL || window.webkitURL).revokeObjectURL(objURL); 
      } 
    }` 
  } finally { 
    await bundle.close() 
  } 
} else { 
  // 作為分開的 chunk 處理`?worker&inline`,內聯為 base64 字符串 - 要求 inline 的 worker 
  url = `__VITE_ASSET__${this.emitFile({ 
    type: 'chunk', 
    id: cleanUrl(id) 
  })}__` 
  ....// 同開發返回的 template 
}

咦~，那這個/src/data/name-worker.js?worker_file 又通過?worker_file后綴給我們處理啥了?webWorkerPlugin：

const WorkerFileId = 'worker_file' 
async transform(_, id) { 
    const query = parseWorkerRequest(id) 
    if (query && query[WorkerFileId] != null) { 
      return { 
        // 其實只是作為 執行導入之前生成的 worker.js 文件 的標識....... 
        code: `import '${ENV_PUBLIC_PATH}'\n` + _ 
      } 
    } 
}

害!五個靜態處理方式總算是講完了~

二. 總結

vite 的靜態處理關鍵點就是：

(1)通過特殊 query(?:worker|sharedworker|raw|url)來區分不同類型靜態資源，進行特殊的 transform 處理。

(2)publicDir 限定直接訪問的靜態資源本文通過列舉處理點，逐一提供案例+debug 截圖+源碼分析的方式，讓大家理解靜態處理的使用和底層原理。

責任編輯：姜華來源：微醫大前端技術

【vite】你不知道的小妙招，確定不看一下嗎？