脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Boot 项目集成MapStruct

Spring Boot 项目集成MapStruct 看这一篇就够了（超详细步骤）

 更新时间：2026年02月10日 14:13:41   作者：CodeAmaz  
本文给大家介绍在SpringBoot项目中使用MapStruct进行DTO和Entity之间的映射,包括配置、示例代码、常见技巧和最佳实践,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧

适用人群：会用 Spring Boot，想在项目里把 DTO ⇄ Entity 的样板代码（getter/setter、拷贝字段）换成高性能、可编译期校验的 MapStruct。
示例构建工具：Maven（附 Gradle 版）
示例 JDK：17（11+ 都可）
示例 Spring Boot：3.2+（2.7+ 也可）
示例 MapStruct：1.5.5.Final（写作时的稳定版）

为什么选 MapStruct

  • 编译期生成：没有运行时反射，性能高，启动开销小。
  • 类型安全：编译期就能发现字段不匹配等问题，更早暴露错误。
  • 可维护：映射规则集中在接口/注解上，团队更易读更稳定。
  • 可扩展：支持表达式、自定义方法、生命周期回调、依赖注入。

准备工作

  • JDK 11+（示例使用 17）
  • 一个可运行的 Spring Boot 项目（Web/Service 都可）
  • IDE：开启 Annotation Processing（注解处理），否则不会生成实现类
    • IntelliJ IDEA：Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors -> Enable

Maven 集成步骤（推荐）

1）在 pom.xml 添加依赖与注解处理器

<properties>
    <java.version>17</java.version>
    <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
    <lombok.version>1.18.34</lombok.version>
</properties>
<dependencies>
    <!-- MapStruct API -->
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
    <!-- Lombok（如项目使用） -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <configuration>
                <source>${java.version}</source>
                <target>${java.version}</target>
                <encoding>UTF-8</encoding>
                <compilerArgs>
                    <arg>-Amapstruct.defaultComponentModel=spring</arg>
                </compilerArgs>
                <annotationProcessorPaths>
                    <!-- MapStruct 注解处理器（生成实现类） -->
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                    <!-- Lombok 注解处理器（如项目使用） -->
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${lombok.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

说明：-Amapstruct.defaultComponentModel=spring 可全局指定生成 @Component/@Mapper(componentModel="spring") 的 Spring Bean；也可以逐个 Mapper 上写注解。

Gradle 集成步骤

Kotlin DSL（build.gradle.kts）

plugins {
    java
    id("org.springframework.boot") version "3.3.4"
    id("io.spring.dependency-management") version "1.1.6"
}
java.sourceCompatibility = JavaVersion.VERSION_17
dependencies {
    implementation("org.mapstruct:mapstruct:1.5.5.Final")
    annotationProcessor("org.mapstruct:mapstruct-processor:1.5.5.Final")
    compileOnly("org.projectlombok:lombok:1.18.34")
    annotationProcessor("org.projectlombok:lombok:1.18.34")
}
tasks.withType<JavaCompile> {
    options.compilerArgs.addAll(listOf("-Amapstruct.defaultComponentModel=spring"))
    options.encoding = "UTF-8"
}

Groovy DSL（build.gradle）

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.3.4'
    id 'io.spring.dependency-management' version '1.1.6'
}
sourceCompatibility = '17'
dependencies {
    implementation 'org.mapstruct:mapstruct:1.5.5.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.5.Final'
    compileOnly 'org.projectlombok:lombok:1.18.34'
    annotationProcessor 'org.projectlombok:lombok:1.18.34'
}
tasks.withType(JavaCompile) {
    options.compilerArgs += ['-Amapstruct.defaultComponentModel=spring']
    options.encoding = 'UTF-8'
}

创建示例实体与 DTO

domain/User.java

package com.example.demo.domain;
import lombok.Data;
import java.time.LocalDate;
import java.util.List;
@Data
public class User {
    private Long id;
    private String username;
    private String email;
    private LocalDate birthday;
    private Address address;
    private List<String> roles;
    private Gender gender;
    @Data
    public static class Address {
        private String province;
        private String city;
        private String detail;
    }
    public enum Gender {
        MALE, FEMALE, OTHER
    }
}

