【转】MapStruct 用法

已于 2022-09-26 16:12:27 修改
阅读量2.1k 收藏 6
点赞数 1
分类专栏： Apache等开源 相关组件 文章标签： java
于 2022-08-30 11:42:36 首次发布
原文链接：https://www.cnblogs.com/gotten/p/13052911.html
版权

1.MapStruct 配置

MapStuct的使用非常简单，把对应的jar包引入即可。

<properties>
    <mapstruct.version>1.3.1.Final</mapstruct.version>
</properties>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>${mapstruct.version}</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>${mapstruct.version}</version>
</dependency>

2.原理&性能

2.1 实现原理

对象拷贝工具实现上一般分为2种：

  1. 在运行时，通过反射调用set/get方法或者直接对成员变量进行赋值。
  2. 在编译期，生成调用get/set方法进行赋值的代码，生成对应的class文件。

MapStrut属于第二种，在编译期间消耗少许的时间，换取运行时的高性能。

接口声明：

import org.mapstruct.Mapper;

@Mapper
public interface ProductAssembler {
    SkuDTO toDTO(Sku sku);
}

编辑生成的class反编译

public class ProductAssemblerImpl implements ProductAssembler {
    @Override
    public SkuDTO toDTO(Sku sku) {
        if ( sku == null ) {
            return null;
        }
        SkuDTO skuDTO = new SkuDTO();
        skuDTO.setSkuId( sku.getSkuId() );
        return skuDTO;
    }
}

2.2 性能对比

在这里插入图片描述

2.3@Mapping

@Mapping 用在方法上，一般用于 方法传参pojo与返回pojo 的类型转换

对应的源码与解释如下：

// 可重复使用
@Repeatable(Mappings.class)
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.METHOD})
public @interface Mapping {
    // 设置的目标类的属性名称，必须传入
    String target();
	// 源类的属性名称
    String source() default "";
   
	// 设置指定目标属性的常量字符串（如果没有源目标的话，可以用这个指定）
    String constant() default "";
    
    //当源属性为null，则设置提供的默认值(字符串类型)
    String defaultValue() default "";
    
     // 生成的映射方法是否应忽略通过target指定的属性。
    boolean ignore() default false;
    
    // 属性从字符串映射到日期，则SimpleDataFormat可处理的格式字符串，反之亦然。
    String dateFormat() default "";

    // 属性从数字映射到字符串，或者从数字映射到字符串，则可由DecimalFormat处理的格式字符串
    String numberFormat() default "";
    
    // 要根据其设置指定目标属性的表达式字符串，可以是表达式
    String expression() default "";
    
	// 当指定的源属性为null时，将根据该表达式设置指定的目标属性
    String defaultExpression() default "";
  
    // 可以指定注解来帮助选择合适的映射规则
    Class<? extends Annotation>[] qualifiedBy() default {};
	
    // 基于字符串的限定符形式；当为给定属性寻找合适的映射方法时，只考虑那些直接或间接地（即在类级别上）为每个指定的限定符名称命名的注释的方法
    String[] qualifiedByName() default {};
    
	// 指定在多个映射方法符合条件时要使用的映射方法的结果类型
    Class<?> resultType() default void.class;
	
    // 映射属性所依赖的结果类型的一个或多个属性
    String[] dependsOn() default {};
	
    // 确定何时对bean映射的源属性值进行null检查，可被MapperConfig、BeanMapping或Mapping上的覆盖
    // ALWAYS：始终
    // ON_IMPLICIT_CONVERSION：在涉及隐式类型转换得时候进行检查
    NullValueCheckStrategy nullValueCheckStrategy() default NullValueCheckStrategy.ON_IMPLICIT_CONVERSION;

    // 当源bean属性为null或不存在时应用的策略
    // IGNORE：忽略，源bean属性等于null，那么将忽略目标bean属性并保留其现有值
    // SET_TO_DEFAULT：源bean属性等于null，则目标bean属性将设置为其默认值
    // SET_TO_NULL：源bean属性等于null，则目标bean属性将设置为null，默认为SET_TO_NULL
    NullValuePropertyMappingStrategy nullValuePropertyMappingStrategy() default NullValuePropertyMappingStrategy.SET_TO_NULL;
}

示例

