良いコード書けてますか？


エンジニアの皆さんは日々プロジェクトのコードを目にしていると思いますが、そのコードは本当に「**良いコード**」でしょうか？

私自身、自分の書いたコードを振り返ると「**もっとこうすれば良かった**」と感じることがよくあります。しかし、プロジェクトが成熟するとコードの変更は難しくなります。コードを修正すると他への影響が大きくなり、そのリスクを避けようと変更を控える傾向が強まるからです。

結果として、「良いコード」への改善は難しくなり、既存の設計やコーディングスタイルが定着してしまいます。

私もこうした経験があるため、同じ悩みを持つ方々に向けて、この記事を通して改めてオブジェクト指向設計について考えるきっかけを提供できればと思います。

## この記事を読むにあたって

私自身、改めてオブジェクト指向の設計を学んでみようと思い、以下のアプリをオブジェクト指向の設計の考え方を意識して開発してみました。
この記事では、このアプリを具体例として、オブジェクト指向設計のポイントを解説します。

使用してみたい方は [こちら](https://apps.apple.com/jp/app/%E3%82%AB%E3%83%A9%E3%83%80%E8%A8%88%E7%AE%97%E6%A9%9F/id6743381443) からインストールしてみてください。

<a href="https://apps.apple.com/jp/app/%E3%82%AB%E3%83%A9%E3%83%80%E8%A8%88%E7%AE%97%E6%A9%9F/id6743381443"><img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/c652d5eb-2c61-4008-8342-b0b34cfe4c87.png" width="800"></a>

このアプリは、自分の身長や体重、トレーニング情報などを入力すると、**BMI** や **体脂肪率**、**トレーニング指標** などを簡単に確認できるシンプルなものです。

設計する際には **ドメイン駆動設計（DDD）** と **SOLID原則** を意識しましたが、この記事ではそれらの詳細な説明は省略します。あくまでオブジェクト指向設計の考え方や方針に焦点を当て、UMLやコードに馴染みのない方でも気軽に読める内容にしています。

## オブジェクト思考と向き合う前に

みなさんは、自作PCを組み立てたことがありますか？

マザーボードにCPUやメモリ、グラフィックボード、電源、ケースなどのパーツを取り付けることで、自分だけのオリジナルPCを作ることができます。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/914a96e8-114b-4bae-87b7-a2cb3cbf3ed1.png" width="400">

多くの人は、マザーボードやCPUの内部構造を詳しく知らなくても、パーツを適切に組み合わせるだけでPCを完成させています。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/e782110e-f4b6-4170-80bb-862ea1bf2d66.png" width="300">

また、マザーボード自体も、接続するCPUやメモリの詳細な内部構造を知っているわけではありません。ただ、正しく接続されれば各パーツがきちんと動作することを認識しているにすぎません。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/60bf74b7-fa90-447f-a8ae-f2ae6e92d7c4.png" width="300">

私たちユーザーにとっては、「**CPUやメモリを取り付ける**」というインターフェースが提供されているだけで、内部がどのように動いているかを知らなくても問題ありません。
同様にマザーボード側も、CPUやメモリの内部仕様を理解しているわけではありませんが、「**取り付ければそれらが動作する**」ということだけを知っています。

実はこの考え方は、プログラミングの世界にも通じます。

私が設計やコーディングをする際に大切にしている考えは、「**プログラムとはブラックボックスの集合体である**」という方針です。
ここでいうブラックボックスとは、「**インターフェースのみが提供され、その内部構造を知らなくても利用できるもの**」を指しています。

このように、内部の詳細を意識せずに利用可能な設計を行うことこそが、プログラムを作成する上で重要だと考えています。

## この記事で登場する人物

| 名前 | 役割 | イメージ |
| --- | --- | --- |
| 画面 | ユーザーにUIを提供する役割を持ちます。 | <img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/a6bcae67-1a07-4cc8-a376-37aefc69e5c8.png" width="200"> |
| コンポーネント | 画面に配置するUI部品です。 | <img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/e1c41411-116d-46c5-aa83-390d87973b2c.png" width="200"> |
| メトリクス情報 | BMIや体脂肪率などの指標を表すクラスです。 | - |
| ユーザー情報 | ユーザーの身長や体重などの情報を表すクラスです。 | - |
| リポジトリ | データの永続化や取得を行うクラスです。 | - |
| 仕様 | バリデーションを行うクラスです。 | - |

## オブジェクト指向とは？

本当にオブジェクト指向で設計できていますか？

単にクラスを作り、メソッドを定義し、インスタンスを生成して利用しているからといって、オブジェクト指向として適切に設計されているとは限りません。

例えば、次のような例を考えてみましょう。
「身体情報入力画面」で **身長** と **体重** を入力し、それを **DBサービス** クラスを使ってデータベースに保存する処理です。

「サービス」というクラスを導入して **UI** と **ビジネスロジック** を分離しているため、一見オブジェクト指向的に感じるかもしれません。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/02b5a66c-6a8f-4dae-8ccc-a3dc6f579e97.png" width="800">

しかし、このような設計は、オブジェクト指向の本質からは少し外れています。

本来のオブジェクト指向とは、「**オブジェクトという単位**」でプログラムを設計する考え方です。

「身長」や「体重」は **プリミティブ型** のデータです。
プリミティブ型をそのまま使ってやりとりするのは、オブジェクト指向的には望ましくありません。

:::note warn
言語によってはプリミティブ型が存在せず、すべてのデータがオブジェクトとして扱われる場合もあります。
ここでは、**言語が標準で提供する基本的なデータ型（文字列型や整数型など）** を「プリミティブ型」として表現しています。
また、**開発者が独自に定義したデータ型(クラスや構造体など)** を「ユーザ定義データ型」とし、それらを「オブジェクト」として表現しています。
:::

そこで、以下のように設計を見直してみましょう。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/36c8821b-ab3b-4b83-9e5f-3cfe0ecadc92.png" width="800">

このように、**ユーザーオブジェクト** を作成し、このオブジェクトに **身長** や **体重** といった情報を持たせます。
そして、このオブジェクトをDBサービスに渡し、データベースへの保存処理を行います。

プリミティブ型のデータを **明確なオブジェクト** に変換することで、オブジェクト指向の本質により近づくことができます。

そのため、まずは「**プリミティブ型でやりとりする**」という考えを捨て、「**全てをオブジェクトとして扱う**」ことを意識して設計するようにしてみましょう。

私自身も、以前はなんとなくオブジェクト指向を使っていて、「プリミティブ型を使った設計が再利用性を高め、疎結合なコードになる」と考えていました。
そして「疎結合であるほど良いコードだ」と単純に考えていたのです。

## 自分以外には無知であれ

「画面」は、ユーザーに「BMI」などの情報を表示するために「コンポーネント」を利用します。
「コンポーネント」は、渡された「メトリクス情報（BMIなど）」を表示するだけです。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/58019f88-1969-488d-8e57-bcbfa63fce67.png" width="600">

ここで重要なのは、「画面」は「メトリクス情報」や「コンポーネント」の内部構造を **知ってはいけない** ということです。同様に、「コンポーネント」も、「メトリクス情報」の内部構造を **知ってはいけません**。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/5eaae4c0-ae49-4fe3-a432-ce0cd22c9e59.png" width="600">

では、このような設計をどのように実現すれば良いのでしょうか？

先ほどの自作PCの例を思い出してください。
CPUやメモリは、マザーボードに取り付けるだけで動作します。
マザーボードはCPUやメモリの内部構造を知らなくても、「**正しく接続されれば動作する**」ことだけを知っています。マザーボードが知っているのは、CPUやメモリの **インターフェース** だけなのです。
すべての部品が **インターフェース** を介して連携し、動作しています。

この関係をプログラムで表現すると、次のようになります。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/2e0b0ed6-cefa-4590-b447-54cb189ec43d.png" width="600">

「画面」と「コンポーネント」は、**メトリクス情報のIF（インターフェース）** の存在は知っていますが、それが具体的に **何のメトリクス（BMIや体脂肪率など）であるかは知りません**。

「画面」は、「**よく分からないけど、何らかのメトリクス情報をコンポーネントに渡せば、それを適切に表示してくれる**」とだけ認識しています。

一方、「コンポーネント」も、「**なんだか分からないけれど、渡されたメトリクスを表示する**」という役割だけを持ちます。
メトリクスの名前や計算方法は、メトリクス自身が管理しています。コンポーネントはそれらの詳細を知る必要はなく、「ただそれを表示・実行する」だけなのです。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/a3d6de73-b79c-42bf-b99d-a3e9f1baaffe.png" width="600">

数学で例えるならば、「公式がなぜ成り立つか知らなくても、公式を使えば計算できる」というイメージに近いでしょう。

このように、各クラスが自分自身以外の役割や内部構造に対して **無知であること** を意識して設計することが重要です。

## 責任は負いたくない

誰でも、多くの責任を負うのは避けたいものです。
これはプログラムの設計でも同じことが言えます。

プログラム設計において重要なのは、それぞれのクラスに与える **責任を明確** にし、各クラスが「**自身の持つべき責任**」だけを負うようにすることです。

理想的には、**一つのクラスには一つの責任だけを与える** のが望ましいとされています。

よくある問題として、すべてのバリデーション処理をひとまとめにした「バリデーションクラス」を作ってしまうことがあります。しかし、「バリデーションクラス」という概念自体が抽象的すぎて、機能が肥大化し、手に負えなくなることが多いため、あまりお勧めできません。

### 責任の範囲と役割を明確にする

例えば、次のように責任を明確化してみましょう。

- **画面**の責任は、「コンポーネントを表示すること」だけ。
- **コンポーネント**の責任は、「メトリクス情報を画面に表示すること」だけ。
- **メトリクス情報**の責任は、「自身の名前や計算結果が正しいこと」だけです。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/51dea9a2-d379-4a8e-9b21-b2ca92ed3d2b.png" width="800">

もしメトリクス情報の計算結果が間違っていた場合、それはメトリクス情報クラスの責任です。画面やコンポーネントには責任はありません。

もう少し具体的な例を考えてみます。

身体情報を永続化するクラス（以下、「身体情報リポジトリ」と呼びます）は、「**身体情報を永続化する**」という責任のみを負っています。

では、この「身体情報を永続化する」という責任の範囲はどこまででしょうか？

身体情報リポジトリの責任範囲は、あくまでも **身体情報の保存や取得を行うこと** のみです。
たとえば、身体情報が正しい値かどうかをバリデーションするのは、このクラスの責任範囲ではありません。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/af03ebb9-a52f-4e36-9110-47084979890c.png" width="600">

身体情報リポジトリは、保存や取得以外の処理には責任を持つべきではありません。
もしバリデーションのロジックが間違っているときに身体情報リポジトリが怒られるとしたら、それは責任過多で不適切です。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/f09fb9db-ccc1-421e-8bb7-0d504682594b.png" width="400">

そのため、バリデーション処理は別のクラスに切り出しましょう。

身体情報リポジトリには、バリデーションのルール（仕様）を外部から渡せるようにしておきます。身体情報リポジトリはその仕様を実行するだけで、中身を知る必要はありません。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/8895f5bb-d336-4704-bf51-f809ef4055e9.png" width="600">

もし仕様（バリデーション処理）が間違っていれば、責任を負うのは仕様です。身体情報リポジトリの責任ではありません。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/f347f88c-17f9-4cdd-88da-eb388acef823.png" width="400">

また、もし永続化の処理にミスがあった場合のみ、身体情報リポジトリが責任を負うことになります。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/dae2245d-211a-4fe5-ba9c-5de7a06d6f47.png" width="400">

## 何でもかんでも公開しない

「BMI」や「体脂肪率」などのメトリックを配列で管理する **メトリクス** というクラスがあります。このクラスを使ってメトリックの一覧を画面に表示する際、このアプリでは **カテゴリー（身体組成、健康、食事、トレーニング）** ごとにメトリックを表示しています。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/3db97a88-223c-471e-bbdf-000400a7404a.png" width="400">

各メトリックには、それぞれカテゴリーが設定されています。
このカテゴリーに紐付いたメトリックを取得したい場合、よく以下のような処理をしてしまいがちです。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/64724a9e-6829-4629-be8a-8ec65dd81a49.png" width="600">

これは、メトリックのプロパティに **直接アクセス** してメトリックを取得しています。このようにあちこちからプロパティに直接アクセスしていると、プロパティの値が変更された場合、その変更に追従するために多くのコードを修正する必要が生じます。

この問題を防ぐために、以下のように「**門番**」としてメソッドを作成し、プロパティに直接アクセスしないようにします。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/b2b29d0b-58c2-4f2e-b492-5c7810d737b9.png" width="600">

この「門番」を通すことで、プロパティに直接触れることなく、メソッドを介してメトリックを取得することができます。

基本的には、クラスのプロパティへ直接アクセスするのは避け、メソッドを介してアクセスさせるように設計しましょう。

### 意図を明確にする

メソッド名は、処理の意図が伝わるような適切な名前を付けることが重要です。
また、処理を適切な単位でメソッドに分割することで、メソッドの再利用性を高めることができます。

例えば、「メトリックリストを取得する」という処理は、やや抽象的で意図が曖昧になることがあります。
呼び出し元で、**何のために** メトリックリストを取得しているのか、また **どのように** 使っているのかが分かりにくくなります。
そのため、「カテゴリーに応じたメトリックリストを取得する」という明確な意図を持つメソッドを作成すると、処理の意図をはっきりと伝えることができます。

また、「メトリックの個数を取得する」といった処理があった場合は、これも別のメソッドとして分割することで、呼び出し元で処理の意図が明確になります。

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/9fbba072-9f59-4170-bd99-d074fc597c24.png" width="800">

プログラム設計においては、「**漠然とした抽象的な処理**」は避けるべきです。
プロパティへの直接アクセスや不適切なメソッド名はコードの意図を不明確にしてしまいます。

さらに、メソッドの単位を可能な限り小さくすることで、コードが何を意図しているかを明確に表現できます。

## まとめ

オブジェクト指向では、**オブジェクトという単位** でプログラムを設計することが重要です。
オブジェクト指向を意識した設計をする際には、次のポイントを押さえましょう。

- できるだけプリミティブ型を使わず、**オブジェクト** として扱う
- 各クラスが自分以外の役割について **無知** であるように設計する
- クラスごとの **責任を明確** に定義し、その範囲を限定する
- 公開するプロパティを最小限に抑え、メソッドを通じてアクセスする

この記事が、改めてオブジェクト指向設計を考えるきっかけになれば幸いです。
最後に、オブジェクト指向の設計について、私が愛用しているおすすめの書籍を紹介しますので、ぜひ手にとって学習してみてください。

<a href="https://www.amazon.co.jp/dp/4297127830"><img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/b304ea18-1a1f-4b27-a295-07ed407f7d71.jpeg" width="150"></a>　<a href="https://www.amazon.co.jp/dp/B082WXZVPC"><img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3087076/fbe787cc-110d-40a3-b1e6-3de3c479877c.jpeg" width="150"></a>