dto/UserDTO.java

package com.example.demo.dto;
import lombok.Data;
import java.util.List;
@Data
public class UserDTO {
    private String id;              // 注意：字符串
    private String name;            // username -> name
    private String email;
    private String birthday;        // 字符串日期，格式：yyyy-MM-dd
    private String fullAddress;     // 由 address 组合
    private List<String> roles;
    private String gender;          // enum -> 字符串
}

编写 Mapper 接口（Spring 集成）

mapper/UserMapper.java

package com.example.demo.mapper;
import com.example.demo.domain.User;
import com.example.demo.dto.UserDTO;
import org.mapstruct.*;
import org.mapstruct.factory.Mappers;
@Mapper(componentModel = "spring",
        unmappedTargetPolicy = ReportingPolicy.IGNORE // 未映射字段忽略（也可 WARN/ERROR）
)
public interface UserMapper {
    // 也可以用 Spring 注入，不需要 INSTANCE
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
    @Mappings({
        @Mapping(source = "id", target = "id"),
        @Mapping(source = "username", target = "name"),
        @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd"),
        @Mapping(target = "fullAddress", expression =
                "java(user.getAddress()==null? null : " +
                "user.getAddress().getProvince()+\"-\"+user.getAddress().getCity()+\"-\"+user.getAddress().getDetail())"),
        @Mapping(source = "gender", target = "gender") // enum -> String，MapStruct 会调用 name()
    })
    UserDTO toDTO(User user);
    // 反向映射由 @InheritInverseConfiguration 提供（见下一节）
}

常见映射技巧

1）字段名不同（source/target）

@Mapping(source = "username", target = "name")

2）类型不同（日期、枚举、数值）

@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")

3）表达式 / 自定义方法

@Mapping(target = "fullAddress",
         expression = "java(combineAddress(user))")
default String combineAddress(User user) {
    if (user.getAddress() == null) return null;
    var a = user.getAddress();
    return String.join("-", a.getProvince(), a.getCity(), a.getDetail());
}

4）忽略字段

@Mapping(target = "roles", ignore = true)

5）统一策略（全局）

@Mapper(unmappedTargetPolicy = ReportingPolicy.ERROR) // 强制必须映射

双向映射与反向配置复用

UserMapper.java（续）

@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface UserMapper {
    UserDTO toDTO(com.example.demo.domain.User user);
    @InheritInverseConfiguration(name = "toDTO")
    @Mappings({
        // 反向时，字符串 -> Long
        @Mapping(target = "id", expression = "java( userDTO.getId()==null? null : Long.valueOf(userDTO.getId()) )"),
        // 字符串 -> LocalDate
        @Mapping(target = "birthday", dateFormat = "yyyy-MM-dd"),
        // 反向需要拆分 fullAddress
        @Mapping(target = "address", expression = "java(splitAddress(userDTO.getFullAddress()))")
    })
    com.example.demo.domain.User toEntity(UserDTO userDTO);
    default com.example.demo.domain.User.Address splitAddress(String full) {
        if (full == null || full.isBlank()) return null;
        String[] parts = full.split("-", 3);
        var a = new com.example.demo.domain.User.Address();
        a.setProvince(parts.length > 0 ? parts[0] : null);
        a.setCity(parts.length > 1 ? parts[1] : null);
        a.setDetail(parts.length > 2 ? parts[2] : null);
        return a;
    }
}

增量更新（部分字段更新）

适用于 PATCH 场景：用 DTO 的非空字段更新已有实体。

import org.mapstruct.BeanMapping;
import org.mapstruct.NullValuePropertyMappingStrategy;
import org.mapstruct.MappingTarget;
@Mapper(componentModel = "spring")
public interface UserUpdateMapper {
    @BeanMapping(nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
    void updateFromDto(UserDTO dto, @MappingTarget com.example.demo.domain.User entity);
}

说明：当 DTO 某个字段为 null 时，不覆盖实体已有值。

集合、枚举、日期格式化

