# Java MyBatisでDTOにマッピングする方法

## 目次

1. はじめに

2. MyBatisとは

3. DTO（Data Transfer Object）とは

4. MyBatisでのDTOマッピングの基本

   1. XMLベースのマッピング

   2. アノテーションベースのマッピング

5. 複雑なDTOへのマッピング

   1. ネストオブジェクトのマッピング

   2. コレクションのマッピング

6. MyBatis GeneratorによるDTO生成とマッピング

7. 実際の開発でのベストプラクティス

8. まとめ

## 1. はじめに

本記事では、JavaのORMツールの一つであるMyBatisを用いてDTO（Data Transfer Object）にマッピングする方法について具体的に解説します。MyBatisは軽量なフレームワークであり、XMLやアノテーションを使ってSQLを記述することができ、その柔軟性と効率性から多くのJavaエンジニアに愛用されています。

## 2. MyBatisとは

MyBatisは、Apache iBatisの後継として開発されたJavaの永続化フレームワークです。SQLを手動でコントロールしつつ、データベースアクセスのフレームワークとしての機能を提供します。これにより、開発者は高度にカスタマイズされたSQLを記述することができる一方、機能的な冗長性を排除し、コードをシンプルに保つことができます。

## 3. DTO（Data Transfer Object）とは

DTO（Data Transfer Object）は、層間でデータをやり取りするために使用されるシンプルなオブジェクトです。DTOは一般に、ビジネスロジックを含まず、データの伝達に専念しており、その構造は単にフィールドとアクセサメソッド（getter/setter）で構成されます。

## 4. MyBatisでのDTOマッピングの基本

### 4-1. XMLベースのマッピング

MyBatisでは、XMLファイルでSQLとDTOのマッピングを定義できます。以下は、その基本的な例です。

```xml

<mapper namespace="com.example.mapper.UserMapper">

  <select id="getUserById" parameterType="int" resultType="com.example.dto.UserDTO">

    SELECT id, name, email FROM users WHERE id = #{id}

  </select>

</mapper>

```

ここでは、`UserDTO`クラスにSQLの結果がマッピングされます。

### 4-2. アノテーションベースのマッピング

アノテーションを使用して、Javaクラスのメソッドに直接SQLを記述することも可能です。

```java

public interface UserMapper {

  @Select("SELECT id, name, email FROM users WHERE id = #{id}")

  UserDTO getUserById(int id);

}

```

アノテーションは開発の初期段階やスモールプロジェクトでの迅速な開発に適していますが、SQLの複雑さが増すとXMLの使用が推奨されます。

## 5. 複雑なDTOへのマッピング

### 5-1. ネストオブジェクトのマッピング

MyBatisは、ネストしたオブジェクト構造にも対応可能です。

```xml

<resultMap id="userResultMap" type="com.example.dto.UserDTO">

  <id property="id" column="id" />

  <result property="name" column="name" />

  <association property="address" javaType="com.example.dto.AddressDTO">

    <id property="id" column="address_id" />

    <result property="city" column="city" />

    <result property="street" column="street" />

  </association>

</resultMap>

```

### 5-2. コレクションのマッピング

コレクション（リスト、セット）を含むDTOへのマッピングも可能です。

```xml

<collection property="roles" ofType="com.example.dto.RoleDTO">

  <id property="id" column="role_id" />

  <result property="name" column="role_name" />

</collection>

```

## 6. MyBatis GeneratorによるDTO生成とマッピング

MyBatis Generatorは、リバースエンジニアリングによって、データベーススキーマから自動的にDTOクラスやマッパーを生成するツールです。これにより、開発者は手動でのマッピング構築の手間を省くことができます。

設定例:

```xml

<generatorConfiguration>

  <context id="DB2Tables" targetRuntime="MyBatis3">

    <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"

                    connectionURL="jdbc:mysql://localhost:3306/mydatabase"

                    userId="root"

                    password="password"/>

    <javaModelGenerator targetPackage="com.example.dto" targetProject="src/main/java"/>

    <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>

    <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>

    <table tableName="users"/>

  </context>

</generatorConfiguration>

```

## 7. 実際の開発でのベストプラクティス

- **SQLの可読性を保つ**: 複雑なSQLを書く場合、XMLでのマッピングを推奨します。可読性が向上し、保守が容易になります。

- **DTO構造の最適化**: DTOは必要なデータのみを含めるようにし、過剰なフィールドを避けます。これにより、データ転送の効率が向上します。

- **MyBatisのキャッシング機能**: キャッシュを活用することで、データベースに対するアクセス頻度を削減できます。

## 8. まとめ

MyBatisを使用してDTOにマッピングすることで、Javaアプリケーションは効率的で柔軟なデータアクセスを実現できます。XMLまたはアノテーションを利用してマッピングを設定し、複雑なネスト構造やコレクションも適切にハンドリングできます。MyBatis Generatorの使用や開発のベストプラクティスを採用することで、開発の生産性をさらに向上させることができます。

Java MyBatisでDTOにマッピングする方法

目次

続きを読むには単価診断を受けてください（30秒）