vue引用public文件夹中文件的方法限制

1,959 阅读6分钟

1 官方解释

image.png

vite官网解释

2 使用

可以先看最下面结论

image.png

image.png

在Test.vue组件中测试

2.1 图片文件

image.png

方式一(ide正常,页面正常,img标签src属性赋值绝对路径/):

<template>
  <div class="view"><img src="/moon.png" /></div>
</template>
<script setup lang="ts">
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

build后:

image.png

页面显示:

image.png

方式二 (ide警告,页面正常,img标签src属性赋值绝对路径/public)

<template>
  <div class="view"><img src="/public/moon.png" /></div>
</template>
<script setup lang="ts">
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png

build后:

image.png 可以看到,这样的方式引用,会把图片文件复制一份,名称追加hash值,放在assets下面,根目录下的moon.png并没有被引用

image.png

页面显示:

image.png

方式三(ide警告,页面正常,img标签src属性赋值相对路径../../public):

<template>
  <div class="view"><img src="../../public/moon.png" /></div>
</template>
<script setup lang="ts">
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png

build后:

image.png

可以看到,这样的方式引用,会把图片文件复制一份,名称追加hash值,放在assets下面,根目录下的moon.png并没有被引用

image.png

页面显示:

image.png

方式四(ide正常,页面正常,img标签src属性绑定变量,变量赋值/):

<template>
  <div class="view">
    <img :src="img" />
  </div>
</template>
<script setup lang="ts">
const img = "/moon.png";

console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

build后:

image.png

页面显示:

image.png

方式五(ide警告,开发页面正常,生产页面报错,img标签src属性绑定变量,变量赋值/public):

<template>
  <div class="view"><img :src="img" /></div>
</template>
<script setup lang="ts">
const img = "/public/moon.png";
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png

build后:

image.png

页面显示:

image.png

上图显示正常是因为在开发环境,存在public路径,但是如果部署服务器,就会找不到图片如下图,因为没有public这个路径,

image.png

方式六(ide警告,页面正常,img标签src属性绑定变量,变量赋值../../public):

<template>
  <div class="view"><img :src="img" /></div>
</template>
<script setup lang="ts">
const img = "../../public/moon.png";
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png

build后:

image.png

页面显示:

image.png

上图显示正常是因为在开发环境,存在public路径,但是如果部署服务器,就会找不到图片如下图,因为没有public这个路径,

image.png

方式七(ide正常,页面正常,import图片,路径为/):

<template>
  <div class="view"><img :src="img" /></div>
</template>
<script setup lang="ts">
import img from "/moon.png";
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

build后:

image.png

页面显示:

image.png

方式八(ide警告,页面正常,import图片,路径为/public):

<template>
  <div class="view"><img :src="img" /></div>
</template>
<script setup lang="ts">
import img from "/public/moon.png";
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png build后:

image.png

可以看到,这样的方式引用,会把图片文件复制一份,名称追加hash值,,放在assets下面,根目录下的moon.png并没有被引用

image.png

页面显示:

image.png

方式九(ide警告,页面正常,import图片,路径为../../public):

<template>
  <div class="view"><img :src="img" /></div>
</template>
<script setup lang="ts">
import img from "../../public/moon.png";
console.log("aaa");
</script>
<style scoped>
img {
  width: 300px;
  height: 300px;
}
</style>

ide警告:

image.png

build后:

image.png

可以看到,这样的方式引用,会把图片文件复制一份,名称追加hash值,,放在assets下面,根目录下的moon.png并没有被引用

image.png

页面显示:

image.png

2.2 json文件

image.png

方式一(ide报错,页面报错,无法使用,import引入):

<template>
  {{ data }}
</template>
<script setup lang="ts">
import data from "/data.json";
console.log("aaa", data);
</script>
<style scoped></style>

ide报错:

image.png

页面报错:

image.png

方式二(页面正常,import引入,增加?url参数):

<template>
  {{ data }}
</template>
<script setup lang="ts">
import data from "/data.json?url";
console.log("aaa", data);
</script>
<style scoped></style>

build后:

image.png

页面显示:

image.png

可以看到页面仅仅显示路径,而不是文件内容

方式三(ide警告,页面正常,import引入,路径增加/public):

<template>
  {{ data }}
</template>
<script setup lang="ts">
import data from "/public/data.json";
console.log("aaa", data);
</script>
<style scoped></style>

ide警告:

image.png

"vue-tsc && vite build"命令build报错: image.png

