Vue.js、コンポーネント入門、データ通信と設計の基礎

Vue.js

現代のフロントエンド開発において、コンポーネント設計は非常に重要な役割を果たします。Vue.jsをはじめとする多くのフレームワークは、コンポーネントを基本単位としてアプリケーションを構築します。

  1. コンポーネント設計の重要性
      1. コンポーネントの基本構造
      2. コンポーネントの特徴
  2. 基本的なコンポーネントの作成
    1. 階層構造とファイル命名規則
      1. プロジェクトのディレクトリ例
      2. ファイル名の命名ルール
    2. シンプルなコンポーネントの例
    3. 親コンポーネントと子コンポーネントの関係
      1. エイリアス@
      2. 子コンポーネントの登録方法
  3. データ通信の基礎
    1. 親から子へのデータ伝達
        1. 仕組み
        2. コード例
    2. 子から親へのデータ伝達
        1. 仕組み
        2. コード例
    3. 兄弟コンポーネント間のデータ共有
        1. 仕組み
        2. コード例
    4. 状態管理を利用しない場合の方法
        1. イベントバスの使用(Vue 2の場合)
        2. コード例
  4. 状態管理とコンポーネント間通信
    1. VuexやPiniaの導入
        1. Piniaの導入方法(Vue 3対応)
      1. 小規模なアプリケーションとの違い
      2. 状態管理を使うべきケース
      3. グローバルな状態管理のメリット
      4. データフローの一元化
        1. Piniaを使用したデータフロー例
    2. コンポーネント設計のベストプラクティス
      1. 再利用性の高いコンポーネントを作る方法
      2. 単一責任の原則
      3. スロットの活用
        1. 基本スロット
      4. 動作のポイント
        1. 名前付きスロット
      5. 動作のポイント
      6. コード例
      7. カスタムディレクティブの利用
      8. 命名規則とディレクトリ構造
        1. 命名規則
        2. ディレクトリ構造
      9. 規模に応じた設計例
      10. 型安全性の向上(TypeScriptの活用)
        1. 基本的な導入
  5. 「コンポーネントの登録」と「コンポーネント間の通信」の違い
      1. まとめ
  6. 学んだ内容のまとめ

コンポーネント設計の重要性

Vue.js のコンポーネントは、アプリケーションの UI を構成する最小単位であり、再利用可能な部品として設計されています。これにより、コードの重複を避け、効率的な開発が可能となります。

コンポーネントの基本構造

  1. テンプレート(HTML)
    UI の構造を定義します。Vue.js のディレクティブ(例: v-bind, v-model)を使用して、動的にデータを表示できます。
  2. スクリプト(JavaScript)
    コンポーネントのデータ、メソッド、ライフサイクルなどを定義し、UI の動作を制御します。
  3. スタイル(CSS)
    コンポーネント固有の見た目を定義します。スタイルは他のコンポーネントに影響を与えないようカプセル化されています。

コンポーネントの特徴

再利用性
同じボタンやフォームなどを複数の場所で使い回せます。これにより、コードの重複を減らし、開発効率が向上します。

カプセル化
各コンポーネントのスタイルやロジックは、その内部で完結し、他のコンポーネントに影響を与えません。これにより、コードの独立性と保守性が向上します。

親子関係
コンポーネントは階層的に構築可能で、親コンポーネントが子コンポーネントを含む形で設計できます。これにより、複雑な UI を効率的に構築できます。

基本的なコンポーネントの作成

Vue.jsでは、コンポーネントはHTML、JavaScript、CSSを1つのファイルにまとめた形式で記述することができます。以下に基本的な構造と作成方法を解説します。

階層構造とファイル命名規則

Vue.jsでは、コンポーネントのファイル名やディレクトリ構造を統一しておくことで、プロジェクトの可読性と管理しやすさが向上します。以下は基本的な階層構造とファイル命名の例です。

プロジェクトのディレクトリ例

src/
├── components/       # 再利用可能な汎用コンポーネントを格納
   ├── ChildComponent.vue
   └── SimpleComponent.vue
├── views/            # 各ページ(親コンポーネント)を格納
   └── ParentComponent.vue
├── App.vue           # アプリケーションのルートコンポーネント
└── main.js           # アプリケーションのエントリポイント
Bash

