Bean 描述工具 - BeanDesc

介绍

BeanDesc 是 Hutool 提供的一个用于解析 JavaBean 信息的工具类。通过 BeanDesc，可以方便地获取一个 JavaBean 的所有字段、属性及其对应的 Getter 和 Setter 方法。与 JDK 提供的 BeanInfo 相比，BeanDesc 对属性和 Getter、Setter 方法的要求更加严格，确保字段和方法必须一一对应。

BeanDesc 的属性和方法关联规则如下：

1. 匹配时忽略字段和方法名的大小写。
2. 对于字段名 XXX，Getter 方法查找 getXXX、isXXX、getIsXXX。
3. 对于字段名 XXX，Setter 方法查找 setXXX、setIsXXX。
4. 如果 Setter 方法存在多个重载且参数类型不匹配，BeanDesc 会调用首次匹配的 Setter 方法。

使用场景

• 复杂 JavaBean 解析：BeanDesc 适用于需要解析复杂 JavaBean 结构的场景，例如动态获取属性值或调用方法。
• 通用 Bean 操作工具：BeanDesc 可以用作一个通用的工具类，在不同的业务场景下处理各种类型的 JavaBean。

常用方法

1. 获取字段和 Getter/Setter 方法

示例：获取字段和对应的 Getter/Setter 方法

import cn.hutool.core.bean.BeanDesc;
import cn.hutool.core.bean.BeanUtil;

public class BeanDescExample {
    public static void main(String[] args) {
        // 获取 Bean 描述
        BeanDesc desc = BeanUtil.getBeanDesc(User.class);

        // 获取简单类名
        System.out.println("Class Simple Name: " + desc.getSimpleName()); // 输出：User

        // 获取字段名和对应的 Getter/Setter 方法
        System.out.println("Field Name: " + desc.getField("age").getName()); // 输出：age
        System.out.println("Getter Method: " + desc.getGetter("age").getName()); // 输出：getAge
        System.out.println("Setter Method: " + desc.getSetter("age").getName()); // 输出：setAge
    }
}

关键点：

• getField(String fieldName)：获取指定字段。
• getGetter(String fieldName)：获取指定字段的 Getter 方法。
• getSetter(String fieldName)：获取指定字段的 Setter 方法。

作用：快速获取 JavaBean 中的字段及其对应的 Getter/Setter 方法。

2. 处理 Boolean 字段

示例：处理 Boolean 字段

import cn.hutool.core.bean.BeanDesc;
import cn.hutool.core.bean.BeanUtil;

public class BeanDescExample {
    public static void main(String[] args) {
        // 获取 Bean 描述
        BeanDesc desc = BeanUtil.getBeanDesc(User.class);

        // 获取 boolean 类型字段的 Getter 方法
        System.out.println("Boolean Getter (isAdmin): " + desc.getGetter("isAdmin").getName()); // 输出：isAdmin
        System.out.println("Boolean Getter (isSuper): " + desc.getGetter("isSuper").getName()); // 输出：isIsSuper
    }
}

关键点：

• 对于 boolean 字段，BeanDesc 能够识别常见的 isXXX 格式的 Getter 方法。
• 支持 isIsXXX 这种特殊格式的 Getter 方法。

作用：处理 JavaBean 中 boolean 类型字段的特殊情况，确保能够正确解析 Getter 方法。

3. 字段属性赋值

示例：使用 BeanDesc 为字段赋值

import cn.hutool.core.bean.BeanDesc;
import cn.hutool.core.bean.BeanUtil;

public class BeanDescExample {
    public static void main(String[] args) {
        // 获取 Bean 描述
        BeanDesc desc = BeanUtil.getBeanDesc(User.class);

        // 创建 User 实例
        User user = new User();

        // 通过 BeanDesc 动态设置属性值
        desc.getProp("name").setValue(user, "张三");

        // 验证赋值结果
        System.out.println("User Name: " + user.getName()); // 输出：张三
    }
}

关键点：

• getProp(String fieldName)：获取指定字段的属性描述。
• setValue(Object bean, Object value)：为指定字段动态设置值。

作用：在动态场景下，通过反射机制为 JavaBean 字段赋值。

完整示例

下面是一个完整的示例，展示了如何使用 BeanDesc 解析复杂 JavaBean 中的字段、Getter 和 Setter 方法：

import cn.hutool.core.bean.BeanDesc;
import cn.hutool.core.bean.BeanUtil;
import lombok.Data;

public class BeanDescExample {
    public static void main(String[] args) {
        // 获取 Bean 描述
        BeanDesc desc = BeanUtil.getBeanDesc(User.class);

        // 获取类名
        System.out.println("Class Simple Name: " + desc.getSimpleName()); // 输出：User

        // 获取字段信息
        System.out.println("Field Name: " + desc.getField("age").getName()); // 输出：age

        // 获取 Getter 和 Setter 方法
        System.out.println("Getter Method: " + desc.getGetter("age").getName()); // 输出：getAge
        System.out.println("Setter Method: " + desc.getSetter("age").getName()); // 输出：setAge

        // 处理 boolean 字段
        System.out.println("Boolean Getter (isAdmin): " + desc.getGetter("isAdmin").getName()); // 输出：isAdmin
        System.out.println("Boolean Getter (isSuper): " + desc.getGetter("isSuper").getName()); // 输出：isIsSuper

        // 动态设置属性值
        User user = new User();
        desc.getProp("name").setValue(user, "张三");
        System.out.println("User Name: " + user.getName()); // 输出：张三
    }

    @Data
    public static class User {
        private String name;
        private int age;
        private boolean isAdmin;
        private boolean isSuper;
        private boolean gender;

        @Override
        public String toString() {
            return "User [name=" + name + ", age=" + age + ", isAdmin=" + isAdmin + ", gender=" + gender + "]";
        }
    }
}

总结

BeanDesc 工具类通过封装 JavaBean 的字段、Getter 和 Setter 方法，使得动态解析和操作 JavaBean 变得更加灵活和简单。它适用于：

• 反射场景：需要动态访问和操作 JavaBean 属性的场景。
• 复杂 Bean 解析：当 JavaBean 包含复杂的嵌套结构时，BeanDesc 可以简化属性访问和赋值的操作。