  • 集合：List<A> ↔ List<B>，若存在 A↔B 的映射方法，集合会自动映射。
  • 枚举：默认使用 name()/valueOf；可通过 @ValueMapping 自定义映射。
  • 日期：@Mapping(dateFormat = "yyyy-MM-dd HH:mm:ss")；或注册自定义 DateMapper。

自定义日期转换器示例

@Component
public class DateMapper {
    public String asString(LocalDate date) { return date == null ? null : date.toString(); }
    public LocalDate asLocalDate(String date) { return date == null ? null : LocalDate.parse(date); }
}

@Mapper(componentModel = "spring", uses = DateMapper.class)
public interface UserMapper { /* ... */ }

使用 @AfterMapping/@BeforeMapping 做后/前处理

@Mapper(componentModel = "spring")
public interface TrimMapper {
    @Mapping(target = "name", source = "username")
    UserDTO toDTO(User user);
    @AfterMapping
    default void trimAll(@MappingTarget UserDTO dto) {
        if (dto.getName() != null) dto.setName(dto.getName().trim());
        if (dto.getEmail() != null) dto.getEmail().trim();
    }
}

@BeforeMapping 也可用于输入预处理，参数既可以是源对象也可以是 @Context 上下文对象。

在 Spring Boot 中调用与测试

service/UserService.java

@Service
@RequiredArgsConstructor
public class UserService {
    private final UserMapper userMapper;          // Spring 自动注入
    private final UserUpdateMapper updateMapper;  // 增量更新示例
    public UserDTO getUserDTO(User user) {
        return userMapper.toDTO(user);
    }
    public void patchUser(UserDTO patch, User entity) {
        updateMapper.updateFromDto(patch, entity);
    }
}

UserMapperTest.java

@SpringBootTest
class UserMapperTest {
    @Autowired
    private UserMapper userMapper;
    @Test
    void testToDTO() {
        User u = new User();
        u.setId(1L);
        u.setUsername("alice");
        u.setEmail("a@x.com");
        u.setBirthday(LocalDate.of(1990,1,1));
        User.Address a = new User.Address();
        a.setProvince("ZJ"); a.setCity("HZ"); a.setDetail("WestLake");
        u.setAddress(a);
        u.setGender(User.Gender.FEMALE);
        UserDTO dto = userMapper.toDTO(u);
        assertEquals("1", dto.getId());
        assertEquals("alice", dto.getName());
        assertEquals("1990-01-01", dto.getBirthday());
        assertEquals("ZJ-HZ-WestLake", dto.getFullAddress());
        assertEquals("FEMALE", dto.getGender());
    }
}

与 Lombok 共存注意事项

  • 同时使用时，确保 两个注解处理器都启用（mapstruct-processor 与 lombok）。
  • IDE 必须开启 Annotation Processing。
  • 不再需要历史上的 lombok-mapstruct-binding（新版本大多无需）。若遇到 builder 兼容性问题，再考虑加：
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok-mapstruct-binding</artifactId>
    <version>0.2.0</version>
    <scope>provided</scope>
</dependency>

常见报错与排查

  • 没有生成实现类（UserMapperImpl 不存在）
    • IDE 未开启 Annotation Processing。
    • 忘记添加 mapstruct-processor 到 annotationProcessorPaths。
    • 清理重建：mvn -U clean compile / ./gradlew clean build。
  • unmapped target property（未映射字段告警/错误）
    • 设置 unmappedTargetPolicy = ReportingPolicy.IGNORE|WARN|ERROR。
    • 明确加 @Mapping(ignore = true)。
  • 类型不匹配
    • 提供自定义转换方法（default 方法或 uses）。
    • 用 expression 处理复杂逻辑。
  • 循环依赖映射（A 包含 B，B 又包含 A）
    • 拆分为两个 Mapper，并使用 uses 注入彼此，或在其中一个方向上忽略回指字段。
  • Spring 注入失败（NoSuchBeanDefinitionException）
    • 确认 componentModel="spring" 或编译参数全局开启；
    • Mapper 包路径在 @SpringBootApplication 扫描范围内。

生产最佳实践清单

