mapstruct中的@Mapper注解的基本用法

2025-06-14 03:50
文章标签 mapstruct mapper 注解 用法 基本

本文主要是介绍mapstruct中的@Mapper注解的基本用法，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《mapstruct中的@Mapper注解的基本用法》在MapStruct中,@Mapper注解是核心注解之一,用于标记一个接口或抽象类为MapStruct的映射器（Mapper）,本文给大家介绍ma...

在MapStruct中，@Mapper注解是核心注解之一，用于标记一个接口或抽象类为MapStruct的映射器（Mapper）。MapStruct会在编译时自动生成该接口的实现类，完成对象之间的属性映射。以下是对@Mapper注解的详细解析：

1. 基本用法

@Mapper注解可以单独使用，也可以配合其他属性进行配置。以下是一个简单的示例：

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;
@Mapper
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
    @Mapping(source = "username", target = "name")
    UserDTO toUserDTO(User user);
}
  • @Mapper：标记接口为MapStruct的映射器。
  • Mappers.getMapper(UserMapper.class)：获取MapStruct自动生成的映射器实例。
  • @Mapping：指定属性映射规则（例如将User的username属性映射到UserDTO的name属性）。

2. 常用属性

@Mapper注解支持多种属性，用于配置映射器的行为：

(1) componentModel

指定生成的映射器实现类的组件模型，便于与其他框架（如Spring、CDI）集成。

可选值： default：默认模型，不依赖任何框架。

  • spring：生成的映射器实现类会带有@Component注解，便于Spring管理。
  • cdi：生成的映射器实现类会带有@ApplicationScoped注解，便于CDI管理。
  • jsr330：生成的映射器实现类会带有@Javax.inject.Named和@javax.inject.Singleton注解。

示例：

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserMapper www.chinasem.cnINSTANCE = Mappers.getMapper(UserMapper.class);
    // ...
}

(2) uses

指定其他映射器或工具类，用于在映射过程中调用。

示例：

@Mapper(uses = {DateMapper.class})
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
    // ...
}

(3) implementationName 和 implementationPackage

  • implementationName：指定生成的映射器实现类的名称（默认为接口名+Impl）。
  • implementationPackage：指定生成的映射器实现类的包名（默认为接口所在编程包）。

示例：

@Mapper(implementationName = "CustomUserMapperImpl", implementationPackage = "com.example.mappers")
public interface UserMapper {
    // ...
}

(4) unmappedTargetPolicy

指定当目标对象有未映射的属性时的处理策略。

可选值：

  • ERROR：抛出异常（默认值）。
  • WARN：生成警告日志。
  • IGNORE：忽略未映射的属性。

示例：