@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface LogMapper {
   @Mappings({
            @Mapping(source = "id", target = "idDTO"),
            @Mapping(source = "realName", target = "realNameDTO"),
            @Mapping(source = "name", target = "nameDTO"),
       		// 使用defaultValue
            @Mapping(target = "defaultValue", defaultValue = "morenzhi"),
       		// 使用ignore
            @Mapping(target = "ignoreValue", ignore = true)

    })
    LogDTO convertToDTO(Log log);

    @Mappings({
            @Mapping(source = "idDTO", target = "id"),
            @Mapping(source = "realNameDTO", target = "realName"),
            @Mapping(source = "nameDTO", target = "name"),
        	// 使用constant
            @Mapping(target = "address", constant = "1111"),
        	// 使用ignore
            @Mapping(target = "ignoreValue", ignore = true)
    })
    Log covertToDO(LogDTO logDTO);
    
	// 有多个参数的时候，我们可以通过  参数.属性 的方式进行转换
    @Mappings({
            @Mapping(source = "log.id", target = "idDTO"),
            @Mapping(source = "log2.realName", target = "realNameDTO"),
            @Mapping(source = "log.name", target = "nameDTO"),
    })
    LogDTO convertToDTO2(Log log , Log2 log2);
}

3. 使用方法

  • 使用@Mapper注解，声明映射器，可以是接口，或者抽象类。
  • 使用@Mapping注解，实现灵活的字段映射，定制映射的规则。

3.1 转换器的检索

在声明好转换接口之后，MapStruct提供几种方式获取生成的Mapper映射器。

3.1.1 使用Mappers工厂获取

可以通过提供的Mappers工厂类，获取指定的类型。

@Mapper
public interface Assembler {
    //使用工厂方法获取Mapper实例
    Assembler INSTANCE = Mappers.getMapper(Assembler.class);
    ProductDTO toDTO(Product product);
}
3.1.2 通过依赖注入的方式获取

MapStuct同时支持和其他框架结合，通过依赖注入的方式获取Mapper实例。目前支持spring和cdi。

@Mapper(componentModel = "spring")
public interface Assembler {
    ProductDTO toDTO(Product product);
}

@Component public class AssemblerImpl implements Assembler {
    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        return productDTO;
    }
}

3.2 简单映射

3.2.1 基本映射
  • 对于同名同属性的字段，无需特别声明指定，自动转换。
  • 对于不同名相同属性的字段，可以使用Mapping注解指定。
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Product {
    private String productId;
    private String name;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = -6780322740093464581L;
    private String productId;
    private String productName;
}

定义映射器：

@Mapper(componentModel = "spring")
public interface Assembler {
    @Mapping(source = "name", target = "productName")
    ProductDTO toDTO(Product product);
}

生成的映射器实现：

@Component
public class AssemblerImpl implements Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductName( product.getName() );  //不同字段名映射
        productDTO.setProductId( product.getProductId() ); //相同映射名自动转换
        return productDTO;
    }
}
3.2.2 多源参数映射

支持把多个参数映射成一个类型，使用@Mapping指定即可。

@Mapper(componentModel = "spring")
public interface Demo6Assembler {
    @Mapping(target = "productId", source = "product.productId")
    @Mapping(target = "desc", source = "detail.desc")
    ProductDTO toDetailDTO(Product product, ProductDetail detail);
}
3.2.3 更新对象

映射时除了生成新的新对象外，还支持现存对象的更新

@Mapper(componentModel = "spring")
public interface Demo6Assembler {
    @Mapping(target = "desc", source = "desc")
    void updateDTO(@MappingTarget ProductDTO productDTO, ProductDetail detail);
}

3.3 数据类型转换

3.3.1 对于基础数据类型会进行自动隐式的转换

如int、long、String，Integer、Long等。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Product {
    private String productId;
    private Long price;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = -6780322740093464581L;
    private int productId;
    private String price;
}

定义映射器：

@Mapper(componentModel = "spring")
public interface Assembler {
    ProductDTO toDTO(Product product);
}

生成的映射代码：

@Component
public class AssemblerImpl implements Assembler {
    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        if ( product.getProductId() != null ) {
            //String自动转int
            productDTO.setProductId( Integer.parseInt( product.getProductId() ) );
        }
        if ( product.getPrice() != null ) {
            //Long转String
            productDTO.setPrice( String.valueOf( product.getPrice() ) );
        }
        return productDTO;
    }
}
3.3.2 指定转换格式

某些类型的转换，我们可以指定具体转换的格式。

（1）对于基本数据类型与String之间的转换，可以使用 numberFormat 指定转换格式，使用的是java.text.DecimalFormat 实现。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Product {
    private String productId;
    private BigDecimal price;
    private String stock;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = -6780322740093464581L;
    private String productId;
    private String price;
    private Integer stock;
}

映射器定义：

@Mapper(componentModel = "spring")
public interface Demo3Assembler {
    @Mapping(target = "price", numberFormat = "#.00元")   //BigDecimal转换成字符串
    @Mapping(target = "stock", numberFormat = "#个")      //字符串转换成int
    ProductDTO toDTO(Product product);
}

实现代码：

