驗證 Vue Props 類型，這幾種方式你可能還沒試用過！
vue 要求任何傳遞給組件的數據，都要聲明為 props。此外，它還提供了一個強大的內置機制來驗證這些數據。這就像組件和消費者之間的契約一樣，確保組件按預期使用。
這節課我們來看下這個驗證機制，它可以幫助我們在開發和調試過程中減少 but，增加我們的自信心(摸魚時間)。
基礎
原始類型
驗證基本類型比較簡單，這里我們不過多的介紹，直接看下面例子：
export default {
props: {
// Basic type check
// ("null "和 "undefined "值允許任何類型)
propA: Number,
// 多種可能的類型
propB: [String, Number],
// 必傳的參數
propC: {
type: String,
required: true
},
// 默認值
propD: {
type: Number,
default: 100
},
}
}
復雜類型
復雜類型也可以用同樣的方式進行驗證。
export default {
props: {
// 默認值的對象
propE: {
type: Object,
// 對象或數組的默認值必須從
// 一個工廠函數返回。該函數接收原始
// 元素作為參數。
default(rawProps) {
return { message: 'hello' }
}
},
// 數組默認值
propF: {
type: Array,
default() {
return []
}
},
// 函數默認值
propG: {
type: Function,
// 不像對象或數組的默認值。
// 這不是一個工廠函數
// - 這是一個作為默認值的函數
default() {
return 'Default function'
}
}
}
}
type 可以是以下之一：
- Number
- String
- Boolean
- Array
- Object
- Date
- Function
- Symbol
此外，type? 也可以是一個自定義的類或構造函數，然后使用 instanceof 進行檢查。例如，給定下面的類：
class Person {
constructor(firstName, lastName) {
this.firstName = firstName
this.lastName = lastName
}
}
我們可以把 Person? 作為一個類型傳遞給 prop 類型:
export default {
props: {
author: Person
}
}
高級驗證
validator 方法
Props 支持使用一個 validator 函數。這個函數接受 prop 原始值，并且必須返回一個布爾值來確定這個 prop 是否有效。
prop: {
validator(value) {
// The value must match one of these strings
return ['success', 'warning', 'danger'].includes(value)
}
}使用枚舉
有時我們想把值縮小到一個特定的集合，這可以通過枚舉來實現：
export const Position = Object.freeze({
TOP: "top",
RIGHT: "right",
BOTTOM: "bottom",
LEFT: "left"
});
它可以導入 validator 中使用，也可以作為默認值:
<template>
<span :class="`arrow-position--${position}`">
{{ position }}
</span>
</template>
<script>
import { Position } from "./types";
export default {
props: {
position: {
validator(value) {
return Object.values(Position).includes(value);
},
default: Position.BOTTOM,
},
},
};
</script>
最后，父級組件也可以導入并使用這個枚舉，它消除了我們應用程序中對魔法字符串的使用:
<template>
<DropDownComponent :position="Position.BOTTOM" />
</template>
<script>
import DropDownComponent from "./components/DropDownComponent.vue";
import { Position } from "./components/types";
export default {
components: {
DropDownComponent,
},
data() {
return {
Position,
};
},
};
</script>
布爾映射
布爾類有獨特的行為。屬性的存在或不存在可以決定 prop 的值。
<!-- 等價于 :disabled="true" -->
<MyComponent disabled />
<!-- 價于 :disabled="false" -->
<MyComponent />
TypeScript
將Vue的內置 prop 驗證與 TypeScript相結合，可以讓我們對這一機制有更多的控制，因為TypeScript原生支持接口和枚舉。
Interface
我們可以使用一個接口和 PropType 來注解復雜的 prop 類型。這確保了傳遞的對象將有一個特定的結構。
<script lang="ts">
import Vue, { PropType } from 'vue'
interface Book {
title: string
author: string
year: number
}
const Component = Vue.extend({
props: {
book: {
type: Object as PropType<Book>,
required: true,
validator (book: Book) {
return !!book.title;
}
}
}
})
</script>
枚舉
我們已經探討了如何在 JS 中偽造一個枚舉。這對于TypeScript來說是不需要的，它本向就支持了：
<script lang="ts">
import Vue, { PropType } from 'vue'
enum Position {
TOP = 'top',
RIGHT = 'right',
BOTTOM = 'bottom',
LEFT = 'left',
}
export default {
props: {
position: {
type: String as PropType<Position>,
default: Position.BOTTOM,
},
},
};
</script>
Vue 3
上述所有內容在使用 Vue 3與 選項API 或 組合API 時都有效。區別在于使用 <script setup>?時。props 必須使用 defineProps() 宏來聲明，如下所示：
<script setup>
const props = defineProps(['foo'])
console.log(props.foo)
</script>
<script setup>
defineProps({
title: String,
likes: Number
})
</script>
或者在使用 TypeScript 的 <script setup> 時，可以使用純類型注解來聲明 prop:
<script setup lang="ts">
defineProps<{
title?: string
likes?: number
}>()
</script>
或者使用一個接口:
<script setup lang="ts">
interface Props {
foo: string
bar?: number
}
const props = defineProps<Props>()
</script>
最后，在使用基于類型的聲明時，聲明默認值。
<script setup lang="ts">
interface Props {
foo: string
bar?: number
}
const { foo, bar = 100 } = defineProps<Props>()
</script>
總結
隨著應用程序規模的擴大，類型檢查是防止錯誤的第一道防線。結合TypeScript，它可以讓你對正確使用組件接口有很高的信心，減少bug，提高整體代碼質量和開發體驗。