@Mapper(unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface UserMapper {
    // ...
}

(5) injectionStrategy

指定依赖注入的策略。

可选值：

  • FIELD：通过字段注入（默认值）。
  • CONSTRUCTOR：通过构造函数注入。
  • METHOD：通过方法注入。

示例：

@Mapper(componentModel = "spring", injectionStrategy = InjectionStrategy.CONSTRUCTOR)
public interface UserMapper {
    // ...
}

3. 高级用法

(1) 结合@MapperConfig

可以通过@MapperConfig定义全局配置，然后在@Mapper中引用。

示例：

@MapperConfig(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface CommonMapperConfig {
}
@Mapper(config = CommonMapperConfig.class)
public interface UserMapper {
    // ...
}

(2) 自定义方法

可以在映射器接口中定义自定义方法，MapStruct会调用这些方法完成复杂的映射逻辑。

示例：

@Mapper
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
    @Mapping(target = "fullName", expression = "java(user.getFirstName() + \" \" + user.getLastName())")
    UserDTO toUserDTO(User user);
    default String formatDate(Date date) {
        // 自定义日期格式化逻辑
        return new SimpleDateFormat("yyyy-MM-dd").format(date);
    }
}

4. 注意事项

依赖配置：

  • 确保项目中包含MapStruct的依赖和注解处理器（mapstruct和mwww.chinasem.cnapstruct-processor）。
  • 如果使用Lombok，确保Lombok的版本兼容，并在构建工具（如Maven或Gradle）中正确配置。

映射规则：

  • 如果源对象和目标对象的属性名相同，MapStruct会自动映射。
  • 如果属性名不同，需要通过@Mapping注解显式指定。

性能：

  • MapStruct生成的映射代码是类型安全的，且在编译时完成，性能优于运行时反射的映射工具（如Apache Commons BeanUtils）。

5. 总结

@Mapper注解是MapStruct的核心，通过它可以：

  • 定义映射器接口。
  • 配置映射器的行为（如组件模型、未映射属性的处理策略等）。
  • 结合其他注解（如@Mapping）完成复杂的属性映射。
  • 与其他框架（如Spring）无缝集成。

通过合理使用@Mapper注解及其属性，可以大大简化对象之间的映射逻辑，提高开发效率和代码质量。

6. 编译异常处理

针对MapStruct项目编译异常问题，可从依赖配置、IDE设置、代码规范及版本兼容性四个维度进行排查和解决，以下是具体分析和建议：

  • 现象：缺少必要的注解处理器依赖，如org.mapstruct:mapstruct-processor，导致编译时无法生成Mapper类。
  • 解决方案：
    • Maven项目：在pom.XML中添加MapStruct核心库和处理器依赖，例如：
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.5.3.Final</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.5.3.Final</version>
    <scope>provided</scope>
</dependency>
- **Gradle项目**：在`build.gradle`中添加：
implementation 'org.mapstruct:mapstruct:1.5.3.Final'
annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'

IDE设置问题

  • 现象：IDE未启用注解处理器或缓存异常，导致编译时无法正确处理MapStruct注解。
  • 解决方案：
    • IntelliJ IDEA：打开“File”菜单，选择“Settings”，导航至“Build, Execution, Deployment” -> “Compiler” -> “Annotation Processors”，勾选“Enable annotation processing”选项，并清理IDE缓存后重新构建项目。

代码规范问题

  • 现象：Mapper接口定义错误，如方法签名不匹配或缺少必要注解，导致编译失败。
  • 解决方案：
    • 验证Mapper接口：确保接口符合MapStruct规范，例如：
@Mapper
public interface UserMapper {
    UserDto userToUserDto(User user);
}
- **检查属性映射**：如果源对象和目标对象的属性名不同，需要通过`@Mapping`注解显式指定，例如：
@Mapper
public interface UserMapper {
    @Mapping(source = "username", target = "name")
    UserDto userToUserDto(User user);
}

版本兼容性问题

  • 现象：MapStruct版本与其他依赖（如Lombok）不兼容，导致编译异常。
  • 解决方案：
    • 升级MapStruct版本：尝试升级至最新稳定版本，例如：
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.6.0.Final</version>
</dependency>
- **解决Lombok冲突**：如果项目中同时使用Lombok和MapStruct，特别是使用Lombok的`@Builder`注解时，可能导致`@AfterMapping`不生效。对于Lombok版本1.18.16或更高版本，需添加`lombok-mapstruct-binding`依赖：
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok-mapstruct-binding</artifactId>
    <version>0.2.0</version>
</dependency>

其他可能的问题及解决方案

  • 未映射的目标属性：检查源对象和目标对象，确保存在对应的属性，或使用@Mapping(target = "property", ignore = true)忽略不需要映射的属性。
  • 枚举类型映射：自定义映射方法，例如：
@Mapper
public interface EnumConverter {
    default TargetEnum toTargetEnum(SourceEnum sourceEnum) {
        if (sourceEnum == null) {
            return null;
        }
        switch (sourceEnum) {
            case SOURCE_VALUE1:
                return TargetEnum.TARGET_VALUE1;
            case SOURCE_VALUE2:
                return TargetEnum.TARGET_VALUE2;
            default:
                throw new IllegalArgumentException("Unknown enum type: " + sourceEnum);
        }
    }
}
  • 集合类型映射：使用@Iterhttp://www.chinasem.cnableMapping注解明确指定集合类型的映射方式。
  • 循环引用问题：使用@Context注解通过传递上下文对象来避免无限递归。

到此这篇关于mapstruct中的@Mapper注解的基本用法的文章就介绍到这了,python更多相关mapstruct @Mapper注解内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)！

这篇关于mapstruct中的@Mapper注解的基本用法的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1155052。

相关文章

java中long的一些常见用法

java中long的一些常见用法

