# 单元测试映射器和转换器 ## 概述此技能提供了用于单元测试 MapStruct 映射器和自定义转换器类的模式。它涵盖测试字段映射准确性、空处理、类型转换、嵌套对象转换、双向映射、枚举映射以及全面映射测试覆盖范围的部分更新。 ## 何时使用在以下情况下使用此技能： * 测试 MapStruct 映射器实现 * 测试自定义实体到 DTO 转换器 * 测试嵌套对象映射 * 验证映射器中的空处理 * 测试类型转换和转换 * 在集成测试之前需要全面的映射测试覆盖率 ## 说明 1. **使用Mappers.getMapper()** ：获取非Spring独立测试的mapper实例 2. **测试双向映射** ：验证实体→DTO和DTO→实体转换是否对称 3. **测试 null 处理**：验证 null 输入产生 null 输出或适当的默认值 4. **测试嵌套对象**：验证嵌套对象是否正确且独立地映射 5. **使用递归比较** ：对于复杂的嵌套结构，使用assertThat().usingRecursiveComparison() 6. **测试自定义映射**：验证带有自定义表达式的@Mapping注解是否正常工作 7. **测试枚举映射**：验证@ValueMapping正确转换枚举值 8. **测试部分更新** ：验证@MappingTarget仅更新指定字段 ## 示例 ## 设置：测试映射器 ### Maven <依赖关系> org.mapstruct mapstruct <版本>1.5.5.最终版 <依赖关系> org.junit.jupiter junit-jupiter <范围>测试 <依赖关系> org.assertj assertj-core <范围>测试 ### 摇篮依赖项{ 实现（“org.mapstruct：mapstruct：1.5.5.Final”） testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.assertj:assertj-core") } ## 基本模式：测试 MapStruct 映射器 ### 简单实体到 DTO 映射 // 映射器接口 @Mapper(componentModel = "弹簧") 公共接口用户映射器{ UserDto toDto(用户用户); 用户 toEntity(UserDto dto); List toDtos(List users); } // 单元测试导入 org.junit.jupiter.api.Test; 导入静态 org.assertj.core.api.Assertions.*; 类 UserMapperTest { 私有最终 UserMapper userMapper = Mappers.getMapper(UserMapper.class); @测试无效shouldMapUserToDto（）{ 用户 user = new User(1L, "Alice", "alice@example.com", 25); UserDto dto = userMapper.toDto(用户); 断言(dto) .isNotNull() .extracting("id", "姓名", "电子邮件", "年龄") .containsExactly(1L, "Alice", "alice@example.com", 25); } @测试无效shouldMapDtoToEntity（）{ UserDto dto = new UserDto(1L, "Alice", "alice@example.com", 25); 用户 user = userMapper.toEntity(dto); 断言（用户） .isNotNull() .hasFieldOrPropertyWithValue("id", 1L) .hasFieldOrPropertyWithValue("姓名", "爱丽丝"); } @测试无效shouldMapListOfUsers（）{ 列表 <用户> 用户 = List.of( 新用户（1L，“Alice”，“alice@example.com”，25），新用户（2L，“鲍勃”，“bob@example.com”，30））； List dtos = userMapper.toDtos(users); 断言(dtos) .hasSize(2) .extracting(UserDto::getName) .containsExactly("爱丽丝", "鲍勃"); } @测试无效shouldHandleNullEntity（）{ UserDto dto = userMapper.toDto(null); assertThat(dto).isNull(); } } ## 测试嵌套对象映射 ### 映射复杂的层次结构 // 具有嵌套的实体类用户{ 私人长ID；私有字符串名称；私人地址地址；私人列表<电话>电话； } // 具有嵌套映射的映射器 @Mapper(componentModel = "弹簧") 公共接口用户映射器{ UserDto toDto(用户用户); 用户 toEntity(UserDto dto); } // 嵌套对象的单元测试类 NestedObjectMapperTest { 私有最终 UserMapper userMapper = Mappers.getMapper(UserMapper.class); @测试无效shouldMapNestedAddress（）{ 地址地址 = new 地址("123 Main St", "纽约", "NY", "10001"); 用户 user = new User(1L, "Alice", 地址); UserDto dto = userMapper.toDto(用户); 断言（dto.getAddress（）） .isNotNull() .hasFieldOrPropertyWithValue("街道", "主街 123 号") .hasFieldOrPropertyWithValue("城市", "纽约"); } @测试无效shouldMapListOfNestedPhones（）{ 列表<电话> 电话 = List.of( 新电话（“123-456-7890”，“手机”），新电话（“987-654-3210”，“家”））；用户 user = new User(1L, "Alice", null, 电话); UserDto dto = userMapper.toDto(用户); 断言（dto.getPhones（）） .hasSize(2) .extracting(PhoneDto::getNumber) .containsExactly("123-456-7890", "987-654-3210"); } @测试无效shouldHandleNullNestedObjects（）{ 用户 user = new User(1L, "Alice", null); UserDto dto = userMapper.toDto(用户); assertThat(dto.getAddress()).isNull(); } } ## 测试自定义映射方法 ### 带有 @Mapping 注解的映射器 @Mapper(componentModel = "弹簧") 公共接口ProductMapper { @Mapping(源=“名称”，目标=“产品名称”) @Mapping(源=“价格”，目标=“销售价格”) @Mapping(target = "折扣", expression = "java(product.getPrice() * 0.1)") 产品Dto toDto(产品产品); @Mapping(源 = "产品名称", 目标 = "名称") @Mapping(源=“销售价格”，目标=“价格”) 产品到Entity(ProductDto dto); } 类自定义映射测试{ 私有最终 ProductMapper 映射器 = Mappers.getMapper(ProductMapper.class); @测试无效shouldMapFieldsWithCustomNames（）{ 产品产品 = 新产品(1L, "笔记本电脑", 999.99); ProductDto dto = mapper.toDto(产品); 断言(dto) .hasFieldOrPropertyWithValue("产品名称", "笔记本电脑") .hasFieldOrPropertyWithValue("销售价格", 999.99); } @测试无效 shouldCalculateDiscountFromExpression() { 产品产品 = 新产品(1L, "笔记本电脑", 100.0); ProductDto dto = mapper.toDto(产品); assertThat(dto.getDiscount()).isEqualTo(10.0); } @测试无效shouldReverseMapCustomFields（）{ ProductDto dto = new ProductDto(1L, "笔记本电脑", 999.99); 产品产品 = mapper.toEntity(dto); 断言（产品） .hasFieldOrPropertyWithValue("名称", "笔记本电脑") .hasFieldOrPropertyWithValue("价格", 999.99); } } ## 测试枚举映射 ### 实体和 DTO 之间的映射枚举 // 具有不同表示形式的枚举枚举 UserStatus { 活动、非活动、暂停 } 枚举 UserStatusDto { 启用、禁用、锁定 } @Mapper(componentModel = "弹簧") 公共接口用户映射器{ @ValueMapping（源=“活动”，目标=“启用”） @ValueMapping（源=“不活动”，目标=“禁用”） @ValueMapping（源=“暂停”，目标=“锁定”） UserStatusDto toStatusDto(UserStatus status); } 类 EnumMapperTest { 私有最终 UserMapper 映射器 = Mappers.getMapper(UserMapper.class); @测试无效shouldMapActiveToEnabled（）{ UserStatusDto dto = mapper.toStatusDto(UserStatus.ACTIVE); assertThat(dto).isEqualTo(UserStatusDto.ENABLED); } @测试无效shouldMapSuspendedToLocked（）{ UserStatusDto dto = mapper.toStatusDto(UserStatus.SUSPENDED); assertThat(dto).isEqualTo(UserStatusDto.LOCKED); } } ## 测试自定义类型转换 ### 非 MapStruct 自定义转换器 // 自定义转换器类公共类日期格式器{ 私有静态最终 DateTimeFormatter 格式化程序 = DateTimeFormatter.ofPattern("yyyy-MM-dd"); 公共静态字符串格式（LocalDate 日期）{ 返回日期！= null ？ date.format(格式化程序) : null; } 公共静态 LocalDate parse(String dateString) { 返回日期字符串！= null ？ LocalDate.parse(dateString, formatter) : null; } } // 单元测试类 DateFormatterTest { @测试无效shouldFormatLocalDateToString（）{ LocalDate 日期 = LocalDate.of(2024, 1, 15); 字符串结果 = DateFormatter.format(date); assertThat(结果).isEqualTo("2024-01-15"); } @测试无效shouldParseStringToLocalDate() { 字符串日期字符串 = "2024-01-15"; LocalDate 结果 = DateFormatter.parse(dateString); assertThat(结果).isEqualTo(LocalDate.of(2024, 1, 15)); } @测试无效shouldHandleNullInFormat（）{ 字符串结果 = DateFormatter.format(null); 断言（结果）.isNull（）; } @测试无效shouldHandleInvalidDateFormat（）{ assertThatThrownBy(() -> DateFormatter.parse("无效日期")) .isInstanceOf(DateTimeParseException.class); } } ## 测试双向映射 ### 实体 ↔ DTO 往返双向映射器测试类 { 私有最终 UserMapper 映射器 = Mappers.getMapper(UserMapper.class); @测试无效shouldMaintainDataInRoundTrip（）{ 原始用户 = 新用户(1L, "Alice", "alice@example.com", 25); UserDto dto = mapper.toDto(original); 用户恢复 = mapper.toEntity(dto); 断言（恢复） .hasFieldOrPropertyWithValue("id",original.getId()) .hasFieldOrPropertyWithValue("名称",original.getName()) .hasFieldOrPropertyWithValue("电子邮件",original.getEmail()) .hasFieldOrPropertyWithValue("年龄",original.getAge()); } @测试无效shouldPreserveAllFieldsInBothDirections（）{ 地址地址 = 新地址("123 Main", "NYC", "NY", "10001"); 用户 user = new User(1L, "Alice", "alice@example.com", 25, 地址); UserDto dto = mapper.toDto(用户); 用户恢复 = mapper.toEntity(dto); assertThat(恢复).usingRecursiveComparison().isEqualTo(用户); } } ## 测试部分映射 ### 从 DTO 更新现有实体 @Mapper(componentModel = "弹簧") 公共接口用户映射器{ void updateEntity(@MappingTarget 用户实体, UserDto dto); } 类 PartialMapperTest { 私有最终 UserMapper 映射器 = Mappers.getMapper(UserMapper.class); @测试无效shouldUpdateExistingEntity() { 现有用户 = 新用户(1L, "Alice", "alice@old.com", 25); UserDto dto = new UserDto(1L, "Alice", "alice@new.com", 26); mapper.updateEntity（现有，dto）；断言（现有） .hasFieldOrPropertyWithValue("电子邮件", "alice@new.com") .hasFieldOrPropertyWithValue("年龄", 26); } @测试无效shouldNotUpdateFieldsNotInDto（）{ 现有用户 = 新用户(1L, "Alice", "alice@example.com", 25); UserDto dto = new UserDto(1L, "鲍勃", null, 0); mapper.updateEntity（现有，dto）； // 假设配置了空感知映射 assertThat(existing.getEmail()).isEqualTo("alice@example.com"); } } ## 最佳实践 * **全面测试所有映射器方法** * **验证每个可为空字段的空处理** * **独立和一起测试嵌套对象** * **对复杂的嵌套结构使用递归比较** * **测试双向映射**以捕获不对称性 * **保持映射器测试简单并专注于转换的正确性** * **使用Mappers.getMapper()**进行非Spring独立测试 ## 常见陷阱 * 不测试空输入情况 * 不验证嵌套对象映射 * 假设双向映射是对称的 * 不测试边缘情况（空集合等） * 映射器测试与 MapStruct 内部结构紧密耦合 ## 限制和警告 * **MapStruct 在编译时生成代码** ：如果映射器未正确生成，测试将失败 * **Mapper componentModel** ：Spring组件模型需要@Component进行依赖注入 * **空值策略** ：适当配置 nullValueMappingStrategy 和 nullValuePropertyMappingStrategy * **集合不可变性** ：请注意，映射不可变集合可能需要特殊处理 * **循环依赖** : MapStruct 无法处理映射器之间的循环依赖 * **日期/时间映射** ：验证日期/时间对象跨时区正确映射 * **基于表达式的映射** ：@Mapping 中的表达式在编译时不会验证 ## 故障排除 **映射期间空指针异常**：检查`@Mapper`中的`nullValuePropertyMappingStrategy`和`nullValueCheckStrategy`。 **枚举映射不起作用**：验证“@ValueMapping”注释是否正确将源值映射到目标值。 **嵌套映射产生 null** ：确保嵌套映射器接口也映射到父映射器中。 ## 参考文献 * [MapStruct 官方文档]() * [MapStruct 映射策略]() * [JUnit 5 最佳实践]()

单元测试映射器转换器

包含技能