ファイル名の命名ルール

  • PascalCase(キャメルケース)
    コンポーネントのファイル名は、Vue公式ドキュメントの推奨に従い、PascalCaseで命名するのが一般的です。例:ChildComponent.vue, UserCard.vue
    理由:明確で、一目でコンポーネントだと分かるため。
  • ビュー(ページ)はPageまたはViewの接尾辞を使用
    親コンポーネントが1つのページ全体を表す場合は、HomePage.vueやAboutView.vueのように命名します。

シンプルなコンポーネントの例

まずは、簡単なコンポーネントを作成してみましょう。

<template>
  <div>
    <h1>{{ message }}</h1>
  </div>
</template>

<script>
export default {
  name: "SimpleComponent",
  data() {
    return {
      message: "こんにちは、Vue.js!",
    };
  },
};
</script>

<style scoped>
h1 {
  color: blue;
}
</style>
SimpleComponent.vue
  • <template>: HTML部分を記述するセクションです。
  • <script>: コンポーネントのロジックを記述します。dataオプションを使用して、テンプレートで表示するデータを定義します。
  • <style>: コンポーネント専用のスタイルを記述します。scoped属性をつけると、このコンポーネントだけに適用されるスタイルになります。
<script setup>
import SimpleComponent from "./components/SimpleComponent.vue";
</script>

<template>
    <SimpleComponent />
</template>
App.vue
  1. <script setup>部分
    • SimpleComponent.vueを読み込んで使えるようにしています。
  2. <template>部分
    • <SimpleComponent />を使って、読み込んだコンポーネントを画面に表示します。
  3. コンポーネント(SimpleComponent)をインポートする。
  4. テンプレートに書いた場所に、そのコンポーネントの内容が表示される。

このコードで、SimpleComponent.vueの中身が画面に出力されます!

親コンポーネントと子コンポーネントの関係

Vue.jsでは、コンポーネントは「親子関係」を持つことができます。親コンポーネントが子コンポーネントを利用することで、階層構造を作成します。

src/components/ChildComponent.vue

<!-- ChildComponent.vue -->
<template>
  <div>
    <p>これは子コンポーネントです。</p>
  </div>
</template>

<script>
export default {
  name: "ChildComponent",
};
</script>

<style scoped>
p {
  color: green;
  font-size: 18px;
}
</style>
ChildComponent.vue

src/views/ParentComponent.vue

<!-- ParentComponent.vue -->
<template>
  <div>
    <h1>親コンポーネント</h1>
    <ChildComponent />
  </div>
</template>
<script>
import ChildComponent from "@/components/ChildComponent.vue";

export default {
  name: "ParentComponent",
  components: {
    ChildComponent,
  },
};
</script>
ParentComponent.vue

src/App.vue

<script setup>
import SimpleComponent from "./components/SimpleComponent.vue";
</script>

<template>
    <SimpleComponent />
</template>
App.vue

エイリアス@

エイリアス@はsrc/ディレクトリを指す設定になっている場合、これを使うことで絶対パスとして指定できます。この設定はVue CLIやViteで自動的に有効になっていることが多いです。

もしエイリアスを使わず相対パスで指定する場合は以下のように書きます。

  • 相対パスの場合
import ChildComponent from "../components/ChildComponent.vue";
ParentComponent.vue

子コンポーネントの登録方法

  1. ローカル登録
    上記の例のように、componentsオプションで登録します。この方法は特定の親コンポーネントでのみ子コンポーネントを利用したい場合に適しています。
  2. グローバル登録
    アプリケーション全体で子コンポーネントを使用したい場合は、main.jsでグローバル登録を行います。
import { createApp } from "vue";
import App from "./App.vue";
import ChildComponent from "./components/ChildComponent.vue";

const app = createApp(App);

// グローバル登録
app.component("ChildComponent", ChildComponent);

// アプリケーションをマウント
app.mount("#app");
main.js

※グローバル登録は便利ですが、全コンポーネントが大量の子コンポーネントを使用すると、管理が複雑になる可能性があります。