@Component
public class Demo3AssemblerImpl implements Demo3Assembler {
    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        if ( product.getPrice() != null ) {
            //BigDecimal格式化成字符串
            productDTO.setPrice( createDecimalFormat( "#.00元" ).format( product.getPrice() ) );
        }
        try {
            if ( product.getStock() != null ) {
                 //字符串格式化为int
                productDTO.setStock( new DecimalFormat( "#个" ).parse( product.getStock() ).intValue() );
            }
        }
        catch ( ParseException e ) {
            throw new RuntimeException( e );
        }
        return productDTO;
    }
    private DecimalFormat createDecimalFormat( String numberFormat ) {
        DecimalFormat df = new DecimalFormat( numberFormat );
        df.setParseBigDecimal( true );
        return df;
    }
}

测试代码：

@Test
public void test2() {
    Product  product = new Product ();
    product.setProductId("P001");
    product.setPrice(new BigDecimal("100"));
    product.setStock("1个");
    ProductDTO productDTO = demo3Assembler.toDTO(product);
    System.out.println("productDTO:" + JSON.toJSONString(productDTO));
}

输出：
productDTO:{"price":"100.00元","productId":"P001","stock":1}

（2）Date和String之间的转换，可以通过dateFormat指定转换格式，使用的是SimpleDateFormat的实现。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Product {
    private String productId;
    private Date saleTime;
    private String validTime;
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = -6780322740093464581L;
    private String productId;
    private String saleTime;
    private Date validTime;
}

定义映射器：

@Mapper(componentModel = "spring")
public interface Demo4Assembler {
    @Mapping(target = "saleTime", dateFormat = "yyyy-MM-dd HH:mm:ss")  //Date转换成String
    @Mapping(target = "validTime", dateFormat = "yyyy-MM-dd HH:mm")    //String转换成Date
    ProductDTO toDTO(Product product);
}

实现代码：

@Component
public class Demo4AssemblerImpl implements Demo4Assembler {
    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        if ( product.getSaleTime() != null ) {
            productDTO.setSaleTime( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" ).format( product.getSaleTime() ) ); //转换成String
        }
        try {
            if ( product.getValidTime() != null ) {
                productDTO.setValidTime( new SimpleDateFormat( "yyyy-MM-dd HH:mm" ).parse( product.getValidTime() ) ); //转换成Date
            }
        }
        catch ( ParseException e ) {
            throw new RuntimeException( e );
        }
        return productDTO;
    }
}
3.3.3 属性为复杂对象的映射
  • （1）如果是相同类型的对象引用，不会创建新的对象，直接把对象的引用从源对象赋值给目标对象。
  • （2）如果类型相同，但是是集合类的引用，会创建一个新的集合，集合里面的所有引用进行拷贝。
@Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        List<Sku> list = product.getSkuList();
        if ( list != null ) {
            productDTO.setSkuList( new ArrayList<Sku>( list ) ); //创建新的集合，并对所有元素进行拷贝
        }

        return productDTO;
    }
  • （3）对象的类型不同，会检查映射器中是否存在对应的映射方法，如果存在，直接使用，否则会尝试自动创建子映射方法。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
    private String productId;
    private ProductDetail productDetail;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDetail {
    private String id;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = 2184784038009791692L;
    private String productId;
    private ProductDetailDTO productDetail;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDetailDTO {
    private String detailId;
}

定义映射器：

@Mapper(componentModel = "spring")
public interface Demo6Assembler {
    ProductDTO toDTO(Product product);

    @Mapping(target = "detailId", source = "id")
    ProductDetailDTO toDetailDTO(ProductDetail detail);
}

生成代码：

@Component
public class Demo6AssemblerImpl implements Demo6Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        productDTO.setProductDetail( toDetailDTO( product.getProductDetail() ) ); //查找使用存在的转换方法
        return productDTO;
    }
    @Override
    public ProductDetailDTO toDetailDTO(ProductDetail detail) {
        if ( detail == null ) {
            return null;
        }
        ProductDetailDTO productDetailDTO = new ProductDetailDTO();
        productDetailDTO.setDetailId( detail.getId() );
        return productDetailDTO;
    }
}
  • （4）多层bean之间的转换

