mapstruct

ゝ一纸荒年。 2022-05-17 04:46 214阅读 0赞

# 配置MapStruct #

到目前为止我们的准备工作差不多完成了，下面我们开始配置使用MapStruct。我们的最终目的是为了返回一个自定义的DTO实体，那么我们就先来创建这个DTO，DTO的代码如下所示：

package com.yuqiyu.chapter30.dto;
    
    import lombok.Data;
    
    /**
     * 转换Dto
     */
    @Data
    public class GoodInfoDTO
    {
        //商品编号
        private String goodId;
        //商品名称
        private String goodName;
        //商品价格
        private double goodPrice;
        //类型名称
        private String typeName;
    }

可以看到GoodInfoDTO实体内集成了商品信息、商品类型两张表内的数据，对应查询出信息后，我们需要使用MapStruct自动映射到GoodInfoDTO。

### 创建Mapper ###

Mapper这个定义一般是被广泛应用到MyBatis半自动化ORM框架上，而这里的Mapper跟Mybatis没有关系。下面我们先来看下代码，如下所示：

package com.yuqiyu.chapter30.mapper;
    
    import com.yuqiyu.chapter30.bean.GoodInfoBean;
    import com.yuqiyu.chapter30.bean.GoodTypeBean;
    import com.yuqiyu.chapter30.dto.GoodInfoDTO;
    import org.mapstruct.Mapper;
    import org.mapstruct.Mapping;
    import org.mapstruct.Mappings;
    
    /**
     * 配置映射
     */
    @Mapper(componentModel = "spring")
    //@Mapper
    public interface GoodInfoMapper
    {
        //public static GoodInfoMapper MAPPER = Mappers.getMapper(GoodInfoMapper.class);
    
        @Mappings({
                @Mapping(source = "type.name",target = "typeName"),
                @Mapping(source = "good.id",target = "goodId"),
                @Mapping(source = "good.title",target = "goodName"),
                @Mapping(source = "good.price",target = "goodPrice")
        })
        public GoodInfoDTO from(GoodInfoBean good, GoodTypeBean type);
    }

可以看到GoodInfoMapper是一个接口的形式存在的，当然也可以是一个抽象类，如果你需要在转换的时候才用个性化的定制的时候可以采用抽象类的方式，相应的代码配置官方文档已经声明。  
@Mapper注解是用于标注接口、抽象类是被MapStruct自动映射的标识，只有存在该注解才会将内部的接口方法自动实现。  
MapStruct为我们提供了多种的获取Mapper的方式，比较常用的两种分别是

默认配置

默认配置，我们不需要做过多的配置内容，获取Mapper的方式就是采用Mappers通过动态工厂内部反射机制完成Mapper实现类的获取。  
默认方式获取Mapper如下所示：

//Mapper接口内部定义
    public static GoodInfoMapper MAPPER = Mappers.getMapper(GoodInfoMapper.class);
    
    //外部调用
    GoodInfoMapper.MAPPER.from(goodBean,goodTypeBean);

Spring方式配置

Spring方式我们需要在@Mapper注解内添加componentModel属性值，配置后在外部可以采用@Autowired方式注入Mapper实现类完成映射方法调用。  
Spring方式获取Mapper如下所示：

//注解配置
    @Mapper(componentModel = "spring")
    
    //注入Mapper实现类
    @Autowired
    private GoodInfoMapper goodInfoMapper;
    
    //调用
    goodInfoMapper.from(goodBean,goodTypeBean);

@Mappings & @Mapping

在Mapper接口定义方法上面声明了一系列的注解映射@Mapping以及@Mappings，那么这两个注解是用来干什么工作的呢？  
@Mapping注解我们用到了两个属性，分别是source、target

source代表的是映射接口方法内的参数名称，如果是基本类型的参数，参数名可以直接作为source的内容，如果是实体类型，则可以采用实体参数名.字段名的方式作为source的内容，配置如上面GoodInfoMapper内容所示。

target代表的是映射到方法方法值内的字段名称，配置如上面GoodInfoMapper所示。

查看Mapper实现

下面我们执行maven compile命令，到target/generated-sources/annotations目录下查看对应Mapper实现类，实现类代码如下所示：

package com.yuqiyu.chapter30.mapper;
    
    import com.yuqiyu.chapter30.bean.GoodInfoBean;
    import com.yuqiyu.chapter30.bean.GoodTypeBean;
    import com.yuqiyu.chapter30.dto.GoodInfoDTO;
    import javax.annotation.Generated;
    import org.springframework.stereotype.Component;
    
    @Generated(
        value = "org.mapstruct.ap.MappingProcessor",
        date = "2017-08-20T12:52:52+0800",
        comments = "version: 1.2.0.CR1, compiler: javac, environment: Java 1.8.0_111 (Oracle Corporation)"
    )
    @Component
    public class GoodInfoMapperImpl implements GoodInfoMapper {
    
        @Override
        public GoodInfoDTO from(GoodInfoBean good, GoodTypeBean type) {
            if ( good == null && type == null ) {
                return null;
            }
    
            GoodInfoDTO goodInfoDTO = new GoodInfoDTO();
    
            if ( good != null ) {
                if ( good.getId() != null ) {
                    goodInfoDTO.setGoodId( String.valueOf( good.getId() ) );
                }
                goodInfoDTO.setGoodName( good.getTitle() );
                goodInfoDTO.setGoodPrice( good.getPrice() );
            }
            if ( type != null ) {
                goodInfoDTO.setTypeName( type.getName() );
            }
    
            return goodInfoDTO;
        }
    }

MapStruct根据我们配置的@Mapping注解自动将source实体内的字段进行了调用target实体内字段的setXxx方法赋值，并且做出了一切参数验证。  
我们采用了Spring方式获取Mapper，在自动生成的实现类上MapStruct为我们自动添加了@ComponentSpring声明式注入注解配置。