"vite build"命令build后:

image.png

可以看到,虽然有警告,但是/public中的json文件,在vue组件中用import { test } from '/public/data.json' 方式引入后还是可以使用的,但是json文件内容已经被引入到当前js中了,实际上删除打包后根目录中的data.json也不会影响

页面正常:

image.png

方式四(ide警告,页面正常,import引入,路径增加../../public相对路径):

<template>
  {{ data }}
</template>
<script setup lang="ts">
import data from "../../public/data.json";
console.log("aaa", data);
</script>
<style scoped></style>

ide警告:

image.png

build后:

image.png

页面显示:

image.png

2.3 js文件

image.png

方式一(报错,无法使用,import引入):

<template>
  {{ test }}
</template>
<script setup lang="ts">
import {test} from "/test.js";
console.log("aaa", test);
</script>
<style scoped></style>

ide报错:

image.png

页面报错:

image.png

方式二(ide警告,页面正常,import引用,路径加/public,绝对路径):

<template>
  {{ test }}
</template>
<script setup lang="ts">
import {test} from "/public/test.js";
console.log("aaa", test);
</script>
<style scoped></style>

ide警告:

image.png

"vue-tsc && vite build"命令build报错:

image.png

"vite build"命令build后: build后:

image.png

可以看到,虽然有警告,但是/public中的js文件,在vue组件中用import { test } from '/public/test.js' 方式引入后还是可以使用的,但是js文件内容已经被引入到当前js中了,test.js也不会影响

页面显示:

image.png

方式三(ide警告,页面正常,import引用,路径加../../public,相对路径):

<template>
  {{ test }}
</template>
<script setup lang="ts">
import {test} from "../../public/test.js";
console.log("aaa", test);
</script>
<style scoped></style>

ide警告:

image.png

"vue-tsc && vite build"命令build报错:

image.png

"vite build"命令build后: build后:

image.png

可以看到,虽然有警告,但是/public中的js文件,在vue组件中用import { test } from '../../public/test.js' 方式引入后还是可以使用的,但是js文件内容已经被引入到当前js中了,test.js也不会影响

3 结论

序号文件类型引入方式ide显示开发页面build生产页面引用指向(/为部署目录)
1imgimg标签src属性赋值绝对路径/正常正常正常正常/
2img标签src属性赋值绝对路径/public警告正常正常正常复制图片到/assets/
3img标签src属性赋值相对路径../../public警告正常正常正常复制图片到/assets/
4img标签src属性绑定变量,变量为/正常正常正常正常/
5img标签src属性绑定变量,变量为/public警告正常正常报错/public/
6img标签src属性绑定变量,变量为../../public警告正常正常报错../../public/
7import img from '/moon.png'正常正常正常正常/
8import img from "/public/moon.png"警告正常正常正常复制图片到/assets/
9import img from "../../public/moon.png"警告正常正常正常复制图片到/assets/
10jsonimport data from "/data.json"报错报错无法build
11import data from "/data.json?url"正常正常正常仅显示路径/
12import data from "/public/data.json"警告正常vue-tsc && vite build报错,vite build正常正常没有引用,文件内容已经包含到当前js中
13import data from "../../public/data.json"警告正常正常正常没有引用,文件内容已经包含到当前js中
14jsimport {test} from "/test.js"报错报错无法build
15import {test} from "/public/test.js"警告正常vue-tsc && vite build报错,vite build正常正常没有引用,文件内容已经包含到当前js中
16import {test} from "../../public/test.js"警告正常vue-tsc && vite build报错,vite build正常正常没有引用,文件内容已经包含到当前js中

综上:

  • 1,4,7是正确用法,
  • 5,6,10,14是错误用法,
  • 2,3,8,9可以使用,但是图片会被复制到assets文件夹,重命名hash,违背放在/public的初衷,
  • 11无法获取文件内容,
  • 12,13,15,16可以使用,但是json和js会被复制到assets文件夹,重命名hash,违背放在/public的初衷
  • 如果有一个图片/json/js文件,含有大量数据,不会经常变动,如果按照官网解释,放在src中的assets文件夹中,build时候会被打包,并且hash命名,不符合我们本意,如果直接放在/public文件夹,只要在组件中引入,build时,就会自动复制到输出目录的/assets/文件夹中,并且hash命名(图片)或者将其内容打包到引用的js文件中(json,js),不符合我们本意,临时的办法是,在index.html中引入json/js文件,但是这样是全局的