登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  java教程

Java Introspector 怎样取得 JavaBean 的属性描述

来源:17golang原创

时间:2026-10-30 18:46:55 447浏览 收藏

Java 可以先调用 Introspector.getBeanInfo(BeanClass.class, Object.class) 取得 BeanInfo,再遍历 getPropertyDescriptors()。每个 PropertyDescriptor 提供属性名、属性类型以及读写方法。需要排除 Object 层信息时,使用带 stopClass 的重载,比把所有私有字段都当作属性更贴近 JavaBean 访问约定。

官方地址:https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/beans/Introspector.html

从访问方法识别属性,而不是扫描字段

Introspector 适合回答“这个 Bean 向外提供哪些属性”。它会利用显式 BeanInfo 或标准访问方法模式来形成描述信息。因此属性与存储字段不是一一对应:一个 getter 可以计算返回值,一个私有字段也可能没有对外属性接口。

例如报表工具需要列出可读属性,扫描 getDeclaredFields 并不等同于这个目标。把字段扫描改成属性描述扫描,是在调整工具的接口模型,并不是本文声称 Java 新发布了一项能力。

Bean类内省信息与属性描述器的关系
静态结构说明图:目标类和访问方法提供内省信息,BeanInfo 包含属性描述,不代表实际执行结果。

取得 BeanInfo 并遍历描述器

下面的原创示例包含普通 label 属性和只读 delivered 属性。重点是取得描述器后分别读取元数据,不会实际调用 getter,也不需要为了查看描述创建 Parcel 实例。示例未在本机执行。

import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;

public class BeanPropertyDemo {
    public static class Parcel {
        private String label;
        private boolean delivered;

        // 普通属性使用成对访问方法。
        public String getLabel() { return label; }
        public void setLabel(String label) { this.label = label; }

        // 布尔只读属性没有 setter。
        public boolean isDelivered() { return delivered; }
    }

    public static void main(String[] args) {
        try {
            // 排除 Object 层的信息,避免把 class 当作业务属性。
            BeanInfo info = Introspector.getBeanInfo(Parcel.class, Object.class);
            for (PropertyDescriptor pd : info.getPropertyDescriptors()) {
                Class> type = pd.getPropertyType();
                Method read = pd.getReadMethod();
                Method write = pd.getWriteMethod();
                // 描述器可能只有读方法或写方法,输出前分别判空。
                System.out.printf("%s type=%s read=%s write=%s%n",
                    pd.getName(), type == null ? "未知" : type.getTypeName(),
                    read == null ? "-" : read.getName(),
                    write == null ? "-" : write.getName());
            }
        } catch (IntrospectionException ex) {
            // 保留原始异常,不能把内省失败当作没有属性。
            throw new IllegalStateException("无法取得属性描述", ex);
        }
    }
}

对于这个示例,应关注 label 的 getLabel/setLabel 与 delivered 的 isDelivered。不要依赖遍历顺序来决定表单字段顺序;需要稳定顺序时,在应用配置中明确排序规则。演示把类型返回值也做了判空,以免把所有属性形态都假设成简单标量属性。

分别判断属性是否可读可写

元数据获取方法使用方式
名称getName()作为属性标识
类型getPropertyType()判断组件需要的类型信息
读方法getReadMethod()非空才说明有读取入口
写方法getWriteMethod()非空才说明有写入入口

只读属性并不是异常;状态展示可以使用它,编辑器则不应为它生成可提交的输入项。只写属性同理,不应假定它能被读回。若接下来要反射调用方法,应另行处理调用异常与业务副作用,取得 Method 元数据不意味着已经调用成功。

属性描述中的读写方法与应用用途
静态说明图:读写方法分别决定可读和可写能力,应用应按自己的用途筛选,不能仅凭描述器存在就允许编辑。

改造旧扫描代码时保留命名约定

旧实现若把 get 前缀删除后强制全部转小写,可能改变缩写属性的名字。Introspector 的 decapitalize 规则对开头连续大写字母有特殊处理,例如 URL 不应被简单转换成 url。接入后优先使用描述器给出的名称,避免再做一次自定义命名猜测。

带 Object.class 的 stopClass 用来限定继承分析范围,不是“只看当前类字段”。业务父类中的访问属性仍需要按目标继承模型理解。若项目提供了自定义 BeanInfo,描述结果也可能与单纯的方法命名推导不同,排查时应一起检查。

java.beans 位于 java.desktop 模块;采用命名模块的项目需要在自己的模块依赖中考虑它。不要因为类名里没有图形界面字样,就误以为它属于 java.base。

用预期属性集合确认接入范围

接入时先列出工具需要的属性及读写能力:示例 label 允许读写,delivered 用于只读展示,class 不进入业务清单。再比较实际描述器是否满足这些预期。这里只给出可核对的预期,不附上伪造运行日志。

属性元数据可以帮助生成展示或映射,但不能自动决定业务字段是否允许外部提交。实际可编辑属性仍应由应用明确配置,不能把所有可写描述器都当成公开写入接口。

没有 setter 会导致属性消失吗?

不应这样推断。只读属性可以有读方法而没有写方法,应分别判断。

取属性描述需要创建对象吗?

本文通过 Class 取得元数据;读取某个实例的属性值属于后续另一项操作。

为什么结果与私有字段清单不一样?

JavaBean 属性描述面向访问约定和 BeanInfo,不等同于字段存储布局。

参考:Java Introspector 官方 API、PropertyDescriptor 官方 API。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>