@Mapping注解支持跨层级的属性转换，属性可以在不同层级之间切换。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
    private String productId;
    private ProductDetail productDetail;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDetail {
    private String id;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = 2184784038009791692L;
    private String productId;
    private ProductDetailDTO productDetail;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDetailDTO {
    private String productId;
    private String detailId;
}

定义映射器：

@Mapper(componentModel = "spring")
public interface Demo7Assembler {
    @Mapping(target = "productDetail.detailId", source = "productDetail.id") //声明productDetail下的属性转换规则
    @Mapping(target = "productDetail.productId", source = "productId") //跨层级的属性转换,把product层级的productId放到productDetail层级
    ProductDTO toDTO(Product product);
}

生成代码：

@Component
public class Demo7AssemblerImpl implements Demo7Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        if ( product.getProductDetail() != null ) {
            if ( productDTO.getProductDetail() == null ) {
                productDTO.setProductDetail( new ProductDetailDTO() );
            }
            productDetailToProductDetailDTO( product.getProductDetail(), productDTO.getProductDetail() );
        }
        if ( productDTO.getProductDetail() == null ) {
            productDTO.setProductDetail( new ProductDetailDTO() );
        }
        productToProductDetailDTO( product, productDTO.getProductDetail() );
        productDTO.setProductId( product.getProductId() );
        return productDTO;
    }

　　//detail的转换方法
    protected void productDetailToProductDetailDTO(ProductDetail productDetail, ProductDetailDTO mappingTarget) {
        if ( productDetail == null ) {
            return;
        }
        mappingTarget.setDetailId( productDetail.getId() );
    }

　　//product转成detail（更新处理）
    protected void productToProductDetailDTO(Product product, ProductDetailDTO mappingTarget) {
        if ( product == null ) {
            return;
        }
        mappingTarget.setProductId( product.getProductId() );
    }
}
3.3.4 自定义转换器

MapStruct支持自定义转换器，实现类型之间的转换自定义的规则。

一个自定义映射器可以定义多个映射方法，匹配时，是以方法的入参和出参进行匹配的。如果绑定的映射中，存在多个相同的入参和出参方法，将会报错。

如果多个入参或者出参方法存在继承关系，将会匹配最具体的那一个方法。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
    private String productId;
    private List<String> images;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ProductDTO implements Serializable {
    private static final long serialVersionUID = 2184784038009791692L;
    private String productId;
    private String images;
}

定义转换器

@Component
public class ImageFormater {
    public String format(List<String> images) {
        return String.join(",", images);
    }
}

绑定转换器：

@Mapper(componentModel = "spring", uses = ImageFormater.class)
public interface Demo8Assembler {
    ProductDTO toDTO(Product product);
}

映射器实现：

@Component
public class Demo8AssemblerImpl implements Demo8Assembler {

    @Autowired
    private ImageFormater imageFormater;

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }

        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
　　　　 //调用自定义的映射器进行映射，把list转成string
        productDTO.setImages( imageFormater.format( product.getImages() ) );
        return productDTO;
    }
}
3.3.5 使用限定符限定使用转换方法

自定义转换器时，存在多个相同入参和出参的方法，MapStruct无法匹配使用哪个映射方法。这时可以使用限定符绑定每个属性转换时使用的转换方法。

  • （1）限定符使用自定义注解实现。

声明限定符：

import org.mapstruct.Qualifier;
//映射器上的限定符
@Qualifier //标记为限定符
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Formators {
}

//映射方法上的限定符
@Qualifier //标记为限定符
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface FormatImages {
}

//映射方法上的限定符
@Qualifier //标记为限定符
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface FormatDetails {
}

绑定限定符到映射器的方法上面：

@Component
@Formators //绑定限定符
public class CusFormater {

    @FormatImages //绑定限定符
    public String formatImages(List<String> images) {
        return String.join(",", images);
    }
    @FormatDetails //绑定限定符
    public String formatDetails(List<String> images) {
        return String.join(",", images);
    }
}

映射时，绑定限定符，定位映射方法：

@Mapper(componentModel = "spring", uses = CusFormater.class)
public interface Demo9Assembler {
    @Mapping(target = "images", qualifiedBy = FormatImages.class) //转换指定限定符，定位具体的映射方法
    @Mapping(target = "details", qualifiedBy = FormatDetails.class)//转换指定限定符，定位具体的映射方法
    ProductDTO toDTO(Product product);
}

生成代码：

@Component
public class Demo9AssemblerImpl implements Demo9Assembler {
    @Autowired
    private CusFormater cusFormater;

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        productDTO.setImages( cusFormater.formatImages( product.getImages() ) ); //定位方法
        productDTO.setDetails( cusFormater.formatDetails( product.getDetails() ) );
        return productDTO;
    }
}
  • （2）基于named注解实现（推荐）

除了使用自定义注解的方法，还可以使用@Named注解实现限定符的绑定。

@Component // 可以不在sprig的扫描中
@Named("CusFormater")
public class CusFormater {
    //绑定限定符
    @Named("formatImages")
    public String formatImages(List<String> images) {
        return String.join(",", images);
    }
    //绑定限定符
    @Named("formatDetails")
    public String formatDetails(List<String> images) {
        return String.join(",", images);
    }
}

