【精品】基于 MapStruct实现 JavaBean克隆及属性拷贝

参考博客:

基于Spring BeanUtils 实现 JavaBean克隆及属性拷贝

基于apache BeanUtils 实现 JavaBean克隆及属性拷贝

基于 MapStruct实现 JavaBean克隆及属性拷贝

Intellij 插件 GenerateO2O

MapStruct简介

简介

  • 性能高
    这是相对反射来说的,反射需要去读取字节码的内容,花销会比较大。而通过 MapStruct 来生成的代码,其类似于人手写。速度上可以得到保证。
  • 用简单
    如果是完全映射的,使用起来肯定没有反射简单。用类似 BeanUtils 这些工具一条语句就搞定了。但是,如果需要进行特殊的匹配(特殊类型转换,多对一转换等),其相对来说也是比较简单的。
    基本上,使用的时候,我们只需要声明一个接口,接口下写对应的方法,就可以使用了。当然,如果有特殊情况,是需要额外处理的。推荐:Java进阶视频资源
  • 代码独立
    生成的代码是对立的,没有运行时的依赖。
  • 易于 debug
    在我们生成的代码中,我们可以轻易的进行 debug。

Maven依赖

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>1.4.2.Final</version>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.22</version>
    <scope>provided</scope>
</dependency>

<!--        生成随机数据-->
<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>data-factory-core</artifactId>
    <version>1.1.0</version>
</dependency>

pom.xml中添加插件支持(重点,不要忘了)

<pluginManagement>
    <plugins>
		<plugin>
		    <artifactId>maven-compiler-plugin</artifactId>
		    <version>3.8.0</version>
		    <configuration>
		        <source>11</source>
		        <target>11</target>
		        <annotationProcessorPaths>
		            <path>
		                <groupId>org.mapstruct</groupId>
		                <artifactId>mapstruct-processor</artifactId>
		                <version>1.4.2.Final</version>
		            </path>
		            <path>
		                <groupId>org.projectlombok</groupId>
		                <artifactId>lombok</artifactId>
		                <version>1.18.22</version>
		            </path>
		            <path>
		                <groupId>org.projectlombok</groupId>
		                <artifactId>lombok-mapstruct-binding</artifactId>
		                <version>0.2.0</version>
		            </path>
		        </annotationProcessorPaths>
		    </configuration>
		</plugin>
	</plugins>
</pluginManagement>

入门示例:属性名相同、属性个数不同

待转换的类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 6357528845064191241L;

    /**
    * 编号
    */
    private Long id;

    /**
    * 昵称
    */
    private String nickname;

    /**
    * 大头相
    */
    private String avatar;

    /**
    * 登录名
    */
    private String account;

    /**
    * 密码
    */
    private String password;

    /**
    * 性别   1男  2女  3未知
    */
    private Byte gender;

    /**
    * 电话
    */
    private String tel;

    /**
    * 邮编
    */
    private String email;

    /**
    * QQ
    */
    private String qq;

    /**
    * 微信
    */
    private String wechat;

    /**
    * 盐值
    */
    private String salt;

    /**
    * 备注
    */
    private String info;

    /**
    * 状态
    */
    private Byte status;

    /**
    * 注册时间
    */
    private Date createTime;

    /**
    * 更新时间
    */
    private Date updateTime;

}

目标类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserBO implements Serializable {

    private static final long serialVersionUID = 7257164843346458694L;

    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 大头相
     */
    private String avatar;

    /**
     * 邮编
     */
    private String email;

    /**
     * 微信
     */
    private String wechat;

    /**
     * 状态
     */
    private Byte status;

}

转换接口

@Mapper
public interface UserMapper {

    UserMapper MAPPER = Mappers.getMapper(UserMapper.class);

    UserBO user2UserBO(User user);

    List<UserBO> user2UserBO(List<User> user);
}

测试代码

public class MapStructTest {

    @Test
    public void fun1() {
        User user = DataUtil.build(User.class);
        System.out.println(user);
        UserBO userBO = UserMapper.MAPPER.user2UserBO(user);
        System.out.println(userBO);
    }
    @Test
    public void fun2() {
        List<User> list = new ArrayList<>();
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));
        list.forEach(System.out::println);
        
        List<UserBO> res = UserMapper.MAPPER.user2UserBO(list);
        res.forEach(System.out::println);
    }

}

:UserMapper只是一个接口,它只所以能够直接使用,是因为系统自动生成了UserMapper的实现类,具体代码如下所示:

public class UserMapperImpl implements UserMapper {
    public UserMapperImpl() {
    }

    public UserBO user2UserBO(User user) {
        if (user == null) {
            return null;
        } else {
            UserBOBuilder userBO = UserBO.builder();
            userBO.id(user.getId());
            userBO.nickname(user.getNickname());
            userBO.avatar(user.getAvatar());
            userBO.email(user.getEmail());
            userBO.wechat(user.getWechat());
            userBO.status(user.getStatus());
            return userBO.build();
        }
    }

