ModelMapper基本使用和常見場景示例詳解

更新時間：2025年06月26日 14:52:57 作者：有夢想的攻城獅

ModelMapper是Java對象映射庫,支持自動映射、自定義規(guī)則、集合轉(zhuǎn)換及高級配置（如匹配策略、轉(zhuǎn)換器）,可集成SpringBoot,減少樣板代碼,提升開發(fā)效率,本文給大家介紹ModelMapper基本使用和常見場景,感興趣的朋友一起看看吧

1. 添加依賴

首先，需要在項目中添加 ModelMapper 的依賴。如果你使用 Maven，可以在 pom.xml 中添加以下依賴：

<dependency>
    <groupId>org.modelmapper</groupId>
    <artifactId>modelmapper</artifactId>
    <version>3.1.1</version> <!-- 使用最新版本 -->
</dependency>

2. 基本用法

ModelMapper 的核心是 ModelMapper 類，通過它的 map 方法可以實現(xiàn)對象之間的屬性映射。

示例：簡單對象映射

假設有兩個類 Source 和 Destination，它們的屬性名相同：

import org.modelmapper.ModelMapper;
class Source {
    private String name;
    private int age;
    // getters and setters
}
class Destination {
    private String name;
    private int age;
    // getters and setters
}
public class Main {
    public static void main(String[] args) {
        ModelMapper modelMapper = new ModelMapper();
        Source source = new Source();
        source.setName("Alice");
        source.setAge(25);
        // 將 Source 對象映射到 Destination 對象
        Destination destination = modelMapper.map(source, Destination.class);
        System.out.println(destination.getName()); // 輸出: Alice
        System.out.println(destination.getAge());  // 輸出: 25
    }
}

3. 自定義映射規(guī)則

如果源對象和目標對象的屬性名不同，或者需要更復雜的映射邏輯，可以通過以下方式自定義：

方式 1：使用 PropertyMap

import org.modelmapper.PropertyMap;
ModelMapper modelMapper = new ModelMapper();
// 自定義映射規(guī)則
modelMapper.addMappings(new PropertyMap<Source, Destination>() {
    @Override
    protected void configure() {
        map().setUserName(source.getName()); // 將 Source 的 name 映射到 Destination 的 userName
        map().setYears(source.getAge());     // 將 Source 的 age 映射到 Destination 的 years
    }
});
Source source = new Source();
source.setName("Bob");
source.setAge(30);
Destination destination = modelMapper.map(source, Destination.class);
System.out.println(destination.getUserName()); // 輸出: Bob
System.out.println(destination.getYears());    // 輸出: 30

方式 2：使用 Lambda 表達式（ModelMapper 2.3.0+）

ModelMapper modelMapper = new ModelMapper();
// 使用 Lambda 表達式自定義映射
modelMapper.typeMap(Source.class, Destination.class)
    .addMappings(mapper -> mapper.map(src -> src.getName(), Destination::setUserName))
    .addMappings(mapper -> mapper.map(src -> src.getAge(), Destination::setYears));
Destination destination = modelMapper.map(source, Destination.class);

4. 集合映射

ModelMapper 也支持集合類型的映射，例如將 List<Source> 映射為 List<Destination>：

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
List<Source> sources = Arrays.asList(
    new Source("Alice", 25),
    new Source("Bob", 30)
);
// 方法 1：使用 Stream 和 map
List<Destination> destinations = sources.stream()
    .map(source -> modelMapper.map(source, Destination.class))
    .collect(Collectors.toList());
// 方法 2：直接映射集合（ModelMapper 2.3.0+）
List<Destination> destinations2 = modelMapper.map(sources, new TypeToken<List<Destination>>() {}.getType());

5. 高級配置

匹配策略

ModelMapper 提供了多種匹配策略，例如：

STRICT：嚴格匹配（默認），屬性名和類型必須完全一致。
LOOSE：寬松匹配，屬性名可以部分匹配。
STANDARD：標準匹配，支持駝峰命名轉(zhuǎn)換。

modelMapper.getConfiguration()
    .setMatchingStrategy(MatchingStrategies.LOOSE); // 使用寬松匹配

忽略某些屬性

modelMapper.typeMap(Source.class, Destination.class)
    .addMappings(mapper -> mapper.skip(Destination::setAge)); // 忽略 age 屬性的映射

自定義轉(zhuǎn)換器

如果需要將屬性值進行轉(zhuǎn)換（例如日期格式化），可以使用 Converter：

import org.modelmapper.Converter;
import org.modelmapper.spi.MappingContext;
Converter<String, Date> stringToDateConverter = ctx -> {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
    try {
        return sdf.parse(ctx.getSource());
    } catch (ParseException e) {
        throw new RuntimeException(e);
    }
};
modelMapper.addConverter(stringToDateConverter);

6. 在 Spring Boot 中使用

在 Spring Boot 項目中，可以將 ModelMapper 配置為 Bean：

import org.modelmapper.ModelMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class AppConfig {
    @Bean
    public ModelMapper modelMapper() {
        return new ModelMapper();
    }
}

然后在 Service 或 Controller 中注入使用：

import org.modelmapper.ModelMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserService {
    @Autowired
    private ModelMapper modelMapper;
    public Destination convertToDestination(Source source) {
        return modelMapper.map(source, Destination.class);
    }
}