以下のように各コンポーネントがどの階層にあたるかを整理します。

  1. SimpleComponent
    • 階層:src/components/
    • 理由:汎用的なUIコンポーネントで、特定のページに依存しないため、再利用可能なコンポーネントとしてcomponentsディレクトリに配置します。
  2. ParentComponent
    • 階層:src/views/
    • 理由:ページ全体を構成する親コンポーネントであるため、ビュー専用ディレクトリに配置します。
  3. ChildComponent
    • 階層:src/components/
    • 理由:親コンポーネントの一部として再利用されるUI部品であるため、componentsディレクトリに配置します。

このように階層を分けることで、プロジェクト全体の管理がしやすくなります。

データ通信の基礎

これまでは「コンポーネントの登録」について学びました。登録とは、親コンポーネント内で子コンポーネントを 使用できる状態にする ことを指し、データのやり取りは発生しません。

本章では「データ通信」に焦点を当て、親子間や兄弟コンポーネント間での データの受け渡し 方法を解説します。データ通信を適切に設計することで、コンポーネント同士がスムーズに連携し、より保守性の高いアプリケーションを構築できます。具体的なコード例を交えながら、実践的に学んでいきましょう。

親から子へのデータ伝達

仕組み

親コンポーネントが子コンポーネントにpropsを使ってデータを渡します。
propsはデータの型チェックやデフォルト値の設定も可能です。

コード例

ディレクトリ構成

src/
├── components/
   └── ChildComponent.vue
├── views/
   └── ParentComponent.vue
Bash

ParentComponent.vue

<template>
  <div>
    <h1>親コンポーネント</h1>
    <ChildComponent title="Hello, Vue.js!" />
  </div>
</template>

<script>
import ChildComponent from "../components/ChildComponent.vue";

export default {
  name: "ParentComponent",
  components: {
    ChildComponent,
  },
};
</script>
Vue

ChildComponent.vue

<template>
  <div>
    <h2>{{ title }}</h2>
  </div>
</template>

<script>
export default {
  name: "ChildComponent",
  props: {
    title: {
      type: String, // 型チェック
      default: "デフォルトタイトル", // デフォルト値
    },
  },
};
</script>
Vue

子から親へのデータ伝達

仕組み

子コンポーネントから親コンポーネントへデータを送るには、カスタムイベントと$emitを使用します。

コード例

ディレクトリ構成は同じです。

ParentComponent.vue

<template>
  <div>
    <h1>親コンポーネント</h1>
    <ChildComponent @update="handleUpdate" />
  </div>
</template>

<script>
import ChildComponent from "../components/ChildComponent.vue";

export default {
  name: "ParentComponent",
  components: {
    ChildComponent,
  },
  methods: {
    handleUpdate(data) {
      console.log("受け取ったデータ:", data);
    },
  },
};
</script>
Vue

ChildComponent.vue

<template>
  <button @click="sendData">データを送る</button>
</template>

<script>
export default {
  name: "ChildComponent",
  methods: {
    sendData() {
      this.$emit("update", "子コンポーネントからのデータ");
    },
  },
};
</script>
Vue

兄弟コンポーネント間のデータ共有

仕組み

兄弟コンポーネント間では、親コンポーネントを介してデータを共有します。直接通信はできないため、親からデータを渡す設計が推奨されます。

コード例

ディレクトリ構成

src/
├── components/
   ├── SiblingOne.vue
   ├── SiblingTwo.vue
├── views/
   └── ParentComponent.vue
Bash

ParentComponent.vue

<template>
  <div>
    <SiblingOne @send-data="handleData" />
    <SiblingTwo :sharedData="sharedData" />
  </div>
</template>

<script>
import SiblingOne from "../components/SiblingOne.vue";
import SiblingTwo from "../components/SiblingTwo.vue";

export default {
  name: "ParentComponent",
  components: {
    SiblingOne,
    SiblingTwo,
  },
  data() {
    return {
      sharedData: "",
    };
  },
  methods: {
    handleData(data) {
      this.sharedData = data;
    },
  },
};
</script>
Vue

SiblingOne.vue

<template>
  <button @click="sendData">データを送信</button>
</template>

<script>
export default {
  name: "SiblingOne",
  methods: {
    sendData() {
      this.$emit("send-data", "SiblingOneからのデータ");
    },
  },
};
</script>
Vue

SiblingTwo.vue

