Javaにおけるデータ転送オブジェクトパターン：サブシステム間のデータ交換の簡素化

別名

• 転送オブジェクト
• 値オブジェクト

データ転送オブジェクトデザインパターンの目的

データ転送オブジェクト（DTO）パターンは、特にJavaアプリケーションでのネットワーク呼び出しやデータベース検索のコンテキストにおいて、ソフトウェアアプリケーションのサブシステムまたはレイヤー間でデータを転送するために使用されます。単一の転送でデータを集約することにより、メソッド呼び出しの数を削減します。

実際の例を用いたデータ転送オブジェクトパターンの詳細な説明

実世界の例

従業員情報を効率的に共有する必要がある、複数の部門（例：営業、人事、IT）を持つ大企業を想像してみてください。各部門が名前、住所、役割などのデータを個別にクエリして取得する代わりに、宅配便サービスを使用してこのデータを1つのパッケージにまとめます。このパッケージはデータ転送オブジェクト（DTO）を表しており、部門は複数のリクエストを行うことなく、包括的な従業員データを簡単に受信して処理できます。これにより、データ処理が簡素化され、通信オーバーヘッドが削減され、会社全体で標準化された形式が保証されます。

簡単な言葉で

DTOを使用すると、1回のバックエンドクエリで関連情報を取得できます。

Wikipediaによると

プログラミングの分野では、データ転送オブジェクト（DTO）は、プロセス間でデータを運ぶオブジェクトです。これを使用する動機は、プロセス間の通信は通常、リモートインターフェイス（例：Webサービス）に頼ることによって行われ、各呼び出しはコストのかかる操作であるためです。各呼び出しのコストの大部分は、クライアントとサーバー間のラウンドトリップ時間に関連しているため、呼び出しの数を減らす1つの方法は、複数の呼び出しによって転送されるはずのデータを集約するオブジェクト（DTO）を使用することですが、1回の呼び出しによってのみ提供されます。

JavaにおけるDTOパターンのプログラム例

まず、シンプルな `CustomerDTO` レコードを紹介します。

public record CustomerDto(String id, String firstName, String lastName) {}

`CustomerResource` レコードは、顧客情報のサーバーとして機能します。

public record CustomerResource(List<CustomerDto> customers) {

    public void save(CustomerDto customer) {
        customers.add(customer);
    }
    
    public void delete(String customerId) {
        customers.removeIf(customer -> customer.id().equals(customerId));
    }
}

DTOがあるので、顧客情報の取得は簡単です。2番目の例では、同様に `ProductDTO` を使用しています。

public class App {

  public static void main(String[] args) {

    // Example 1: Customer DTO
    var customerOne = new CustomerDto("1", "Kelly", "Brown");
    var customerTwo = new CustomerDto("2", "Alfonso", "Bass");
    var customers = new ArrayList<>(List.of(customerOne, customerTwo));

    var customerResource = new CustomerResource(customers);

    LOGGER.info("All customers:");
    var allCustomers = customerResource.customers();
    printCustomerDetails(allCustomers);

    LOGGER.info("----------------------------------------------------------");

    LOGGER.info("Deleting customer with id {1}");
    customerResource.delete(customerOne.id());
    allCustomers = customerResource.customers();
    printCustomerDetails(allCustomers);

    LOGGER.info("----------------------------------------------------------");

    LOGGER.info("Adding customer three}");
    var customerThree = new CustomerDto("3", "Lynda", "Blair");
    customerResource.save(customerThree);
    allCustomers = customerResource.customers();
    printCustomerDetails(allCustomers);

    // Example 2: Product DTO

    Product tv = Product.builder().id(1L).name("TV").supplier("Sony").price(1000D).cost(1090D).build();
    Product microwave =
        Product.builder()
            .id(2L)
            .name("microwave")
            .supplier("Delonghi")
            .price(1000D)
            .cost(1090D).build();
    Product refrigerator =
        Product.builder()
            .id(3L)
            .name("refrigerator")
            .supplier("Botsch")
            .price(1000D)
            .cost(1090D).build();
    Product airConditioner =
        Product.builder()
            .id(4L)
            .name("airConditioner")
            .supplier("LG")
            .price(1000D)
            .cost(1090D).build();
    List<Product> products =
        new ArrayList<>(Arrays.asList(tv, microwave, refrigerator, airConditioner));
    ProductResource productResource = new ProductResource(products);

    LOGGER.info(
        "####### List of products including sensitive data just for admins: \n {}",
        Arrays.toString(productResource.getAllProductsForAdmin().toArray()));
    LOGGER.info(
        "####### List of products for customers: \n {}",
        Arrays.toString(productResource.getAllProductsForCustomer().toArray()));

    LOGGER.info("####### Going to save Sony PS5 ...");
    ProductDto.Request.Create createProductRequestDto =
        new ProductDto.Request.Create()
            .setName("PS5")
            .setCost(1000D)
            .setPrice(1220D)
            .setSupplier("Sony");
    productResource.save(createProductRequestDto);
    LOGGER.info(
        "####### List of products after adding PS5: {}",
        Arrays.toString(productResource.products().toArray()));
  }