使用时绑定：

使用@Mapper注解uses引入转换规则，eg:uses = CusFormater.class

//@Mapper(componentModel = "spring", uses = CusFormater.class) 
@Mapper(uses = CusFormater.class) // 不在spring 扫描中方式
public interface Demo10Assembler {
     // @Mapping使用qualifiedByName标识转换规则，eg:qualifiedByName = "formatImages"。
    @Mapping(target = "images", qualifiedByName = "formatImages") //转换指定限定符，定位具体的映射方法
    @Mapping(target = "details", qualifiedByName = "formatDetails")//转换指定限定符，定位具体的映射方法
    ProductDTO toDTO(Product product);
}

3.4 Map的映射

可以使用@MapMapping实现对key和value的分别映射：

@Mapper(componentModel = "spring")
public interface Demo11Assembler {
    @MapMapping(valueDateFormat = "yyyy-MM-dd HH:mm:ss")
    Map<String, String> toDTO(Map<Long, Date> map);
}

3.5 枚举值之间的转换

MapStruct可以在多个枚举值之间转换，使用@ValueMapping注解。

public enum E1 {
    E1_1,
    E1_2,
    E1_3,
    ;
}

public enum E2 {
    E2_1,
    E2_2,
    E2_3,
    ;
}

@Mapper(componentModel = "spring")
public interface Demo11Assembler {
    @ValueMapping(target = "E1_1", source = "E2_1")
    @ValueMapping(target = "E1_2", source = "E2_2")
    @ValueMapping(target = MappingConstants.NULL, source = "E2_3") //转换成null
    E1 toDTO(E2 e2);
}

生成代码：

@Component
public class Demo11AssemblerImpl implements Demo11Assembler {

    @Override
    public E1 toDTO(E2 e2) {
        if ( e2 == null ) {
            return null;
        }
        E1 e1;
        switch ( e2 ) {
            case E2_1: e1 = E1.E1_1;
            break;
            case E2_2: e1 = E1.E1_2;
            break;
            case E2_3: e1 = null;
            break;
            default: throw new IllegalArgumentException( "Unexpected enum constant: " + e2 );
        }
        return e1;
    }
}

3.6 定制Bean生成

使用MapStruct可以使用对象工厂来创建bean，同时也可以更新bean。

定义对象工厂：

public class DTOFactory {
    public ProductDTO createDTO() {
        ProductDTO productDTO = new ProductDTO();
        productDTO.setStock(0);
        return productDTO;
    }
}

使用对象工厂：

@Mapper(componentModel = "spring", uses = DTOFactory.class) //指定使用的对象工厂
public interface Demo13Assembler {
    ProductDTO toDTO(Product product);
}

生成代码：

@Component
public class Demo13AssemblerImpl implements Demo13Assembler {

    @Autowired
    private DTOFactory dTOFactory;
    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = dTOFactory.createDTO(); //使用对象工厂创建对象
        productDTO.setProductId( product.getProductId() );
        return productDTO;
    }
}

3.7 缺省值和常量

MapStruct允许设置缺省值和常量，同时缺省值允许使用表达式。

注意：使用缺省值，源字段必须存在，否则缺省值不生效，否则应该使用常量。

@Mapper(componentModel = "spring", imports = UUID.class)
public interface Demo15Assembler {
    @Mapping(target = "productId", source = "productId", defaultValue = "0") //当product的productId为null，设置为0
    @Mapping(target = "random", source = "random", defaultExpression = "java(UUID.randomUUID().toString())") //缺省设置随机数
    @Mapping(target = "stock", constant = "0") //固定设置为0
    @Mapping(target = "createTime", dateFormat = "yyyy-MM-dd", constant = "2020-05-30") //固定格式化设置为2020-05-30，
    ProductDTO toDTO(Product product);
}

生成代码

@Component
public class Demo15AssemblerImpl implements Demo15Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();

        if ( product.getProductId() != null ) {
            productDTO.setRandom( product.getProductId() );
        }
        else {
            productDTO.setRandom( UUID.randomUUID().toString() );
        }
        if ( product.getProductId() != null ) {
            productDTO.setProductId( product.getProductId() );
        }
        else {
            productDTO.setProductId( "0" );
        }

        productDTO.setStock( 0 );
        try {
            productDTO.setCreateTime( new SimpleDateFormat( "yyyy-MM-dd" ).parse( "2020-05-30" ) );
        }
        catch ( ParseException e ) {
            throw new RuntimeException( e );
        }

        return productDTO;
    }
}

3.8 存在继承关系的结果处理

当返回的结果类型存在继承关系时，可以使用 @BeanMapping注解指定真实返回的结果类型。

