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

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

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

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注解的基本用法的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！