Vue / 系统课时
script setup 类型写法
script setup 类型写法
本课解决在 Vue 单文件组件中如何摆放 TypeScript 类型、响应式变量、计算属性、函数与组件依赖。完成后,你将能写出结构清晰、类型可推导,并且便于后续维护的 script setup 组件。
学习目标
- 理解
script setup中类型声明与运行时代码的职责边界 - 使用 TypeScript 为状态、计算属性和事件函数建立明确约束
- 按依赖、类型、状态、派生数据和行为组织组件代码
先理解 script setup 的执行方式
<script setup lang="ts"> 是组合式 API 的编译期语法。顶层声明的变量、函数和导入内容可以直接在模板中使用,不需要再通过 return 暴露,也不需要在 components 选项中登记已导入组件。
类型声明只参与编译检查,不会出现在浏览器运行代码中;ref、computed、函数和组件导入则属于运行时内容。把这两类内容分清,能避免把接口类型误当作真实对象使用。
推荐按以下顺序组织:外部依赖、类型声明、响应式状态、计算属性、业务函数。组件较小时不必机械分区,但同类内容应尽量靠近。
编写一个完整组件
下面是一个集成示例。StatusBadge.vue 提供子组件依赖,UserPanel.vue 负责定义类型、状态、派生数据和交互函数。请将两个文件放在同一目录中。
StatusBadge.vue:
<script setup lang="ts">
defineProps<{
text: string
}>()
</script>
<template>
<span class="badge">{{ text }}</span>
</template>
<style scoped>
.badge {
padding: 2px 8px;
border-radius: 10px;
background: #e8f5e9;
}
</style>UserPanel.vue:
<script setup lang="ts">
import { computed, ref } from 'vue'
import StatusBadge from './StatusBadge.vue'
interface UserProfile {
id: number
name: string
enabled: boolean
}
const user = ref<UserProfile>({
id: 1001,
name: 'Ava',
enabled: true
})
const clickCount = ref(0)
// 派生状态由已有数据计算,不额外保存一份重复值
const statusText = computed(() => (user.value.enabled ? '已启用' : '已停用'))
function toggleStatus(): void {
user.value.enabled = !user.value.enabled
clickCount.value += 1
}
</script>
<template>
<section>
<h2>{{ user.name }}</h2>
<StatusBadge :text="statusText" />
<p>操作次数:{{ clickCount }}</p>
<button type="button" @click="toggleStatus">切换状态</button>
</section>
</template>预期结果:
Ava
已启用
操作次数:0
[切换状态]
点击一次后:
Ava
已停用
操作次数:1实际时间、开发服务器端口和构建路径会因项目配置而不同,但页面内容与交互结果应保持一致。
类型推导与关键边界
ref<UserProfile>(...) 显式约束对象结构,后续给 user.value 赋少字段、错字段或错误类型时,TypeScript 会立即报错。简单初始值通常可依赖推导,例如 ref(0) 会推导为数字引用。
函数没有返回值时可写 : void,这能明确函数只执行操作。计算属性通常可由返回表达式推导类型,不必重复标注;只有推导结果过宽或公共 API 需要稳定签名时,再补充泛型。
组件导入后可直接在模板中使用。文件名建议使用 PascalCase,并让导入名与组件职责一致,这样模板中的依赖关系更容易追踪。
不要给所有变量都手动标注类型。重复声明 const count: Ref<number> = ref<number>(0) 虽然可用,却增加噪声;当初始值足以推导时,保留 const count = ref(0) 更清晰。
不要把类型声明当作运行时值。例如 interface UserProfile 不能在模板中显示,也不能传入浏览器 API,因为接口在编译后会被移除。组件逻辑继续增长时,应把可复用业务逻辑提取为组合式函数。
本课总结
script setup的顶层导入、变量和函数可直接供模板使用- 类型声明负责约束,响应式 API 和函数负责运行时行为
- 按依赖、类型、状态、派生数据和行为组织代码,能降低维护成本
下一课预告
下一课将继续处理组件输入,学习如何声明必填、可选和联合类型 Props,并为可选属性设置安全默认值。