跳至内容

静态资源处理

将资源作为 URL 导入

导入静态资源将返回解析后的公共 URL

js
import 
imgUrl
from './img.png'
document
.
getElementById
('hero-img').src =
imgUrl

例如,imgUrl 在开发过程中将是 /src/img.png,在生产构建中将变成 /assets/img.2d8efhg.png

此行为类似于 webpack 的 file-loader。不同之处在于导入可以使用绝对公共路径(基于开发期间的项目根目录)或相对路径。

  • CSS 中的 url() 引用以相同的方式处理。

  • 如果使用 Vue 插件,Vue SFC 模板中的资源引用将自动转换为导入。

  • 常见的图像、媒体和字体文件类型会被自动检测为资源。你可以使用 assetsInclude 选项扩展内部列表。

  • 引用的资源作为构建资源图的一部分包含在内,将获得哈希文件名,并且可以由插件进行优化处理。

  • 字节大小小于 assetsInlineLimit 选项的资源将以内联为 base64 数据 URL。

  • Git LFS 占位符会自动排除在内联之外,因为它们不包含它们所代表的文件内容。要进行内联,请确保在构建之前通过 Git LFS 下载文件内容。

  • 默认情况下,TypeScript 不会将静态资源导入识别为有效模块。要解决此问题,请包含 vite/client

通过 url() 内联 SVG

当将 SVG 的 URL 传递给 JS 手动构造的 url() 时,变量应该用双引号括起来。

js
import 
imgUrl
from './img.svg'
document
.
getElementById
('hero-img').
style
.
background
= `url("${
imgUrl
}")`

显式 URL 导入

未包含在内部列表或 assetsInclude 中的资源可以使用 ?url 后缀显式地作为 URL 导入。例如,这对于导入 Houdini Paint Worklets 非常有用。

js
import 
workletURL
from 'extra-scalloped-border/worklet.js?url'
CSS.paintWorklet.addModule(
workletURL
)

显式内联处理

可以使用 ?inline?no-inline 后缀分别显式地导入带有内联或不内联的资源。

js
import 
imgUrl1
from './img.svg?no-inline'
import
imgUrl2
from './img.png?inline'

将资源作为字符串导入

可以使用 ?raw 后缀将资源作为字符串导入。

js
import 
shaderString
from './shader.glsl?raw'

将脚本作为 Worker 导入

可以使用 ?worker?sharedworker 后缀将脚本作为 Web Worker 导入。

js
// Separate chunk in the production build
import 
Worker
from './shader.js?worker'
const
worker
= new
Worker
()
js
// sharedworker
import 
SharedWorker
from './shader.js?sharedworker'
const
sharedWorker
= new
SharedWorker
()
js
// Inlined as base64 strings
import 
InlineWorker
from './shader.js?worker&inline'

查看 Web Worker 部分 了解更多详细信息。

public 目录

如果你有以下资源:

  • 从未在源代码中引用(例如 robots.txt
  • 必须保留完全相同的文件名(不进行哈希处理)
  • ...或者你只是不想为了获取其 URL 而首先导入资源

那么你可以将资源放置在项目根目录下的一个特殊的 public 目录中。此目录中的资源将在开发期间以根路径 / 提供,并按原样复制到 dist 目录的根目录。

该目录默认为 <root>/public,但可以通过 publicDir 选项进行配置。

请注意,你应该始终使用根绝对路径引用 public 资源 - 例如,public/icon.png 应该在源代码中引用为 /icon.png

new URL(url, import.meta.url)

import.meta.url 是一个原生 ESM 特性,它暴露了当前模块的 URL。将其与原生 URL 构造函数结合使用,我们可以从 JavaScript 模块中使用相对路径获取静态资源的完整、已解析的 URL

js
const imgUrl = new URL('./img.png', import.meta.url).href

document.getElementById('hero-img').src = imgUrl

这在现代浏览器中原生有效 - 事实上,Vite 在开发期间根本不需要处理此代码!

此模式还支持通过模板字面量动态 URL

js
function getImageUrl(name) {
  // note that this does not include files in subdirectories
  return new URL(`./dir/${name}.png`, import.meta.url).href
}

在生产构建期间,Vite 将执行必要的转换,以便 URL 在捆绑和资源哈希之后仍然指向正确的位置。但是,URL 字符串必须是静态的,以便可以对其进行分析,否则代码将保持原样,如果 build.target 不支持 import.meta.url,这可能会导致运行时错误

js
// Vite will not transform this
const imgUrl = new URL(imagePath, import.meta.url).href
它的工作原理

Vite 将转换 getImageUrl 函数为

js
import __img0png from './dir/img0.png'
import __img1png from './dir/img1.png'

function getImageUrl(name) {
  const modules = {
    './dir/img0.png': __img0png,
    './dir/img1.png': __img1png,
  }
  return new URL(modules[`./dir/${name}.png`], import.meta.url).href
}

不适用于 SSR

如果你使用 Vite 进行服务端渲染,此模式将不起作用,因为 import.meta.url 在浏览器与 Node.js 中具有不同的语义。服务器捆绑包也无法提前确定客户端主机 URL。

在 MIT 许可证下发布。(083ff36d)