<template>
  <div>
    <h2>共有データ: {{ sharedData }}</h2>
  </div>
</template>

<script>
export default {
  name: "SiblingTwo",
  props: {
    sharedData: {
      type: String,
      required: true,
    },
  },
};
</script>
Vue

状態管理を利用しない場合の方法

イベントバスの使用(Vue 2の場合)
  • コンポーネント間通信のためにイベントバスを使います。
  • Vue 3では非推奨ですが、参考として記載。
コード例
// イベントバスの定義
import Vue from "vue";
export const EventBus = new Vue();
JavaScript
  • 親から子:propsを使ってデータを渡す。
  • 子から親:カスタムイベント$emitでデータを送信。
  • 兄弟間:親を介してデータを共有。
  • 状態管理が不要な小規模アプリケーションでは、これらの方法で十分対応可能。

状態管理とコンポーネント間通信

Vue.jsでのアプリケーション開発が大規模化すると、複雑なコンポーネント間通信を管理するために状態管理ツールが必要になります。このセクションでは、状態管理ツールの導入と使用ケース、メリットについて解説します。

VuexやPiniaの導入

Vue.jsには、以下の状態管理ツールがあります。

  • Vuex:Vue.js公式の状態管理ライブラリ(Vue 2から長く使用)。
  • Pinia:Vuexの後継として注目される軽量でモダンな状態管理ライブラリ。
Piniaの導入方法(Vue 3対応)
  • インストール
npm install pinia
Bash
  • セットアップsrc/main.js
import { createApp } from "vue";
import { createPinia } from "pinia";
import App from "./App.vue";

const app = createApp(App);
app.use(createPinia());
app.mount("#app");
main.js
  • ストアの作成src/stores/counter.js
import { defineStore } from "pinia";

export const useCounterStore = defineStore("counter", {
  state: () => ({
    count: 0,
  }),
  actions: {
    increment() {
      this.count++;
    },
  },
});
counter.js
  • ストアの利用src/components/CounterComponent.vue
<template>
  <div>
    <h1>カウント: {{ counterStore.count }}</h1>
    <button @click="counterStore.increment">インクリメント</button>
  </div>
</template>

<script>
import { useCounterStore } from "../stores/counter";

export default {
  setup() {
    const counterStore = useCounterStore();
    return { counterStore };
  },
};
</script>
CounterComponent.vue

小規模なアプリケーションとの違い

小規模なアプリケーションでは、状態管理ツールがなくても、以下の方法で十分に対応できます。

  • 親から子:props
  • 子から親:$emit
  • 兄弟間:親を介したデータ共有

しかし、アプリケーションが大規模になると、以下の課題が発生します。

  • 多数のコンポーネント間でのデータ共有が煩雑になる。
  • データの流れが追いにくくなり、バグの原因になる。

状態管理ツールは、これらの課題を解決します。

状態管理を使うべきケース

  • グローバルなデータ共有が必要な場合
    例:認証情報、ユーザー設定、テーマ設定など。
  • 複数のコンポーネント間でデータを共有する場合
    イベントを連鎖的に発行するのではなく、一元管理した方が効率的。
  • データの一貫性が求められる場合
    例:ECサイトのカートや商品の在庫情報。

グローバルな状態管理のメリット

  • データ共有の一元化
    どのコンポーネントでも同じデータを利用可能。
  • 可読性と保守性の向上
    データの変更や参照元を明確化。
  • 非同期処理の統合
    APIコールやデータフェッチの一貫した管理。

データフローの一元化

状態管理ツールでは、アプリ全体のデータフローを次のように統一します。

  • ストア:アプリ全体の状態を保存する場所。
  • アクション:状態を変更するための関数。
  • コンポーネント:ストアからデータを取得し、UIに反映。
Piniaを使用したデータフロー例
  1. ストアで状態とアクションを定義。
  2. コンポーネントでストアを利用し、データを取得・操作。
  3. 状態が変更されると、自動的に関連コンポーネントが再レンダリング。

コンポーネント設計のベストプラクティス

Vue.jsを使った開発では、効率的で保守性の高いコードを書くために、コンポーネントの設計を工夫することが重要です。このセクションでは、再利用性の高いコンポーネントの作り方や設計のポイントを解説します。