@Mapper(componentModel = "spring")
public interface Demo17Assembler {
    @BeanMapping(resultType = DogDTO.class) //指定返回的结果类型
    Animal toDTO(Dog dog);
}

生成代码

@Component
public class Demo17AssemblerImpl implements Demo17Assembler {
    @Override
    public Animal toDTO(Dog dog) {
        if ( dog == null ) {
            return null;
        }
        DogDTO animal = new DogDTO();
        animal.setId( dog.getId() );
        return animal;
    }
}

3.9 映射关系继承

MapStruct允许对映射关系进行继承，使用@InheritConfiguration标记当前方法继承其他映射方法的映射关系。会自动查找相同类型映射源、映射目标的方法进行继承，如果存在多个相同类型的方法，则需要手工指定。

@Mapper(componentModel = "spring")
public interface Demo18Assembler {
    @Mapping(target = "productId", source = "id")
    @Mapping(target = "detail", source = "detail1")
    ProductDTO toDTO(Product product);

    @Mapping(target = "productId", source = "id2")
    @Mapping(target = "detail", source = "detail2")
    ProductDTO toDTO2(Product product);

    @InheritConfiguration(name = "toDTO") //对toDTO的映射关系进行继承
    @Mapping(target = "detail", source = "detail2") //对继承的关系进行重写
    void update(@MappingTarget ProductDTO productDTO, Product product);

}

除了正向继承规则外，还可以进行规则逆向继承，从被继承方法的目标对象映射到源对象。

@Mapper(componentModel = "spring")
public interface Demo18Assembler {
    @Mapping(target = "productId", source = "id")
    @Mapping(target = "detail", source = "detail1")
    ProductDTO toDTO(Product product);

    @Mapping(target = "productId", source = "id2")
    @Mapping(target = "detail", source = "detail2")
    ProductDTO toDTO2(Product product);

    @InheritInverseConfiguration(name = "toDTO") //对toDTO的映射关系进行逆继承
    @Mapping(target = "detail2", source = "detail") //对逆向继承的关系进行重写
    Product toEntity(ProductDTO dto);
}

3.10 复杂映射的实现

有时候我们除了普通映射外，还需要进行一些复杂的映射，如把多个字段计算映射成一个字段，或者借用一些工具进行映射的计算等。MapStruct提供了集中方式实现。

3.10.1 使用java表达式进行映射

对于复杂的映射，允许使用java表达式实现字段的映射。

注意要导入使用到的类。

@Mapper(componentModel = "spring", imports = DecimalUtils.class) //导入java表达式使用的类
public interface Demo16Assembler {
    @Mapping(target = "price", expression = "java(product.getPrice1() + product.getPrice2())") //直接相加
    @Mapping(target = "price2", expression = "java(DecimalUtils.add(product.getPrice1(), product.getPrice2()))") //使用工具类处理
    ProductDTO toDTO(Product product);
}

生成的映射代码：

@Component
public class Demo16AssemblerImpl implements Demo16Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        if ( product == null ) {
            return null;
        }
        ProductDTO productDTO = new ProductDTO();
        productDTO.setProductId( product.getProductId() );
        productDTO.setPrice( product.getPrice1() + product.getPrice2() );
        productDTO.setPrice2( DecimalUtils.add(product.getPrice1(), product.getPrice2()) );
        return productDTO;
    }
}
3.10.2 使用装饰器进行映射

MapStruct允许使用装饰器进行一些复杂映射，同时可以支持和Spring结合。

定义一个映射器，同时声明绑定装饰器：

@Mapper(componentModel = "spring")
@DecoratedWith(Demo18AssemblerDecorator.class) //声明绑定装饰器
public interface Demo18Assembler {
    ProductDTO toDTO(Product product);
}

定义装饰器：

public abstract class Demo18AssemblerDecorator implements Demo18Assembler {
    @Autowired
    @Qualifier("delegate") //注入mapStruct生成的转换器，原始的转换器注入spring时，会使用delegate装饰符
    private Demo18Assembler assembler;

    //可以获取spring的bean进行操作
    @Autowired
    private StringUtils stringUtils;

    @Override
    public ProductDTO toDTO(Product product) {
        //调用MapStruct进行转换
        ProductDTO productDTO = assembler.toDTO(product);
        //自定义操作
        stringUtils.join(product.getName(), "-", product.getTitle());
        return productDTO;
    }
}

生成装饰器代码：

@Component
@Primary //Primary修饰，方便使用时直接使用autowired注入
public class Demo18AssemblerImpl extends Demo18AssemblerDecorator implements Demo18Assembler {
}
3.10.3 使用前后置处理实现复杂映射

