• Bean工具-BeanUtil
    • 什么是Bean
    • 方法
      • 是否为Bean对象
      • 内省 Introspector
      • Bean属性注入
      • Bean转为Map
      • Bean转Bean

    Bean工具-BeanUtil

    什么是Bean

    把一个拥有对属性进行set和get方法的类，我们就可以称之为JavaBean。实际上JavaBean就是一个Java类，在这个Java类中就默认形成了一种规则——对属性进行设置和获得。而反之将说Java类就是一个JavaBean，这种说法是错误的，因为一个java类中不一定有对属性的设置和获得的方法（也就是不一定有set和get方法）。

    通常Java中对Bean的定义是包含setXXX和getXXX方法的对象，在Hutool中，采取一种简单的判定Bean的方法：是否存在只有一个参数的setXXX方法。

    Bean工具类主要是针对这些setXXX和getXXX方法进行操作，比如将Bean对象转为Map等等。

    方法

    是否为Bean对象

    BeanUtil.isBean方法根据是否存在只有一个参数的setXXX方法来判定是否是一个Bean对象。这样的判定方法主要目的是保证至少有一个setXXX方法用于属性注入。

    1. boolean isBean = BeanUtil.isBean(HashMap.class);//false

    内省 Introspector

    把一类中需要进行设置和获得的属性访问权限设置为private（私有的）让外部的使用者看不见摸不着，而通过public（共有的）set和get方法来对其属性的值来进行设置和获得，而内部的操作具体是怎样的？外界使用的人不用不知道，这就称为内省。

    Hutool中对内省的封装包括：

    • BeanUtil.getPropertyDescriptors 获得Bean字段描述数组
    • BeanUtil.getFieldNamePropertyDescriptorMap 获得字段名和字段描述Map
    • BeanUtil.getPropertyDescriptor 获得Bean类指定属性描述

    Bean属性注入

    BeanUtil.fillBean方法是bean注入的核心方法，此方法传入一个ValueProvider接口，通过实现此接口来获得key对应的值。CopyOptions参数则提供一些注入属性的选项。

    CopyOptions的配置项包括：

    • editable 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类。
    • ignoreNullValue 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    • ignoreProperties 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
    • ignoreError 是否忽略字段注入错误可以通过CopyOptions.create()方法创建一个默认的配置项，通过setXXX方法设置每个配置项。

    ValueProvider接口需要实现两个方法：

    • value方法是通过key和目标类型来从任何地方获取一个值，并转换为目标类型，如果返回值不和目标类型匹配，将会自动调用Convert.convert方法转换。
    • containsKey方法主要是检测是否包含指定的key，如果不包含这个key，其对应的属性将会忽略注入。首先定义一个bean：
    1. public class Person{
    2.     private String name;
    3.     private int age;
    5.     public String getName() {
    6.         return name;
    7.     }
    8.     public void setName(String name) {
    9.         this.name = name;
    10.     }
    11.     public int getAge() {
    12.         return age;
    13.     }
    14.     public void setAge(int age) {
    15.         this.age = age;
    16.     }
    17. }

    然后注入这个bean：

    1. Person person = BeanUtil.fillBean(new Person(), new ValueProvider<String>(){
    3.     @Override
    4.     public Object value(String key, Class<?> valueType) {
    5.         switch (key) {
    6.             case "name":
    7.                 return "张三";
    8.             case "age":
    9.                 return 18;
    10.         }
    11.         return null;
    12.     }
    14.     @Override
    15.     public boolean containsKey(String key) {
    16.         //总是存在key
    17.         return true;
    18.     }
    20. }, CopyOptions.create());
    22. Assert.assertEquals(person.getName(), "张三");
    23. Assert.assertEquals(person.getAge(), 18);

    同时，Hutool还提供了BeanUtil.toBean方法，此处并不是传Bean对象，而是Bean类，Hutool会自动调用默认构造方法创建对象。

    基于BeanUtil.fillBean方法Hutool还提供了Map对象键值对注入Bean，其方法有：

    • BeanUtil.fillBeanWithMap

    • BeanUtil.fillBeanWithMapIgnoreCase同时提供了map转bean的方法，与fillBean不同的是，此处并不是传Bean对象，而是Bean类，Hutool会自动调用默认构造方法创建对象。当然，前提是Bean类有默认构造方法（空构造），这些方法有：

    • BeanUtil.mapToBean

    • BeanUtil.mapToBeanIgnoreCase在Java Web应用中，我们经常需要将ServletRequest对象中的参数注入bean（http表单数据），BeanUtil类提供了两个便捷方法：

    • BeanUtil.fillBeanWithRequestParam 将http表单数据注入Bean对象

    • BeanUtil.requestParamToBean 将http表单数据注入新建的Bean对象

    Bean转为Map

    BeanUtil.beanToMap方法则是将一个Bean对象转为Map对象。

    Bean转Bean

    Bean之间的转换主要是相同属性的复制，因此方法名为copyProperties。

    BeanUtil.copyProperties方法同样提供一个CopyOptions参数用于自定义属性复制。