    public List<UserBO> user2UserBO(List<User> user) {
        if (user == null) {
            return null;
        } else {
            List<UserBO> list = new ArrayList(user.size());
            Iterator var3 = user.iterator();

            while(var3.hasNext()) {
                User user1 = (User)var3.next();
                list.add(this.user2UserBO(user1));
            }

            return list;
        }
    }
}

进阶一:属性名不同

待转换的类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 6357528845064191241L;

    /**
    * 编号
    */
    private Long id;

    /**
    * 昵称
    */
    private String nickname;

    /**
    * 大头相
    */
    private String avatar;
    
    /**
    * 邮箱
    */
    private String email;
    
    /**
    * 微信
    */
    private String wechat;

    /**
    * 更新时间
    */
    private Date updateTime;

}

目标类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserBO implements Serializable {

    private static final long serialVersionUID = 7257164843346458694L;

    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 大头相
     */
    private String img;

    /**
     * 邮编
     */
    private String email;

    /**
     * 微信
     */
    private String wexin;
    
    /**
    * 更新时间
    */
    private Date updateTime22;
}

转换接口

@Mapper
public interface UserMapper {

    UserMapper MAPPER = Mappers.getMapper(UserMapper.class);

    @Mappings({
            @Mapping(source = "avatar", target = "img"),
            @Mapping(source = "wechat", target = "wexin"),
            @Mapping(source = "updateTime", target = "updateTime22")
    })
    UserBO user2UserBO(User user);
}

测试类

public class MapStructTest {

    @Test
    public void fun() {
        User user = DataUtil.build(User.class);
        System.out.println(user);
        UserBO userBO = UserMapper.MAPPER.user2UserBO(user);
        System.out.println(userBO);
    }
    
}

进阶二:数据类型不一样

待转换的类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User {
    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 创建时间
     */
    private LocalDateTime createTime;

}

目标类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserBO {
    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 创建时间
     */
    private String createTime;
}

转换工具类

public class DateTransUtil {

    public static LocalDateTime str2LocalDateTime(String str){
        DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        return LocalDateTime.parse(str,dtf);
    }

    public static String localDateTime2Str(LocalDateTime localDateTime){
        DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        return dtf.format(localDateTime);
    }
}

转换接口

@Mapper
public interface UserMapper {

    UserMapper MAPPER = Mappers.getMapper(UserMapper.class);

    @Mapping(target = "createTime", expression = "java(com.hc.util.DateTransUtil.localDateTime2Str(user.getCreateTime()))")
    UserBO user2UserBO(User user);

}

测试类

public class MapStructTest {

    @Test
    public void fun() {
        User user = DataUtil.build(User.class);
        System.out.println(user);
        UserBO userBO = UserMapper.MAPPER.user2UserBO(user);
        System.out.println(userBO);
    }

}

进阶三:将多个对象转换成一个对象

待合并的类

  • UserBO
@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserBO {
    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;
}
  • AddressBO
@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class AddressBO {
    private String addr;
}

目标类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User {
    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 地址
     */
    private String addr;

}

转换接口

@Mapper
public interface UserMapper {

    UserMapper MAPPER = Mappers.getMapper(UserMapper.class);

    @Mappings({
            @Mapping(source = "userBO.id", target = "id"), //可以省略
            @Mapping(source = "userBO.nickname", target = "nickname"), //可以省略
            @Mapping(source = "addressBO.addr", target = "addr"), //可以省略
    })
    User user2UserBO(UserBO userBO, AddressBO addressBO);

}

说明:

  • 当多个对象中, 有其中一个为 null, 则会直接返回 null
  • 当多个原对象中,有相同名字的属性时,需要通过 @Mapping 注解来具体的指定, 以免出现歧义(不指定会报错)

测试类

public class MapStructTest {

    @Test
    public void fun() {
        UserBO userBO = DataUtil.build(UserBO.class);
        System.out.println(userBO);
        AddressBO addressBO = DataUtil.build(AddressBO.class);
        System.out.println(addressBO);

        User user = UserMapper.MAPPER.user2UserBO(userBO,addressBO);
        System.out.println(user);
    }

}

进阶二:转换非基础类型的属性

待转换的类

目标类

转换接口

测试类

进阶二:更新Bean对象–基于泛型的转换(★★★★★)

待转换的实体类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 6357528845064191241L;

    /**
    * 编号
    */
    private Long id;

    /**
    * 昵称
    */
    private String nickname;

    /**
    * 大头相
    */
    private String avatar;

    /**
    * 登录名
    */
    private String account;

    /**
    * 密码
    */
    private String password;

    /**
    * 性别   1男  2女  3未知
    */
    private Byte gender;

    /**
    * 电话
    */
    private String tel;

    /**
    * 邮编
    */
    private String email;

    /**
    * QQ
    */
    private String qq;

    /**
    * 微信
    */
    private String wechat;

    /**
    * 盐值
    */
    private String salt;

    /**
    * 备注
    */
    private String info;

    /**
    * 状态
    */
    private Byte status;

    /**
    * 注册时间
    */
    private Date createTime;

    /**
    * 更新时间
    */
    private Date updateTime;

}