  private static void printCustomerDetails(List<CustomerDto> allCustomers) {
    allCustomers.forEach(customer -> LOGGER.info(customer.firstName()));
  }
}

コンソール出力

11:10:51.838 [main] INFO com.iluwatar.datatransfer.App -- All customers:
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Kelly
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Alfonso
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- ----------------------------------------------------------
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Deleting customer with id {1}
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Alfonso
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- ----------------------------------------------------------
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Adding customer three}
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Alfonso
11:10:51.840 [main] INFO com.iluwatar.datatransfer.App -- Lynda
11:10:51.848 [main] INFO com.iluwatar.datatransfer.App -- ####### List of products including sensitive data just for admins: 
 [Private{id=1, name='TV', price=1000.0, cost=1090.0}, Private{id=2, name='microwave', price=1000.0, cost=1090.0}, Private{id=3, name='refrigerator', price=1000.0, cost=1090.0}, Private{id=4, name='airConditioner', price=1000.0, cost=1090.0}]
11:10:51.852 [main] INFO com.iluwatar.datatransfer.App -- ####### List of products for customers: 
 [Public{id=1, name='TV', price=1000.0}, Public{id=2, name='microwave', price=1000.0}, Public{id=3, name='refrigerator', price=1000.0}, Public{id=4, name='airConditioner', price=1000.0}]
11:10:51.852 [main] INFO com.iluwatar.datatransfer.App -- ####### Going to save Sony PS5 ...
11:10:51.856 [main] INFO com.iluwatar.datatransfer.App -- ####### List of products after adding PS5: [Product{id=1, name='TV', price=1000.0, cost=1090.0, supplier='Sony'}, Product{id=2, name='microwave', price=1000.0, cost=1090.0, supplier='Delonghi'}, Product{id=3, name='refrigerator', price=1000.0, cost=1090.0, supplier='Botsch'}, Product{id=4, name='airConditioner', price=1000.0, cost=1090.0, supplier='LG'}, Product{id=5, name='PS5', price=1220.0, cost=1000.0, supplier='Sony'}]

Javaでデータ転送オブジェクトパターンを使用する場合

以下の場合にデータ転送オブジェクトパターンを使用します

• 特にクライアントサーバーアーキテクチャで、呼び出しの数を減らすことによってネットワークトラフィックを最適化する必要がある場合。
• データのバッチ処理が個々の処理よりも優先されるシナリオ。
• リモートインターフェイスで作業する場合、データ転送を簡単に送信できるシリアライズ可能なオブジェクトにカプセル化するため。

データ転送オブジェクトパターン Javaチュートリアル

• Javaにおけるデータ転送オブジェクトパターン - 実装とマッピング (StackAbuse)
• デザインパターン - 転送オブジェクトパターン (TutorialsPoint)
• DTOパターン (Baeldung)

JavaにおけるDTOパターンの実際のアプリケーション

• DTOがネットワーク経由でデータを渡すために使用されるJavaのリモートメソッド呼び出し（RMI）。
• 特にEJBからクライアントにデータを転送する必要がある場合のエンタープライズJavaBeans（EJB）。
• DTOがリクエストデータとレスポンスデータをカプセル化するさまざまなWebサービスフレームワーク。

データ転送オブジェクトパターンの利点とトレードオフ

利点

• ネットワーク呼び出しを削減し、アプリケーションのパフォーマンスを向上させます。
• クライアントをサーバーから分離し、よりモジュール化され保守しやすいコードを作成します。
• データを単一のオブジェクトに集約することにより、ネットワーク経由のデータ送信を簡素化します。

トレードオフ

• アプリケーションに追加のクラスが導入され、複雑さが増す可能性があります。
• ドメインモデルをミラーリングする冗長なデータ構造につながり、同期の問題が発生する可能性があります。
• ビジネスロジックがデータから分離されている貧血ドメインモデルにつながる設計を促進する可能性があります。

関連パターン

• 複合エンティティ：DTOは、特に永続化メカニズムにおいて、複合エンティティを表すために使用される場合があります。
• ファサード：DTOと同様に、ファサードは複数の呼び出しを1つに集約し、効率を向上させる場合があります。
• サービ ス層：多くの場合、DTOを使用してサービス層とそのクライアント間の境界を越えてデータを転送します。

参考文献とクレジット

• コアJ2EEパターン：ベストプラクティスと設計戦略
• J2EEデザインパターン
• エンタープライズアプリケーションアーキテクチャのパターン
• データ転送オブジェクト (Microsoft)