Vue 的编译器 API 使用指南

冷漠man

冷漠man

2026-06-07

560人浏览

原创

vue 中以 define 开头的 api(如 defineprops、defineemits、defineexpose)是编译器宏,仅在 顶层有效,由编译器在构建阶段转换为等效 js 代码,非运行时函数,无需导入。

vue 的编译器 api 使用指南

什么是编译器 API

Vue 中以 define 开头的 API(如 definePropsdefineEmitsdefineExpose 等)统称为“编译器宏”(Compiler Macros)。它们不是运行时函数,也不需要手动导入,而是由 Vue 编译器在构建阶段识别并转换为等效的 JavaScript 代码。只在 <script setup></script> 语法中有效,是专为简化组件声明而设计的语法糖。

核心编译器宏及用法

defineProps:声明组件接收的 props,支持运行时校验与 TypeScript 类型推导。

  • JS 项目中可传入对象配置,设置 typerequireddefaultvalidator
  • TS 项目推荐配合 withDefaults 使用接口定义,兼顾类型安全与默认值
  • 注意:props 是只读响应式对象,直接赋值会触发警告;解构需用 toRefs 保持响应性

defineEmits:显式声明组件对外抛出的事件,支持参数校验和类型约束。

Vue-router参考手册
Vue-router参考手册

Vue-router参考手册下载

下载
  • 运行时写法用对象形式定义事件名与校验函数
  • TS 写法使用函数重载签名,如 defineEmits()
  • 调用 emit('xxx') 前必须在此声明,否则开发环境下会发出警告

defineExpose:控制子组件向父组件暴露的属性和方法。

  • 默认情况下,<script setup></script> 中的变量和函数不会被父组件通过 ref 访问
  • 需显式调用 defineExpose({ methodA, dataB }) 才能暴露指定内容
  • 常用于子组件提供操作入口,如表单的 validate() 或弹窗的 open()

使用限制与注意事项

这些 API 只能在 <script setup></script> 的顶层作用域中使用,不能出现在条件语句、循环或函数内部。

  • 无法动态生成,例如不能写 if (cond) defineProps(...)
  • 不支持在普通 <script></script> 或 Options API 中使用
  • 服务端渲染(SSR)场景下,它们仍会被正确解析和处理,无需额外适配
  • 构建工具(如 Vite、Vue CLI)已内置支持,无需额外插件

与其他 API 的关系

编译器宏与组合式 API 协作紧密,但职责分明:

  • refreactivewatch 等属于运行时响应式 API,在 setup 函数内执行
  • defineProps 等则在编译期介入,生成 props 解析逻辑和类型检查代码
  • 它们共同构成 <script setup></script> 的完整能力,缺一不可

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

2262

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

2132

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

2321

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

336

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

858

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

10619

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

153

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 15.6万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 2.2万人学习