ModelMapper基本使用和常见场景示例详解

更新时间：2025年06月26日 14:52:57 作者：有梦想的攻城狮

ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置（如匹配策略、转换器）,可集成SpringBoot,减少样板代码,提升开发效率,本文给大家介绍ModelMapper基本使用和常见场景,感兴趣的朋友一起看看吧

1. 添加依赖

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

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

2. 基本用法

ModelMapper 的核心是 ModelMapper 类，通过它的 map 方法可以实现对象之间的属性映射。

示例：简单对象映射

假设有两个类 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. 自定义映射规则

如果源对象和目标对象的属性名不同，或者需要更复杂的映射逻辑，可以通过以下方式自定义：

方式 1：使用 PropertyMap

import org.modelmapper.PropertyMap;
ModelMapper modelMapper = new ModelMapper();
// 自定义映射规则
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：标准匹配，支持驼峰命名转换。

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

忽略某些属性

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

自定义转换器

如果需要将属性值进行转换（例如日期格式化），可以使用 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);
    }
}

总结

ModelMapper 的核心功能包括：

自动映射：根据属性名和类型自动映射。
自定义映射：通过 PropertyMap 或 Lambda 表达式自定义映射规则。
集合映射：支持 List、Set 等集合类型的映射。
高级配置：支持匹配策略、忽略属性、自定义转换器等。
Spring 集成：可以轻松集成到 Spring Boot 项目中。

通过 ModelMapper，可以大大减少对象映射的样板代码，提高开发效率。

到此这篇关于ModelMapper基本使用和常见场景示例详解的文章就介绍到这了,更多相关ModelMapper使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Spring Boot Web 开发注解篇
在 Spring Boot 快速入门中，只要在 pom.xml 加入了 spring-boot-starter-web 依赖，即可快速开发 web 应用。下文给大家详细介绍了spring boot web 开发注解，感兴趣的朋友参考下吧
2017-08-08
maven项目在svn中的上传与检出的方法
企业开发中经常使用svn来为我们控制代码版本，也经常使用maven来管理项目。下面将介绍一下如何将maven项目上传到svn中，如何将项目从svn中检出，感兴趣的小伙伴们可以参考一下
2019-02-02
JavaWeb Refresh响应头代码实例详解
这篇文章主要介绍了JavaWeb Refresh响应头代码实例详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
Java实现导出Word文档的示例代码
poi-tl是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，你可以非常方便的加入到你的项目中。本文就利用它实现导出Word文档功能，需要的可以参考一下
2023-02-02
Java多线程中wait、notify、notifyAll使用详解
这篇文章主要介绍了Java多线程中wait、notify、notifyAll使用详解，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-05-05
SpringBoot整合SSO(single sign on)单点登录
这篇文章主要介绍了SpringBoot整合SSO(single sign on)单点登录，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-06-06
Java中equals()方法的理解与使用方法例子
本文主要介绍了Java中的equals()方法,equals()方法是Object类的方法,用于比较两个对象是否相等,文中通过代码介绍的非常详细,对大家的学习或者工作具有一定的参考借鉴价值,需要的朋友可以参考下
2024-10-10
SpringBoot快速实现接口消息加密的过程详解
在项目中,为了保证数据的安全,我们常常会对传递的数据进行加密,常用的加密算法包括对称加密（AES）和非对称加密（RSA）,博主选取码云上最简单的API加密项目进行下面的讲解,需要的朋友可以参考下
2023-11-11
全面分析Java文件上传
本片文章给大家详细分析了Java文件上传的相关知识点，以及相关代码做了详细分析，有兴趣的朋友学习下。
2018-02-02
RESTful API设计原则与实现示例详解
这篇文章主要为大家介绍了RESTful API设计原则与实现示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04