目标实体类

@Getter
@Setter
@ToString
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserBO implements Serializable {

    private static final long serialVersionUID = 7257164843346458694L;

    /**
     * 编号
     */
    private Long id;

    /**
     * 昵称
     */
    private String nickname;

    /**
     * 大头相
     */
    private String avatar;

    /**
     * 邮编
     */
    private String email;

    /**
     * 微信
     */
    private String wechat;
}

泛型类

@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class PageBean<T> {
    /**
     * 每页显示的条数
     */
    private Integer pageSize = 10;

    /**
     * 当前的页码
     */
    private Integer pageNum;

    /**
     * 一共有多少条记录
     */
    private Long total;

    /**
     * 一共有多少页
     */
    private Integer pages;

    /**
     * 每一页所显示的数据
     */
    private List<T> result;

    /**
     * 分页请求路径
     */
    private String url;

}

转换接口

@Mapper
public interface UserMapper {

    UserMapper MAPPER = Mappers.getMapper(UserMapper.class);
	//方法一
    PageBean<UserBO> user2UserBO(PageBean<User> user);
    //方法二
    void user2UserBO(PageBean<User> userPageBean, @MappingTarget PageBean<UserBO> userBOPageBean);
}

测试类

public class MapStructTest {

    @Test
    public void fun1() {
        List<User> list = new ArrayList<>();
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));

        PageBean<User> userPageBean = new PageBean<>();
        userPageBean.setPages(10);
        userPageBean.setPageNum(5);
        userPageBean.setPageSize(8);
        userPageBean.setResult(list);
        userPageBean.setTotal(86L);
        userPageBean.setUrl("getUserByCondition/");

        PageBean<UserBO>  userBOPageBean= UserMapper.MAPPER.user2UserBO(userPageBean);
        System.out.println(userBOPageBean);
    }

    @Test
    public void fun2() {
        List<User> list = new ArrayList<>();
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));
        list.add(DataUtil.build(User.class));

        PageBean<User> userPageBean = new PageBean<>();
        userPageBean.setPages(10);
        userPageBean.setPageNum(5);
        userPageBean.setPageSize(8);
        userPageBean.setResult(list);
        userPageBean.setTotal(86L);
        userPageBean.setUrl("getUserByCondition/");

        PageBean<UserBO> userBOPageBean = new PageBean<>();
        UserMapper.MAPPER.user2UserBO(userPageBean,userBOPageBean);
        System.out.println(userBOPageBean);
    }

}
## 进阶一:属性名不同 ### 待转换的类

目标类

转换接口

测试类

  • 44
    点赞
  • 61
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 15
    评论
MapStruct 是一个用于 JavaBean 之间的映射的注解处理器,它可以根据定义的映射规则自动生成相应的映射代码。然而,有时候我们会遇到 MapStruct 不生成实现类的情况。 造成 MapStruct 不生成实现类的原因可能有以下几点: 1. 未使用正确的注解:MapStruct 生成映射代码需要在接口中使用 `@Mapper` 注解,以及在需要映射的方法上使用 `@Mapping` 注解。如果这些注解没有正确使用,可能会导致生成失败或者没有生成实现类。 2. 映射方法未定义:MapStruct 需要在接口中定义与源对象和目标对象属性对应的映射方法。如果没有定义相应的映射方法,MapStruct 将无法根据映射规则生成代码。 3. 映射规则不满足:MapStruct 生成映射代码需要满足一定的映射规则,比如源对象和目标对象的属性名需要完全匹配,或者在 `@Mapping` 注解中定义了属性名的映射关系。如果映射规则不满足,可能导致生成失败。 4. 依赖问题:MapStruct 生成的映射代码依赖于正确配置的 Maven 或 Gradle 依赖项。如果在项目中的构建配置中没有正确配置 MapStruct 的依赖项,可能会导致生成失败。 当面对 MapStruct 不生成实现类的问题时,我们可以尝试以下解决方法: 1. 检查注解的使用是否正确,确保接口类上使用了 `@Mapper` 注解,以及映射方法上使用了 `@Mapping` 注解,属性名是否匹配。 2. 检查映射方法的定义是否正确,确保接口中定义了源对象和目标对象的映射方法。 3. 检查映射规则是否满足,确保源对象和目标对象的属性名匹配,或在 `@Mapping` 注解中定义了属性名的映射关系。 4. 检查项目依赖配置,确保正确引入了 MapStruct 的依赖项。 通过以上的检查和调整,应该能够解决 MapStruct 不生成实现类的问题。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

梁云亮

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值