再利用性の高いコンポーネントを作る方法

再利用性の高いコンポーネントを作るには、以下の点に注意します:

  • 柔軟なプロパティ(props)を設計
    必要なデータだけをプロパティとして受け取るようにします。
  • イベントエミッターを活用
    親から子にデータを渡し、子は親にイベントで応答する設計を取ります。

例:ボタンコンポーネント

<template>
  <button :class="styleClass" @click="$emit('click')">
    <slot>ボタン</slot>
  </button>
</template>

<script>
export default {
  name: "CustomButton",
  props: {
    styleClass: {
      type: String,
      default: "btn-default",
    },
  },
};
</script>
Vue
  • スロットを活用(後述)

単一責任の原則

1つのコンポーネントが1つの明確な役割を持つべきです。
例えば、フォーム全体ではなく「入力フィールド」「送信ボタン」など細分化します。

<!-- UserInput.vue -->
<template>
  <input :type="type" :value="value" @input="$emit('update', $event.target.value)" />
</template>
<script>
export default {
  name: "UserInput",
  props: {
    type: {
      type: String,
      default: "text",
    },
    value: {
      type: String,
      default: "",
    },
  },
};
</script>
UserInput.vue

スロットの活用

スロットを使うと、コンポーネントの内部構造を柔軟にカスタマイズできます。

基本スロット

基本スロットは、<slot>タグで定義されます。親コンポーネントが内容を指定しない場合には、スロット内に定義された「デフォルトの内容」が表示されます。

  • ファイル名:src/components/Card.vue
<template>
  <div class="card">
    <slot>デフォルトの内容</slot>
  </div>
</template>
Card.vue

動作のポイント

  • 親コンポーネントからスロットに挿入される内容がない場合、「デフォルトの内容」が表示されます。
  • 親コンポーネントから内容を渡すことで、柔軟なカードデザインが実現します。
名前付きスロット

名前付きスロットでは、name属性を使って特定のスロットに内容を挿入できます。これにより、コンポーネントの異なる部分(例:ヘッダー、フッター)を個別にカスタマイズできます。

  • ファイル名:src/components/Card.vue
<template>
  <div class="card">
    <header>
      <slot name="header">デフォルトのヘッダー</slot>
    </header>
    <main>
      <slot>デフォルトの内容</slot>
    </main>
    <footer>
      <slot name="footer">デフォルトのフッター</slot>
    </footer>
  </div>
</template>
Card.vue

動作のポイント

  • 親コンポーネントで#headerや#footerなどの名前を指定し、それぞれのスロットに対応した内容を挿入できます。
  • 名前付きスロットを使うことで、ヘッダーやフッター、メインコンテンツを個別にカスタマイズ可能です。

以下は、親コンポーネント(例:HomePage.vue)でカードコンポーネントを使用した例です。名前付きスロットを使って、ヘッダーやフッターをカスタマイズしています。

コード例

  • ファイル名:src/views/HomePage.vue
<Card>
  <template #header>
    <h1>カスタムヘッダー</h1>
  </template>
  <p>メインコンテンツ</p>
  <template #footer>
    <button>フッターボタン</button>
  </template>
</Card>
HomePage.vue

カスタムディレクティブの利用

カスタムディレクティブを使うと、再利用可能なDOM操作を簡単に統一できます。

例:クリック外を検知するディレクティブ

//v-click-outside.js
export default {
  mounted(el, binding) {
    el.clickOutsideHandler = (event) => {
      if (!el.contains(event.target)) {
        binding.value(event);
      }
    };
    document.addEventListener("click", el.clickOutsideHandler);
  },
  unmounted(el) {
    document.removeEventListener("click", el.clickOutsideHandler);
  },
};
v-click-outside.js

使用例

<template>
  <div v-click-outside="closeDropdown">
    <p>ドロップダウンの内容</p>
  </div>
</template>

<script>
import ClickOutside from "./directives/v-click-outside.js";

export default {
  directives: {
    ClickOutside,
  },
  methods: {
    closeDropdown() {
      console.log("クリック外を検知しました");
    },
  },
};
</script>
Dropdown.vue

命名規則とディレクトリ構造

命名規則
  • コンポーネント名はPascalCaseを使用(例:UserCard.vue)。
  • ファイル名はコンポーネント名と一致させる。
