CleanArchitectureでの扱いについて

Question

設計の勉強をしています。
Clean Architectureでアプリを作っていて、Viewにリストの内容を表示するために、ViewDataとして、配列を持っているのですが、これは、コレクションオブジェクトにした独自の構造体にした方がいいのでしょうか？例えばgithubのリポジトリ一覧を表示したいとき

class Repository{
   let title:String
   let description:String
   let isFavorite:Bool
}

のような型があった場合、viewDataはコレクションオブジェクトで表現すると

struct RepositoryList{
     let elements:[Repository]
}

のように表現するのかそれとも単に[Repository]という型で表現するのかどちらの方がいいのでしょうか？？

また、上記のコレクションは一種のValue Objectだと思うのですが、お気に入りフラグ（isFavorite）を切り替えようとしたとき、どのような処理を書けばいいのでしょうか？？ValueObjectはイミュータブルな処理のため、一つのリポジトリ情報更新ごとに新しい配列を返すようなメソッドがいいかなと思ったのですが、このような処理でいいのでしょうか？？

struct RepositoryListViewDataModel{
    let elements:[Repository]
    
    func updateBookmark(repository:Repository)->Self{
        if let index = elements.firstIndex(where: {$0 == repository}){
            var elements = elements
            elements[index] = repository
            return RepositoryListViewDataModel(elements: elements)
        }else{
            throw Error
        }
    }
}

また、DTOについて書籍で下記のように記載がありました。
これはDTO(Data Transfer Object)と言ってデータ転送用途に使われる設計パターンです。値変更の必要がないのでインスタンス変数はfinalで宣言し、コンストラクタで値が確定するようにします。参照系のみの用途であるため、更新系で使ってはいけません。更新系で用いると低凝集に陥ります。

これとValue Objectの違いがよくわからないのですが、どのような違いがあるのでしょうか？
また、上記のような ViewdataはDTOかVOのどちらなのでしょうか？

Answer 1

リポジトリ一覧の型

リポジトリのリストということなので、↓みたいな感じでいいかなと思います。

class Repository{
   let title:String
   let description:String
   let isFavorite:Bool
}

typealias RepositoryList = [Repository]

実体はRepositoryクラスの配列ですが、typealiasでRepositoryListという名前を付けることで明示的な型を宣言できるところがポイントですね。

Value Objectの更新処理について

また、上記のコレクションは一種のValue Objectだと思うのですが、お気に入りフラグ（isFavorite）を切り替えようとしたとき、どのような処理を[...]

状態の更新をしたくなる場合、それはValue ObjectではなくEntityとして捉えた方がよいと思います。

素直にRepositoryクラスにお気に入りフラグ更新メソッドを持たせた方が処理がシンプルになり、可読性が高まると思いますね。

DTOとValue Objectの違いについて

実装的には特に違いはありませんが、利用する目的や文脈によって別の名前がついた概念と言えます。

DTOはレイヤー間のデータの受け渡しの為に使われることを意図しています。雑なイメージとしてはJSONでデータを受け渡しているのをイメージしてもらえるといいです。

実際、JSONの登場によってDTOを使った設計パターンは役割を終えた感がありますね。

一方、Clean ArchitectureやDDDの文脈におけるValue Objectは日付や金額などの型エイリアスとしての役割が強いです。

型エイリアスとしてValue Objectを定義することで、コードが分かりやすくなることを狙っています。上で述べたRepositoryListのような感じですね。

[...]また、上記のような ViewdataはDTOかVOのどちらなのでしょうか？

Entityとして捉えた方が自然だと思いますね。

Comments

[nostrils]

ご回答ありがとうございます！
状態の更新をしたくなる場合、それはValue ObjectではなくEntityとして捉えた方がよいと思います。
とのことでしたが、上記のRepositoryListはViewに表示するようのViewDataであり、ドメイン知識を持ったEntityとは役割が違う気がするのですが、それでもEntityと捉える理由はなんでしょうか？

また、DTOというのはミュータブルに扱ってもいいのでしょうか？？

[madoka-t]

色々と論点があるので箇条書きにしますね。

・ViewDataがEntityであっては*いけない*という理由がない（Clean Architectureでもプレゼンテーション層からドメイン層への依存は禁止されていない）
・言語がSwiftということはIOSアプリ開発の文脈だと思われるが、GUIアプリケーションは本質的に状態を持つものである（Viewの状態はイミュータブルにはならない）
・ViewData（ViewModel？）がドメインの知識を持っていることは別におかしなことではない（UIの制御にドメイン知識が必要になる場面は当然ある）
・Viewに渡すデータをイミュータブルなDTOにする設計はWEBアプリケーションかつCQRSを意識した設計のように思えるが、GUIアプリにそのまま当てはめるべきかは疑問が残る
・DTOをミュータブルに扱ってよいかについては、完全に設計ポリシーで決める問題なので唯一の答はない（上述したようにWEBアプリケーションではイミュータブルであることが望ましいが、そうでない場合もある）
・DTOをレイヤー間のデータのやりとりに使う場合、DTOの内容を更新して元のレイヤーに投げ返すということは十分考えられる
・Clean Architecture的な設計に従うのであれば、ViewData（ViewModel？）の変化はControllerを経由してドメイン層に伝えることになるので、やはりViewDataはイミュータブルにはならないはず

