• 危险,请马上替换代码中的BeanUtils


    . 背景

    之前在专栏中讲过“不推荐使用属性拷贝工具”,推荐直接定义转换类和方法使用 IDEA 插件自动填充 get / set 函数。

    不推荐的主要理由是:

    • 有些属性拷贝工具性能有点差

    • 有些属性拷贝工具有“BUG”

    • 使用属性拷贝工具容易存在一些隐患(后面例子会讲到)

    2. 示例

    首先公司内部就遇到过 commons 包的 BeanUtils 进行属性拷贝性能较差的真实案例,然后该同事换成了 Spring 的 BeanUtils 性能好了很多,感兴趣大家可以使用性能测试框架或者基准测试框架去对比,这里就不对比了。

    接下来我们看 Spring 的 BeanUtils 的属性拷贝会存在啥问题:

    1. import lombok.Data;
    2. import java.util.List;
    3. @Data
    4. public class A {
    5. private String name;
    6. private List ids;
    7. }
    8. @Data
    9. public class B {
    10. private String name;
    11. private List ids;
    12. }
    13. import org.springframework.beans.BeanUtils;
    14. import java.util.Arrays;
    15. public class BeanUtilDemo {
    16. public static void main(String[] args) {
    17. A first = new A();
    18. first.setName("demo");
    19. first.setIds(Arrays.asList(1, 2, 3));
    20. B second = new B();
    21. BeanUtils.copyProperties(first, second);
    22. for (String each : second.getIds()) {// 类型转换异常
    23. System.out.println(each);
    24. }
    25. }
    26. }

    大家运行上述示例时,会发生类型转换异常。

    打断点可以看到,属性拷贝之后 B 类型的 second 对象中 ids 仍然为 Integer 类型:

    如果不转换为字符串,直接进行打印,并不会报错。

    使用CGlib 在不定义Converter 的情况下也会遇到类似问题:

    1. import org.easymock.cglib.beans.BeanCopier;
    2. import java.util.Arrays;
    3. public class BeanUtilDemo {
    4. public static void main(String[] args) {
    5. A first = new A();
    6. first.setName("demo");
    7. first.setIds(Arrays.asList(1, 2, 3));
    8. B second = new B();
    9. final BeanCopier beanCopier = BeanCopier.create(A.class, B.class, false);
    10. beanCopier.copy(first,second,null);
    11. for (String each : second.getIds()) {// 类型转换异常
    12. System.out.println(each);
    13. }
    14. }
    15. }

    同样,问题在运行时才暴露出来。

    接下来我们看下 mapstruct:

    1. import org.mapstruct.Mapper;
    2. import org.mapstruct.factory.Mappers;
    3. @Mapper
    4. public interface Converter {
    5. Converter INSTANCE = Mappers.getMapper(Converter.class);
    6. B aToB(A car);
    7. }
    8. import java.util.Arrays;
    9. public class BeanUtilDemo {
    10. public static void main(String[] args) {
    11. A first = new A();
    12. first.setName("demo");
    13. first.setIds(Arrays.asList(1, 2, 3));
    14. B second = Converter.INSTANCE.aToB(first);
    15. for (String each : second.getIds()) {// 正常
    16. System.out.println(each);
    17. }
    18. }
    19. }

    可以成功的将 A 中  List 转为 B 中的  List 类型。

    我们看下编译生成的 Converter 实现类:

    1. import java.util.ArrayList;
    2. import java.util.List;
    3. import javax.annotation.Generated;
    4. import org.springframework.stereotype.Component;
    5. @Generated(
    6. value = "org.mapstruct.ap.MappingProcessor",
    7. comments = "version: 1.3.1.Final, compiler: javac, environment: Java 1.8.0_202 (Oracle Corporation)"
    8. )
    9. @Component
    10. public class ConverterImpl implements Converter {
    11. @Override
    12. public B aToB(A car) {
    13. if ( car == null ) {
    14. return null;
    15. }
    16. B b = new B();
    17. b.setName( car.getName() );
    18. b.setIds( integerListToStringList( car.getIds() ) );
    19. return b;
    20. }
    21. protected List integerListToStringList(List list) {
    22. if ( list == null ) {
    23. return null;
    24. }
    25. List list1 = new ArrayList( list.size() );
    26. for ( Integer integer : list ) {
    27. list1.add( String.valueOf( integer ) );
    28. }
    29. return list1;
    30. }
    31. }

    自动帮我们进行了转换,我们可能没有意识到类型并不一致。

    如果我们在 A 类中添加一个 String number 属性,在 B 类中添加一个 Long number 属性,使用 mapstruect 当 number 设置为非数字类型时就会报 .NumberFormatException 。

    1. @Override
    2. public B aToB(A car) {
    3. if ( car == null ) {
    4. return null;
    5. }
    6. B b = new B();
    7. b.setName( car.getName() );
    8. if ( car.getNumber() != null ) { // 问题出在这里
    9. b.setNumber( Long.parseLong( car.getNumber() ) );
    10. }
    11. b.setIds( integerListToStringList( car.getIds() ) );
    12. return b;
    13. }

    使用 cglib 默认则不会映射 number 属性,B 中的 number 为 null。

    如果手动定义转换器,使用 IDEA 插件(如 generateO2O)自动转换:

    1. public final class A2BConverter {
    2. public static B from(A first) {
    3. B b = new B();
    4. b.setName(first.getName());
    5. b.setIds(first.getIds());
    6. return b;
    7. }
    8. }

    在编码阶段就可以非常明确地发现这个问题:

    3. 结论

    由于 Java 的泛型其实是编译期检查,编译后泛型擦除,导致运行时 List 和  List 都是 List 类型,可以正常赋值。这就导致在使用很多属性映射工具时,编译时不容易明显的错误。

    mapstruct 自定义了注解处理器,在编译阶段可以读取映射双方的泛型类型,进而进行映射。但是这种映射也很可怕,有时候我们由于粗心等原因定义错了类型, 自动帮助我们进行了转换,会带了很多副作用。

    之前对各种属性映射工具的性能进行了简单的对比,结果如下:

    因此慎用属性转换工具,如果可能建议自定义转换类,使用 IDEA插件自动填充,效率也挺高, A 或 B 中任何属性类型不匹配,甚至删除一个属性, 编译阶段即可报错,而且直接调用 get set 的效率也是非常高的。

  • 相关阅读:
    MVCC面试题
    Pr:导出设置之高级设置及 VR 视频
    【Linux】关于磁盘操作命令
    【信息科学技术与创新】机器学习 深度学习 人工神经网络相关分析
    Redisson 限流器源码分析
    kubeasz一键部署k8s集群
    04JVM_语法糖
    基于 Python/Vue/D2 实现的CRM管理系统(客户管理,产品管理,商机管理,合同管理,客户公海,权限管理等业务模块)
    解决docker容器: bash: ping: command not found, 并制作镜像
    Matlab中的handle 类
  • 原文地址:https://blog.csdn.net/Q54665642ljf/article/details/126192136