MapStruct的自定义映射器

布满荆棘的人生 2023-01-15 02:11 164阅读 0赞

# 1.概述 #

如何在MapStruct库中使用自定义映射器。

MapStruct库用于在Java bean类型之间进行映射。 通过将自定义映射器与MapStruct一起使用，可以自定义默认的映射方法。

# 2.自定义映射 #

自定义映射器用于解决特定的转换要求。 为此，必须定义一种进行转换的方法。 然后，必须将该方法通知给MapStruct。 最后，MapStruct将调用该方法进行从源到目标的转换。

例如，假设有一个应用程序可以计算用户的体重指数（BMI）报告。 要计算BMI，必须收集用户的身体值。 要将英制单位转换为公制单位，可以使用自定义映射器方法。

通过MapStruct使用自定义映射器有两种方法。 可以通过在@Mapping注解的qualifiedByName属性中键入自定义方法来调用自定义方法，也可以为其创建注解。

定义一个DTO类来保存英制值：

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class UserBodyImperialValuesDTO { 
        private int inch;
        private int pound;
    }

定义一个DTO类来保存指标值：

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class UserBodyValues { 
        private double kilogram;
        private double centimeter;
    }

## 3.1定义带方法转化的映射器 ##

@Mapper(componentModel = "spring")
    public interface UserBodyValuesMapper { 
    
    
        @Mapping(source = "inch", target = "centimeter", qualifiedByName = "inchToCentimeter")
        UserBodyValues userBodyValuesMapper(UserBodyImperialValuesDTO dto);
    
        @Named("inchToCentimeter")
        static double inchToCentimeter(int inch) { 
            return inch * 2.54;
        }
    }

@Named注解与value参数一起使用，将自定义映射器方法告知MapStruct

单元测试

@Autowired
        private UserBodyValuesMapper userBodyValuesMapper;
    
        @Test
        public void test10() { 
            UserBodyImperialValuesDTO dto = new UserBodyImperialValuesDTO();
            dto.setInch(10);
    
            UserBodyValues obj = userBodyValuesMapper.userBodyValuesMapper(dto);
    
            assertNotNull(obj);
            assertEquals(25.4, obj.getCentimeter(), 0);
        }

## 3.2带注解的自定义映射器 ##

要将自定义映射器与注释一起使用，必须定义一个注解，而不是@Named注解。 然后，必须通过指定@Mapping注解的qualifiedByName参数来通知MapStruct有关新创建的注解。

定义一个注解

@Qualifier
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.CLASS)
    public @interface PoundToKilogramMapper { 
    }

@PoundToKilogramMapper注解添加到poundToKilogram方法中：

@PoundToKilogramMapper
    static double poundToKilogram(int pound) { 
        return pound * 0.4535;
    }

修改后的映射类

@Mapper(componentModel = "spring")
    public interface UserBodyValuesMapper { 
    
    
        @Mapping(source = "inch", target = "centimeter", qualifiedByName = "inchToCentimeter")
        @Mapping(source = "pound", target = "kilogram", qualifiedBy = PoundToKilogramMapper.class)
        UserBodyValues userBodyValuesMapper(UserBodyImperialValuesDTO dto);
    
        @Named("inchToCentimeter")
        static double inchToCentimeter(int inch) { 
            return inch * 2.54;
        }
        @PoundToKilogramMapper
        static double poundToKilogram(int pound) { 
            return pound * 0.4535;
        }
    }

单元测试

@Test
        public void test11(){ 
            UserBodyImperialValuesDTO dto = new UserBodyImperialValuesDTO();
            dto.setPound(100);
    
            UserBodyValues obj = userBodyValuesMapper.userBodyValuesMapper(dto);
    
            assertNotNull(obj);
            assertEquals(45.35, obj.getKilogram(), 0);
        }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20221022/2966ab578ab04b1591c5caf353033d0e.png