  • ✅ 给每个 Mapper 显式设置 componentModel="spring" 与 unmappedTargetPolicy。
  • ✅ 把「复杂组装逻辑」封装为可单测的 default 方法或独立的 @Component，通过 uses 复用。
  • ✅ @BeanMapping(nullValuePropertyMappingStrategy = IGNORE) 做增量更新（避免空值覆盖）。
  • ✅ 对 DTO 做最小字段暴露，防止过度映射。
  • ✅ 加上 单元测试 覆盖关键映射。
  • ✅ 对外接口层尽量用 DTO，Domain 保持纯净。

参考命令（Maven）

mvn -U clean compile    # 触发注解处理器，生成 *MapperImpl
mvn test                # 运行单测
mvn spring-boot:run     # 启动应用

到此这篇关于Spring Boot 项目集成MapStruct 看这一篇就够了（超详细步骤）的文章就介绍到这了,更多相关Spring Boot 项目集成MapStruct 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java聊天室之实现接收和发送Socket

    Java聊天室之实现接收和发送Socket

    这篇文章主要为大家详细介绍了Java简易聊天室之实现接收和发送Socket功能，文中的示例代码讲解详细，具有一定的借鉴价值，需要的可以了解一下
    2022-10-10
  • spring cloud oauth2 feign 遇到的坑及解决

    spring cloud oauth2 feign 遇到的坑及解决

    这篇文章主要介绍了spring cloud oauth2 feign 遇到的坑及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-03-03
  • 关于Jsoup将相对路径转为绝对路径的方法

    关于Jsoup将相对路径转为绝对路径的方法

    这篇文章主要介绍了关于Jsoup将相对路径转为绝对路径的方法,jsoup 是一款Java 的HTML解析器，可直接解析某个URL地址、HTML文本内容,需要的朋友可以参考下
    2023-04-04
  • Java 锁的知识总结及实例代码

    Java 锁的知识总结及实例代码

    这篇文章主要介绍了Java 锁的知识总结及实例代码,需要的朋友可以参考下
    2016-09-09
  • 深入解析Java实现文件写入磁盘的全链路过程

    深入解析Java实现文件写入磁盘的全链路过程

    写一行简单的 Java 文件操作代码,数据就能顺利保存到磁盘,这背后到底经历了什么,本文将从源码到硬件,全方位拆解这个过程,有需要的可以了解下
    2025-05-05
  • 高效数据传输的秘密武器Protobuf的使用教程

    高效数据传输的秘密武器Protobuf的使用教程

    Protobuf（Protocol Buffers）是由 Google 开发的一种轻量级、高效的数据交换格式，它被用于结构化数据的序列化、反序列化和传输，本文主要介绍了它的具体使用方法，需要的可以参考一下
    2023-05-05
  • Java中Set集合遍历的四种方法实现

    Java中Set集合遍历的四种方法实现

    本文主要介绍了Java中Set集合遍历的四种方法实现,包括迭代器遍历、增强型for循环遍历、Stream API遍历以及TreeSet的有序遍历,具有一定的参考价值,感兴趣的可以了解一下
    2025-05-05
  • 浅谈解决Hibernate懒加载的4种方式

    浅谈解决Hibernate懒加载的4种方式

    这篇文章主要介绍了浅谈解决Hibernate懒加载的4种方式，具有一定借鉴价值，需要的朋友可以参考下。
    2017-12-12
  • 使用@value注解取不到application.xml配置文件中的值问题

    使用@value注解取不到application.xml配置文件中的值问题

    这篇文章主要介绍了使用@value注解取不到application.xml配置文件中的值问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-03-03
  • Java实现基础银行ATM系统

    Java实现基础银行ATM系统

    这篇文章主要为大家详细介绍了Java实现基础银行ATM系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-05-05

最新评论