使用@BeforeMapping和@AfterMapping注解可以指定映射过程的的回调方法，进行一些前置或者后置的操作。

前置回调方法的执行时机是在映射方法开始时，后置方法是在映射完成return之前。

回调方法可以直接定义在映射器内：

@Mapper(componentModel = "spring")
public interface Demo19Assembler {

    ProductDTO toDTO(Product product);

    @BeforeMapping //前置执行
    default ProductDTO toDTOBefore(Product product) {
        ProductDTO productDTO = new ProductDTO();
        productDTO.setSales(9999);
        return productDTO;
    }

    @AfterMapping //后置执行
    default void toDTOAfter(Product product, @MappingTarget ProductDTO productDTO) {
        productDTO.setViewName(product.getName() + "-" + product.getTitle());
    }
}

生成的实现代码如下：

@Component
public class Demo19AssemblerImpl implements Demo19Assembler {

    @Override
    public ProductDTO toDTO(Product product) {
        ProductDTO target = toDTOBefore( product ); //前置
        if ( target != null ) {
            return target;
        }

        if ( product == null ) {
            return null;
        }

        ProductDTO productDTO = new ProductDTO();

        productDTO.setProductId( product.getProductId() );

        toDTOAfter( product, productDTO ); //后置

        return productDTO;
    }
}

回调方法与映射的方法的匹配规则：

  1. 映射方法和回调方法没有强绑定的关系，是依靠参数类型来匹配映射方法与回调方法的。映射方法的所有入参和出参类型，能覆盖回调方法的入参，就会调用对应的回调方法，当要注意，如果回调方法的入参是映射方法的出参类型，回调方法中需要用@MappingTarget 指定，否则不会调用。
  2. 回调方法是void或者返回映射方法的出参类型才能匹配，但要注意，如果返回的是映射方法的出参类型，如果执行时返回不为null，则映射方法直接返回回调方法执行结果，不会往后执行。
