まず、ModelMapperをプロジェクトに追加する必要があります。Mavenを使用している場合は、pom.xmlファイルに以下の依存関係を追加します。
<dependency>
<groupId>org.modelmapper</groupId>
<artifactId>modelmapper</artifactId>
<version>2.4.4</version>
</dependency>
ModelMapperを使用するには、以下の手順に従います。
- ModelMapperのインスタンスを作成します。
ModelMapper modelMapper = new ModelMapper();
- マッピング元となるオブジェクトと、マッピング先となるオブジェクトを用意します。
SourceObject sourceObject = new SourceObject();
DestinationObject destinationObject = new DestinationObject();
- マッピングを実行します。
modelMapper.map(sourceObject, destinationObject);
これで、sourceObjectのフィールドの値がdestinationObjectにマッピングされます。
さらに、ModelMapperでは様々なマッピングオプションを利用することができます。例えば、フィールド名が異なる場合や、特定のフィールドを無視する場合などです。以下にいくつかの例を示します。
- フィールド名が異なる場合のマッピング
modelMapper.addMappings(new PropertyMap<SourceObject, DestinationObject>() {
protected void configure() {
map().setTargetField(source.getSourceField());
}
});
- 特定のフィールドを無視する場合
modelMapper.addMappings(new PropertyMap<SourceObject, DestinationObject>() {
protected void configure() {
skip().setIgnoredField(true);
}
});
以上がModelMapperの基本的な使い方といくつかのコード例です。オブジェクトマッピングは、Javaプロジェクトでよく使用されるタスクの一つであり、ModelMapperはその実行を簡素化する強力なツールです。詳細なドキュメントや他の使い方については、ModelMapperの公式ウェブサイトを参照してください。