526互联

Vite项目中静态资源 动态路径处理（Vite打包后无法显示静态资源）

发布时间 2023-12-21 08:49:29作者: 且行且思
适用场景：

img标签是通过v-for动态指定src路径的，本地可以正常显示，一旦打包之后就无法在线上显示了。

Bug原因：

Vite打包只会处理静态src路径，动态src路径只会原样保留。

<!-- 静态src会被处理为正确地址 -->
<img src="@/assets/xx.png" /> 
 
<!-- 动态src不会被处理,不论是相对路径还是绝对路径都是如此 -->
<img :src="@/assets/{imgPath}" />

 

方法：

    第一种情况：需要动态指定的资源很少，就那么几个

直接使用import 引入图片资源，然后添加即可。

    第二种情况：需要动态指定的资源非常多，不想一个一个import引入，

那么可以这样：

1、把所有静态资源放到public/目录下

2、引用的资源路径改为 绝对路径 并去掉public前缀

如：在src/views/home/index.vue 文件中引入 public/static/home/首页.png，那就直接使用

/static/home/首页.png 即可。

<img :src="'/static/home/' + item.iconPath" />
 
<script setup>
const item = {
    iconPath: '首页.png'
}
</script>

 

原理：

在Vite中， / 开头的绝对路径默认可以访问到 public/ 目录下的内容，所以 /public/static/home/首页.png 和 /static/home/首页.png 都可以访问到本地资源。

但是在打包时，Vite默认会原样保留绝对路径的引用地址，但不会保留public文件夹，即public下的static文件夹会被直接输出到dist/目录下，而没有public文件夹了。

所以虽然这两种都可以访问到本地资源，但是考虑到默认的打包处理方式，还是要去除掉/public前缀才能保证打包之后也可以正常引入静态资源。

    第三种情况：新需求需要动态指定的资源非常多，同时项目是老项目，不能随意更改静态资源路径

那么可以尝试Vite官方提供的 import.meta.glob API。

    这个方法一般用于批量引入js或者ts文件，但实际上这个方法就是 很多import语句的集合而已，import是可以引入图片的，所以import.meta.glob 也同样可以引入图片资源，只不过需要加入配置项 as:'url' 就可以了。

通常来说，我们可以用ES提供的 import 来代替 commonJS 的require()，在webpack中，动态引入静态文件可以这样：

<img :src="require(imgPath)" />

 

而在Vite中，我们虽然不能直接使用require()，但可以这样批量引入静态资源：

<template>
  <div>
    <img
      v-for="(image, index) in images"
      :key="index"
      :src="image"
      alt="dynamic image"
      width="100"
      height="100"
    />
  </div>
</template>
 
<script setup lang="ts">
import { ref } from 'vue'
 
const obj = import.meta.glob('@/assets/*.{png,jpg}', {
  as: 'url'
})
 
const images = ref<string[]>([])
 
for (const key in obj) {
  obj[key]().then((res) => {
    images.value.push(res)
  })
}
</script>

 

这样一来，Vite就会帮我们自动import对应的静态资源，所以即使在线上环境，我们也可以展示动态指定路径的静态资源了。

但是要注意：vite提供的这个批量import的方法不能保证每次返回时都是按照顺序返回的，要进行额外处理才行，额外处理的逻辑我就不写了，我的思路是：把 import.meta.glob 返回的数组，通过includes方法检索key值，然后按照自己需要的顺序重排原数组，或者新建一个新数组依序push元素。