hundan_520520
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java编码辅助工具Mapstruct用法详解
08-25
主要介绍了Java编码辅助工具Mapstruct用法详解，手动编码setter/getter各个对应属性，会显得臃肿繁琐。通过Mapstruct框架可简单方便地完成这一工作。,需要的朋友可以参考下
MapStruct的一些常规用法
青塬研发
03-05 428
每天坚持写一篇原创文章。使用过MapStruct之后，再也没用过BeanCopy来复制对象了。确实是非常好用的工具库。MapStruct是一个代码生成器，简化了不同的Java Bean之间映射的处理，所以映射指的就是从一个实体变化成一个实体。例如我们在实际开发中，DAO层的实体和一些数据传输对象(DTO)，大部分属性都是相同的，只有少部分的不同，通过mapStruct，可以让不同实体之间的转换变的简单。我们只需要按照约定的方式进行配置即可。
MapStruct 教程
里查叔叔
03-03 1030
MapStruct 支持装饰器模式，允许你在不修改生成的 Mapper 实现的情况下增强 Mapper 的功能。通过定义一个实现了 Mapper 接口的类，并在该类中添加额外的映射逻辑，你可以扩展 Mapper 的行为。如果需要自定义嵌套对象或集合的映射行为，我们可以在 Mapper 接口中定义相应的方法，并使用。这个参数代表了被装饰的 Mapper 实现，我们可以在装饰器类中调用它的方法来执行基本的映射操作，并添加自定义的逻辑。当然，你也可以通过依赖注入的方式将 Mapper 注入到你的组件中。
MapStruct使用指南
qq_28344049的博客
12-30 3570
MapStruct使用指南
MapStruct使用详解
hellozhxy的博客
11-18 6680
阅读目录： 序 一、准备工作 1.1、了解@Mapper 注解 1.2、依赖包 二、先简单玩一把 2.1、定义实体类以及被映射类 2.2、定义接口： 2.3、使用 2.4、查看编译结果 2.5、浏览器查看结果 三、不简单的情况 3.1、类型不一致 3.2、字段名不一致 3.3、属性是枚举类型 源代码 阅读正文： 我们都知道，随着一个工程的越来越成熟，模块划分会越来越细，其中实体类一般存于 domain 之中，但 domain 工程最好不要被其他工
mapstruct常见用法梳理
datastructure18的博客
09-25 1869
目录 一、前言 二、mapstruct使用前的准备 1、maven方式 2、Gradle方式 3、 Apache Ant方式 三、mapstruct使用方式梳理 1、最简单的映射 2、不同属性名映射 3、不同类型映射 1）、日期格式转化 2）、数字格式转化 4、List映射 5、Map和Set映射 6、枚举映射 四、总结 参考 一、前言 在互联网企业中，随着业务越来越繁琐，导致系统架构越来越复杂，很多企业都...
Mapstruct 使用教程
热门推荐
菜鸡的博客
08-28 9万+
Mapstruct 版本1.5.0.Beta1 官方文档 案例-github 前言 MapStruct是一个Java注释处理器，用于生成类型安全的bean映射类。 您要做的就是定义一个映射器接口，该接口声明任何必需的映射方法。在编译期间，MapStruct将生成此接口的实现。此实现使用简单的Java方法调用在源对象和目标对象之间进行映射，即没有反射或类似内容。 与手动编写映射代码相比，MapStruct通过生成繁琐且易于出错的代码来节省时间。遵循配置方法上的约定，MapStruct使用合理的默认值，但在配置
MapStruct的基础用法详解
yqw1401的博客
09-20 8674
MapStruct 的一般理念是生成的代码看起来尽可能像您自己亲手编写的代码。特别是这意味着通过简单的 getter/setter 调用而不是反射或类似方法将值从源复制到目标。
MapStruct的使用详解与常见用法介绍
compellingMan的博客
08-03 1万+
mapstruct在当前轻量级框架开发中的重点使用，@Named注解使用示例，@AfterMapping与@BeforeMapping注解的详细常见用法，在转换DTO时，与过去常用的beanUtil转换有高性能的转换优势，编译期自动生成的mapper实现类能够更加优雅的来实现各种隐式类型转换，以实现快速而又敏捷的开发，告别臃肿的手动get、set与类型的强转......
MapStruct的基本用法
qq_53502126的博客
05-23 1295
Mapping(target = "productId", source = "productId", defaultValue = "123"), //当product的productId为null，设置为0。1. 不管有多少入参，当目标类中的属性名和入参类型中的属性名一致时，都不用写Mapping，会自动映射，除非多个参数的类型中有同名的属性，这种情况需要指定一个source，通过类似user.name的方式（user 是参数名）。
Mapstruct 基本用法
weixin_43549350的博客
03-30 1183
MapStruct 简介 在实际开发中我们在项目中经常要在 DTO、VO、DO、Entity 等实体之间进行转换，这种类型的框架也有很多，比如 Spring 框架中的 BeanUtils 工具类 ，但这个工具类是通过反射来实现的，性能相对低下且存在类型转换异常的问题，所以这个工具在有些公司是禁止使用的。下面简单说一下MapStruct,MapStruct 是一个代码生成器，它基于约定优于配置的方法极大地简化了Java bean类型之间映射的实现。与其他映射框架相比，MapStruct在编译时生成Bean映
MapStruct实体间转换的简单用法
08-26
今天小编就为大家分享一篇关于MapStruct实体间转换的简单用法，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
mapstruct-idea:IntelliJ IDEA插件，可与MapStruct一起使用
05-02
IntelliJ IDEA插件，可与MapStruct一起使用 什么是MapStruct？ MapStruct是一个Java用于为Java Bean类生成类型安全和高性能的映射器。 要了解有关MapStruct的更多信息，请查看存储库或 特征 代码完成 完成@Mapping...
mapstruct-1.2.0.Final-API文档-中文版.zip
07-13
赠送jar包：mapstruct-1.2.0.Final.jar；...使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
mapstruct-1.1.0.Final-API文档-中文版.zip
07-12
赠送jar包：mapstruct-1.1.0.Final.jar；...使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
mybatisPlus使用MetaObjectHandler对字段进行更新
最新发布
m0_56356631的博客
04-23 291
都是符合我们的预期的。
string模拟实现
m0_73969414的博客
04-23 1411
c++中string的模拟实现，面试必会知识点
实现自定义注解、实现自定义幂等性注解
qq_44721738的博客
04-23 556
添加 Spring AOP 依赖。创建自定义注解。创建一个新的 Java 注解类，通过@interface关键字来定义，并可以添加元注解以及属性。@Target(ElementType.METHOD) //表示作用于方法上@Retention(RetentionPolicy.RUNTIME) // 表示这个注解在运行时是可见的，这样 AOP 代理才能在运行时读取到这个注解编写 AOP 拦截（自定义注解）的逻辑代码。@Aspect@Component// 方法执行前的处理。
javaweb-SpringBoot基础
kussm_的博客
04-20 1308
Spring的官网(Spring的简介：Spring makes Java simple。Spring Boot 可以帮助我们非常快速的构建应用程序、简化开发、提高效率。创建一个子包controller。
mapstruct使用方法
11-30
以下是使用MapStruct的步骤： 1.添加MapStruct依赖项到你的项目中。你可以在Maven或Gradle中添加以下依赖项： ```xml <groupId>org.mapstruct <artifactId>mapstruct <version>1.4.2.Final ``` 2.创建一个...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值