といった感じでしょうか。

Answer 2

Clean Architectureはちゃんと勉強したことがないのですが(すみません。。)、
Value Object(値オブジェクト)やData Transfer Object(DTO)はClean Architectureに限ったものではないようにも思いましたので、
一緒に勉強させていただきたい気持ちもあって、回答してみました。

---

これとValue Objectの違いがよくわからないのですが、どのような違いがあるのでしょうか？
また、上記のような ViewdataはDTOかVOのどちらなのでしょうか？

質問欄に色々「？」がありましたが、まず、最後の2行についてだけ書いてみます。

ドメインモデルとして挙げられていなかった概念を値オブジェクトにすべきかどうかの判断基準として、筆者は「そこにルールが存在しているか」という点と「それ単体で扱いたいか」という点を重要視しています。
たとえば氏名には「姓と名で構成される」というルールがあります。
また本文で例示したように単体で取り扱っています。
筆者の判断基準に照らし合わせると値オブジェクトとして定義されます。
では姓や名はどうでしょうか。
いまのところ性や名にシステム上の制限はありません。
姓だけを取り扱ったり、名だけを利用するシーンもいまのところありません。
筆者の判断基準からするとこれらはまだ値オブジェクトにしないでしょう。
『ドメイン駆動設計入門 P.030』

.

class FullName : IEquatable<FullName>
{
    private readonly string firstName;
    private readonly string lastName;
    public FullName(string firstName, string lastName)
    {
        if (firstName == null) throw new ArgumentNullException(nameof(firstName));
        if (lastName == null) throw new ArgumentNullException(nameof(lastName));
        if (!ValidateName(firstName)) throw new ArgumentException("許可されていない文字が使われています。", nameof(firstName));
        if (!ValidateName(lastName)) throw new ArgumentException("許可されていない文字が使われています。", nameof> (lastName));
        this.firstName = firstName;
        this.lastName = lastName;
    }
    private bool ValidateName(string value)
    {
        // アルファベットに限定する
        return Regex.IsMatch(value, @"^[a-zA-Z+$");
    }
    // (...略...)
}

『ドメイン駆動設計入門 P.031』

.

値オブジェクトのコンセプトは「システム固有の値を作ろう」という単純なものです。
システムには、そのシステムならではの値が必ずあるはずです。
もちろん、プリミティブな値だけでソフトウェアを構築することは可能です。
しかし、プリミティブ型は汎用的すぎて、どうしても表現力が乏しくなってしまいます。
『ドメイン駆動設計入門 P.046』

.

そこで筆者がお勧めするのはドメインオブジェクトを直接公開しない方針です。
ドメインオブジェクトを非公開としたとき、クライアントにはデータ転送用オブジェクト(DTO、Data Transfer Object)にデータを差し替えて返却します。
『ドメイン駆動設計入門 P.122』

.

凝集度の低いモジュールは、関係性のない仕事をこなしたり、仕事が多すぎたりする特徴があります。
これは以下のような問題を発生させます。

• コードが理解しにくい。
• コードが保守しにくい。
• コードが再利用しにくい。
• コードが脆弱で、変更による影響を絶えず受ける。

『プリンシプル オブ プログラミング P.189』

---

入門の書籍しか読んだことはないのですが、役割の違いがあるように思いました。
(引用した書籍はC#なのですがすみません。。)

個人的に書籍を読む前は、Value Object(値オブジェクト)は、広い意味ですとイミュータブル的なものを全てそう呼ぶような印象でした。
でも、『ドメイン駆動設計入門』を読みますと、狭い意味ではルールのある項目がValue Objectになるように思いました。
『ドメイン駆動設計入門』では、値オブジェクトを持っているのがエンティティになるようでした。
同じレイヤーの中でエンティティの中に保持されるルールのある項目が値オブジェクトという感じです。

それに対してDTOは、レイヤー間でデータを受け渡しする役割があるように思います。

値オブジェクトとDTOは別の役割があると思いますので、役割が違うようでしたらそれぞれ存在する感じで実装するのが教科書的な印象でした。

また、上記のような ViewdataはDTOかVOのどちらなのでしょうか？

あまり自信はないですが、エンティティ的な印象かなと思いました。。

十分に回答できていないと思いますので、コメントをもらえると嬉しいです。