方法1: 手動でのマッピング
エンティティ例: User
@Entity
public class User {
private Integer id;
private String name;
private Integer age;
// コンストラクタ、ゲッター、セッターなど
}
DTO例: UserDto
public class UserDto {
private Integer id;
private String name;
// コンストラクタ、ゲッター、セッターなど
}
サービス層での手動変換
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public List<UserDto> getAllUsers() {
List<User> users = userRepository.findAll();
return users.stream().map(this::convertToDto).collect(Collectors.toList());
}
private UserDto convertToDto(User user) {
UserDto dto = new UserDto();
dto.setId(user.getId());
dto.setName(user.getName());
return dto;
}
}
- メリット: コードがシンプルで理解しやすい。
- デメリット: エンティティとDTOのフィールドが多い場合、手動での変換が煩雑になる。
方法2: ModelMapperを使用した自動マッピング
ModelMapperは、Javaオブジェクト間のマッピングを自動的に行うためのライブラリです。エンティティとDTOのフィールド名が一致している場合、非常に簡単に変換ができます。
依存関係（Maven）
<dependency>
<groupId>org.modelmapper</groupId>
<artifactId>modelmapper</artifactId>
<version>3.1.0</version> <!-- バージョンは最新のものに合わせてください -->
</dependency>
ModelMapperの設定
ModelMapperをSpringのコンポーネントとして設定します。
import org.modelmapper.ModelMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class ModelMapperConfig {
@Bean
public ModelMapper modelMapper() {
return new ModelMapper();
}
}
サービス層での使用例
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
@Autowired
private ModelMapper modelMapper;
public List<UserDto> getAllUsers() {
List<User> users = userRepository.findAll();
return users.stream()
.map(user -> modelMapper.map(user, UserDto.class))
.collect(Collectors.toList());
}
}
- メリット: コード量を大幅に削減でき、フィールド名が一致している限り、手動でのマッピングが不要です。
- デメリット: 複雑なマッピングやカスタムロジックが必要な場合には、調整が必要です。
方法3: MapStructを使用したコンパイル時の自動マッピング
MapStructは、コンパイル時にマッピングコードを生成するため、実行時のパフォーマンスが非常に高いのが特徴です。また、カスタムマッピングにも柔軟に対応できます。
依存関係（Maven）
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.5.0.Final</version> <!-- バージョンは最新のものに合わせてください -->
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.5.0.Final</version>
<scope>provided</scope>
</dependency>
Mapperインターフェースの作成
MapStructでは、インターフェースとしてマッピングロジックを定義します。コンパイル時に自動的に実装クラスが生成されます。
import org.mapstruct.Mapper;
@Mapper(componentModel = "spring")
public interface UserMapper {
// EntityをDTOに変換
UserDto toDto(User user);
// DTOをEntityに変換（必要な場合）
User toEntity(UserDto userDto);
}
サービス層での使用例
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
@Autowired
private UserMapper userMapper;
public List<UserDto> getAllUsers() {
List<User> users = userRepository.findAll();
return users.stream()
.map(userMapper::toDto)
.collect(Collectors.toList());
}
}
- メリット: 高速なパフォーマンスと、コンパイル時にマッピングコードが生成されるため、実行時エラーを防ぐことができます。
- デメリット: 追加の依存関係が必要で、マッピングの複雑さに応じて設定が必要になる場合があります。
方法4: StreamやLambda式を使ったカスタムマッピング
もしマッピングが少し複雑な場合や、変換のロジックに条件を追加したい場合、StreamやLambda式を使ってカスタムマッピングを行うこともできます。
カスタム変換ロジックの例
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public List<UserDto> getAllUsers() {
List<User> users = userRepository.findAll();
return users.stream()
.map(user -> {
UserDto dto = new UserDto();
dto.setId(user.getId());
dto.setName(user.getName());
if (user.getAge() >= 18) {
dto.setName(dto.getName() + " (Adult)"); // 18歳以上なら「(Adult)」を追加
}
return dto;
})
.collect(Collectors.toList());
}
}
- メリット: マッピングロジックに細かい条件を入れたい場合に有効です。
- デメリット: ロジックが増えると、手動のマッピングと同様に煩雑になる可能性があります。
まとめ
エンティティをDTOに変換する最適な方法は、プロジェクトの要件によって異なります。以下にそれぞれの特徴をまとめます。
- 手動マッピング: シンプルなプロジェクトでは有効ですが、大規模プロジェクトでは煩雑。
- ModelMapper: フィールド名が一致する場合には便利。動的な変換が少ない場合に推奨。
- MapStruct: 高速かつ型安全。コンパイル時にコードを生成するため、パフォーマンスと安全性が高い。
- カスタムマッピング（StreamやLambda）: 変換ロジックが複雑な場合に使用。
開発の効率化やメンテナンス性を考慮して、プロジェクトに合った方法を選択するのがベストです。