JavaScript 中怎么在 Vite 中使用插件实现自动导入 API 与组件

浅辰同学_2434

浅辰同学_2434

2026-08-12

385人浏览

原创

vite 中实现自动导入需配置 unplugin-auto-import(自动导入 api 和工具函数)和 unplugin-vue-components(自动导入 vue 组件),二者配合 @vitejs/plugin-vue 可零配置完成,还需在 tsconfig.json 中包含生成的 .d.ts 文件以确保类型提示生效。

javascript 中怎么在 vite 中使用插件实现自动导入 api 与组件

在 Vite 中实现自动导入 API 与组件,主流方案是使用 unplugin-auto-import(用于自动导入函数、Hooks、Ref 等)和 unplugin-vue-components(用于自动导入 Vue 组件),二者配合官方推荐的 Vue 官方插件(@vitejs/plugin-vue)即可零配置完成大部分场景的自动导入。

安装并配置 unplugin-auto-import

它能自动为 ref、computed、onMounted 等 Composition API,以及你自定义的工具函数、第三方库(如 axios、lodash)生成按需导入语句,无需手动写 import。

  • 安装:npm i -D unplugin-auto-import
  • 在 vite.config.ts 中添加插件:
(示例:支持 Vue 3 + TypeScript)

import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
  plugins: [
    AutoImport({
      imports: ['vue', 'vue-router', 'pinia'],
      dts: './src/auto-imports.d.ts', // 生成类型声明,保证 TS 提示正常
      dirs: ['./src/composables', './src/utils'], // 自动扫描目录下的导出函数
      vueTemplate: true // 允许在 .vue 模板中也自动导入(如 v-model 的 ref)
    })
  ]
})

安装并配置 unplugin-vue-components

它会自动扫描 components/ 目录下符合命名规则的 Vue 组件(如 Button.vue → 可直接用 <button></button>),无需在每个页面里 import 和 components: 注册。

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
  • 安装:npm i -D unplugin-vue-components
  • 配置(同样在 vite.config.ts):

import Components from 'unplugin-vue-components/vite'

export default defineConfig({
  plugins: [
    Components({
      dts: './src/components.d.ts', // 生成组件类型声明
      // 默认扫描 src/components,也可自定义:
      // dirs: ['./src/my-components']
      // 可选:启用对 UI 库的支持(如 Element Plus、Ant Design Vue)
      // resolvers: [ElementPlusResolver()]
    })
  ]
})

确保类型提示生效(TypeScript 用户必做)

两个插件都支持生成 .d.ts 声明文件,但需要将它们加入 tsconfig.json 的 include 字段,否则 VS Code 不识别自动导入的变量或组件:

{
  "include": [
    "src/**/*.ts",
    "src/**/*.d.ts", // ? 加上这一行
    "src/**/*.tsx",
    "src/**/*.vue"
  ]
}

首次运行后,Vite 会生成 auto-imports.d.ts 和 components.d.ts,建议提交到 Git(除非你用 .gitignore 排除了 .d.ts 文件)。

常见问题与补充说明

  • 模板中无法使用自动导入的 ref? 确保 vueTemplate: true 已开启,并使用 @vitejs/plugin-vue(Vite 4+ 默认内置,无需额外安装)
  • 自定义 Hook 没被识别? 检查 dirs 路径是否正确,且文件默认导出(export default function useXxx())或具名导出(export function useXxx())均可被识别
  • 组件命名冲突(如多个 Button.vue)? 插件默认按文件名注册,建议保持组件名唯一;可通过 deep: true 或 extensions: ['vue'] 控制扫描行为
  • 不希望某些组件被自动导入? 在组件文件顶部加注释 // @unplugin-vue-components-disable

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java vite

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5046

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1249

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4984

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1896

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3565

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4613

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3040

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

968

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习