《java中long的一些常见用法》在Java中,long是一种基本数据类型,用于表示长整型数值,接下来通过本文给大家介绍java中long的一些常见用法,感兴趣的朋友一起看看吧... 在Java中，long是一种基本数据类型，用于表示长整型数值。它的取值范围比int更大，从-922337203685477
阅读更多...
MyBatis ResultMap 的基本用法示例详解

MyBatis ResultMap 的基本用法示例详解

《MyBatisResultMap的基本用法示例详解》在MyBatis中,resultMap用于定义数据库查询结果到Java对象属性的映射关系,本文给大家介绍MyBatisResultMap的基本... 目录MyBATis 中的 resultMap1. resultMap 的基本语法2. 简单的 resul
阅读更多...
Python主动抛出异常的各种用法和场景分析

Python主动抛出异常的各种用法和场景分析

《Python主动抛出异常的各种用法和场景分析》在Python中,我们不仅可以捕获和处理异常,还可以主动抛出异常,也就是以类的方式自定义错误的类型和提示信息,这在编程中非常有用,下面我将详细解释主动抛... 目录一、为什么要主动抛出异常？二、基本语法：raise关键字基本示例三、raise的多种用法1. 抛
阅读更多...
java中Optional的核心用法和最佳实践

java中Optional的核心用法和最佳实践

《java中Optional的核心用法和最佳实践》Java8中Optional用于处理可能为null的值,减少空指针异常,：本文主要介绍java中Optional核心用法和最佳实践的相关资料,文中... 目录前言1. 创建 Optional 对象1.1 常规创建方式2. 访问 Optional 中的值2.1
阅读更多...
Spring @RequestMapping 注解及使用技巧详解

Spring @RequestMapping 注解及使用技巧详解

《Spring@RequestMapping注解及使用技巧详解》@RequestMapping是SpringMVC中定义请求映射规则的核心注解,用于将HTTP请求映射到Controller处理方法... 目录一、核心作用二、关键参数说明三、快捷组合注解四、动态路径参数（@PathVariable）五、匹配请
阅读更多...
Java 枚举的基本使用方法及实际使用场景

Java 枚举的基本使用方法及实际使用场景

《Java枚举的基本使用方法及实际使用场景》枚举是Java中一种特殊的类,用于定义一组固定的常量,枚举类型提供了更好的类型安全性和可读性,适用于需要定义一组有限且固定的值的场景,本文给大家介绍Jav... 目录一、什么是枚举？二、枚举的基本使用方法定义枚举三、实际使用场景代替常量状态机四、更多用法1.实现接
阅读更多...
git stash命令基本用法详解

git stash命令基本用法详解

《gitstash命令基本用法详解》gitstash是Git中一个非常有用的命令,它可以临时保存当前工作区的修改,让你可以切换到其他分支或者处理其他任务,而不需要提交这些还未完成的修改,这篇文章主要... 目录一、基本用法1. 保存当前修改（包括暂存区和工作区的内容）2. 查看保存了哪些 stash3. 恢
阅读更多...
Python struct.unpack() 用法及常见错误详解

Python struct.unpack() 用法及常见错误详解

《Pythonstruct.unpack()用法及常见错误详解》struct.unpack()是Python中用于将二进制数据（字节序列）解析为Python数据类型的函数,通常与struct.pa... 目录一、函数语法二、格式字符串详解三、使用示例示例 1：解析整数和浮点数示例 2：解析字符串示例 3：解
阅读更多...
C++/类与对象/默认成员函数@构造函数的用法

C++/类与对象/默认成员函数@构造函数的用法

《C++/类与对象/默认成员函数@构造函数的用法》：本文主要介绍C++/类与对象/默认成员函数@构造函数的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录名词概念默认成员函数构造函数概念函数特征显示构造函数隐式构造函数总结名词概念默认构造函数：不用传参就可以
阅读更多...
SpringCloud中的@FeignClient注解使用详解

SpringCloud中的@FeignClient注解使用详解

《SpringCloud中的@FeignClient注解使用详解》在SpringCloud中使用Feign进行服务间的调用时,通常会使用@FeignClient注解来标记Feign客户端接口,这篇文章... 在Spring Cloud中使用Feign进行服务间的调用时，通常会使用@FeignClient注解
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2