TypeScript + Vue3 実践
Vue 3 は TypeScript を非常にサポートしています。本チュートリアルでは Vue 3 + TypeScript の開発実践を紹介します。
Vue 3 の Composition API と TypeScript の型システムは完璧に組み合わさり、コードをより安全で保守しやすくします。
Vue3 チュートリアル:https://www.example.com/vue3/vue3-tutorial.html
SVG 図:Vue 3 + TypeScript 開発
Vue 3 で TypeScript を使用する理由
Vue 3 は設計当初から TypeScript を全面的に採用しており、非常に優れた型サポートを提供しています。
Composition API の関数型スタイルは TypeScript の型システムと完璧に連携します:ref はジェネリック対応、computed は型推論、props は完全な型チェックが可能です。
TypeScript を使用することで、Vue コンポーネントのプロパティ、イベント、リアクティブデータに型保護を提供できます。
Vue 3 はネイティブでサポート:Vue 3 のソースコードは TypeScript で書かれており、TypeScript とシームレスに統合されています。
プロジェクトの作成
Vite を使用して TypeScript をサポートする Vue 3 プロジェクトを作成します。
初期化
npm create vite@latest my-vue-app -- --template vue-ts
# プロジェクトディレクトリに移動
cd my-vue-app
# 依存関係をインストール
npm install
推奨:Vite は Vue 公式推奨のビルドツールです。プロジェクト作成時に vue-ts テンプレートを選択するだけです。
コンポーネントの型
defineComponent と PropType を使用してコンポーネントと Props の型を定義します。
src/components/UserCard.vue
<div class="user-card">
<h3>{{ user.name }}</h3>
<p>{{ user.email }}</p>
<button @click="handleEdit">編集</button>
</div>
</template>
<script lang="ts">
import { defineComponent, PropType } from 'vue'
// ユーザー型インターフェースを定義
interface User {
id: number
name: string
email: string
}
export default defineComponent({
name: 'UserCard',
// Props 定義
props: {
// PropType を使用して型宣言を行う
user: {
type: Object as PropType<User>,
required: true
}
},
// コンポーネントが発行するイベントを宣言
emits: ['edit'],
setup(props, { emit }) {
// 編集クリックを処理
const handleEdit = () => {
emit('edit', props.user)
}
return { handleEdit }
}
})
</script>
実行結果:
UserCard 组件渲染成功
PropType:props の型が複雑なオブジェクトの場合、PropType を使用した型アサーションが必要です。
Composition API の型
ref、computed などのリアクティブ API を使用する際、TypeScript は完全な型サポートを提供します。
src/components/Counter.vue
<div>
<p>カウント: {{ count }}</p>
<p>倍増: {{ doubled }}</p>
<button @click="increment">+1</button>
<button @click="decrement">-1</button>
</div>
</template>
<script lang="ts">
import { ref, computed } from 'vue'
export default {
setup() {
// ref:リアクティブデータを定義、ジェネリックで型を指定
const count = ref<number>(0)
// computed:算出プロパティ、戻り値の型を自動推論
const doubled = computed(() => count.value * 2)
// メソッドを定義
const increment = () => {
count.value++
}
const decrement = () => {
count.value--
}
return { count, doubled, increment, decrement }
}
}
</script>
実行結果:
Counter 组件渲染成功
型推論:Vue 3 の Composition API は初期値から型を自動推論し、複雑な型はジェネリックを明示的に指定できます。
インターフェース定義
types ディレクトリにプロジェクトの型インターフェースを集中的に定義します。
src/types/index.ts
export interface User {
id: number // ユーザーID
name: string // ユーザー名
email: string // メールアドレス
avatar?: string // アバター(任意)
}
// ユーザー作成のデータ転送オブジェクト(DTO)
export interface CreateUserDTO {
name: string // ユーザー名
email: string // メールアドレス
password: string // パスワード
}
// 汎用 API レスポンス型
export interface ApiResponse<T> {
success: boolean // 成功かどうか
data?: T // 成功時のデータ
error?: string // 失敗時のエラーメッセージ
}
型の集中管理:型定義を types ディレクトリに置くことで、複数のコンポーネントで再利用しやすくなります。
注意事項
- defineComponent:完全な型推論を提供
- PropType:複雑な Props 型には使用が必要
- ref ジェネリック:複雑な型を明示的に指定
- emits:イベント型を宣言
ベストプラクティス:Vue 3 では Composition API + TypeScript の使用を推奨しており、最良の開発体験が得られます。
まとめ
Vue 3 と TypeScript は完璧に組み合わさります。
- defineComponent:完全な型推論を獲得
- PropType:props に型安全性を提供
- ref:ジェネリックパラメータでリアクティブ型を指定
- computed:算出プロパティの型を自動推論
その他の拡張提案:Vue 3 プロジェクトでは、特に大規模アプリケーションで TypeScript の使用を強く推奨します。