ディレクトリ構造
src/
├── components/       # 再利用可能なコンポーネント
   ├── Button.vue
   ├── Card.vue
   ├── Dropdown.vue   # 再利用可能なドロップダウン
├── views/            # 各ページ専用のコンポーネント
   ├── HomePage.vue
   ├── AboutPage.vue
├── directives/       # カスタムディレクティブ
   ├── v-click-outside.js
├── stores/           # 状態管理(PiniaやVuex)
├── App.vue           # アプリのルートコンポーネント
└── main.js           # エントリーポイント
Bash

規模に応じた設計例

  • 小規模アプリ
    コンポーネントの分割を最小限にしても管理しやすい。viewsディレクトリで全体を管理。
  • 中規模アプリ
    再利用可能なUI部品をcomponentsに分割し、viewsにはページ単位のレイアウトを配置。
  • 大規模アプリ
    以下のように機能別のディレクトリ構造を採用:
src/
├── components/
├── views/
├── modules/           # 各機能単位のモジュール
   ├── user/
      ├── UserList.vue
      ├── UserDetail.vue
   └── product/
       ├── ProductList.vue
       ├── ProductDetail.vue
└── stores/
Bash

型安全性の向上(TypeScriptの活用)

TypeScriptを使用すると、型安全性が向上し、バグを減らせます。

基本的な導入
  • TypeScriptのインストール:
npm install typescript
Bash
  • Vue 3 + TypeScriptの使用例:
<script lang="ts">
import { defineComponent } from "vue";

export default defineComponent({
  props: {
    count: {
      type: Number,
      required: true,
    },
  },
});
</script>
TypeScript
  • 再利用性の高い設計:柔軟なプロパティとスロットを活用。
  • 単一責任の原則:1つのコンポーネントが1つの責任を持つ。
  • 型安全性:TypeScriptを活用して保守性を向上。
  • ディレクトリ構造:プロジェクト規模に応じて適切に整理。

「コンポーネントの登録」と「コンポーネント間の通信」の違い

項目コンポーネントの登録コンポーネント間の通信
目的コンポーネントを親の中で使えるようにする親子間や兄弟間でデータをやり取りする
必要なものcomponents オプションで登録props, $emit, Vuex, Pinia など
データの受け渡しなし(単なるコンポーネントの読み込み)props(親→子)、$emit(子→親)、状態管理(Vuex, Pinia)など
具体例HelloComponent を表示するだけHelloComponent に親からメッセージを渡す
コード例components: { HelloComponent }<HelloComponent :message=”msg” /> (props 使用)

まとめ

登録 = 親でコンポーネントを使えるようにする(データのやり取りなし)
通信 = props, $emit, 状態管理を使い、コンポーネント間でデータをやり取りする

「登録」だけではコンポーネントを表示するだけ。「通信」することでデータをやり取りできる!」

学んだ内容のまとめ

  1. コンポーネント設計の重要性
    • Vue.js ではコンポーネントを基本単位としてアプリを構築し、再利用性・保守性を向上させる。
  2. コンポーネントの基本構造
    • <template>(UI)、<script>(ロジック)、<style>(見た目)を1つのファイルに統合。
  3. コンポーネントの階層構造と命名規則
    • components/(汎用コンポーネント)、views/(ページコンポーネント)に分ける。
    • PascalCase で命名(例:UserCard.vue)。
  4. 親子コンポーネントの関係とデータ通信
    • 親 → 子: props でデータを渡す。
    • 子 → 親: $emit でイベントを発火。
    • 兄弟間: 親を介してデータ共有。
  5. 状態管理の活用
    • 小規模なら props と $emit、大規模なら Pinia / Vuex を利用。
    • Pinia を導入し、状態を一元管理。
  6. コンポーネント設計のベストプラクティス
    • 単一責任の原則 を守る(1つのコンポーネント = 1つの役割)。
    • スロット(<slot>)を活用し、柔軟に再利用可能な UI を作成。
  7. ディレクトリ構成と命名規則
    • プロジェクトの規模に応じて適切にディレクトリを整理。
    • 型安全性 を高めるために TypeScript の導入も推奨。

コメント

タイトルとURLをコピーしました