Java中动态获取对象属性：使用Apache Commons BeanUtils-java教程-PHP中文网

Java中动态获取对象属性：使用Apache Commons BeanUtils

聖光之護

发布： 2025-09-14 12:01:52

原创

326人浏览过

java中动态获取对象属性：使用apache commons beanutils

本文旨在指导开发者如何在Java中高效、动态地获取对象属性，以应对类似C#中反射机制的需求。我们将深入探讨Java的反射机制，并重点介绍如何利用Apache Commons BeanUtils库中的PropertyUtils工具类，简化属性的读取与遍历操作，并提供详细的代码示例及使用注意事项。

引言：Java中动态属性访问的需求

在软件开发中，我们经常会遇到需要动态访问对象属性的场景。例如，在实现通用数据序列化、ORM框架、配置解析、或构建通用工具方法时，我们可能无法预知对象的具体类型及其属性名称，需要通过编程方式在运行时获取或设置这些属性。C#语言提供了简洁的反射机制，通过GetType()、GetProperties()等方法可以方便地实现这一功能。在Java中，虽然核心库也提供了反射（java.lang.reflect包），但其API相对底层，直接使用可能较为繁琐。

Java反射机制与传统方法

Java的反射机制允许程序在运行时检查或修改其自身的行为。通过Class对象，我们可以获取类的Field（字段）和Method（方法），进而访问或修改私有成员，或者调用方法。

例如，要获取一个对象的某个字段值，通常需要以下步骤：

获取对象的Class实例。
通过Class.getDeclaredField(String name)获取Field对象。
设置Field.setAccessible(true)以访问私有字段。
通过Field.get(Object obj)获取字段值。

这种方式对于单个字段尚可接受，但如果需要遍历所有属性并获取其值，或者遵循JavaBeans的getter/setter约定，代码会变得冗长且易出错。特别是在处理JavaBeans属性（通过getter/setter方法访问）时，直接操作Field可能无法正确处理逻辑。

立即学习“Java免费学习笔记（深入）”；

Apache Commons BeanUtils：简化之道

为了解决Java反射API的复杂性，Apache Commons项目提供了一系列实用工具，其中Commons BeanUtils库专门用于简化JavaBeans属性的操作。PropertyUtils是BeanUtils库中的一个核心类，它提供了一套简洁的API，用于读取、写入和检查JavaBeans的属性。它遵循JavaBeans的命名约定（例如，属性name对应getName()和setName()方法），大大简化了动态属性访问的实现。

Maven/Gradle依赖

在使用PropertyUtils之前，您需要在项目的构建文件中添加Apache Commons BeanUtils的依赖。

Maven:

Chromox

Chromox是一款领先的AI在线生成平台，专为喜欢AI生成技术的爱好者制作的多种图像、视频生成方式的内容型工具平台。

184

查看详情

<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.9.4</version> <!-- 请使用最新稳定版本 -->
</dependency>

登录后复制

Gradle:

implementation 'commons-beanutils:commons-beanutils:1.9.4' // 请使用最新稳定版本

登录后复制

核心实践：动态获取对象属性值

我们将通过一个具体的Emp类示例来演示PropertyUtils的用法。

定义示例对象 Emp

public class Emp {
    private int Id;
    private String Msisdn;

    // 构造函数
    public Emp() {}

    public Emp(int id, String msisdn) {
        this.Id = id;
        this.Msisdn = msisdn;
    }

    // Getter和Setter方法
    public int getId() {
        return Id;
    }

    public void setId(int id) {
        Id = id;
    }

    public String getMsisdn() {
        return Msisdn;
    }

    public void setMsisdn(String msisdn) {
        Msisdn = msisdn;
    }

    @Override
    public String toString() {
        return "Emp{" +
               "Id=" + Id +
               ", Msisdn='" + Msisdn + '\'' +
               '}';
    }
}

登录后复制

获取单个属性值

PropertyUtils.getProperty(Object bean, String name)方法允许我们通过属性名获取指定对象的属性值。

import org.apache.commons.beanutils.PropertyUtils;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class PropertyAccessExample {

    public static void main(String[] args) {
        Emp emp = new Emp();
        emp.setId(1);
        emp.setMsisdn("1404850126");

        try {
            // 获取单个属性值
            String msisdnValue = (String) PropertyUtils.getProperty(emp, "msisdn");
            System.out.println("通过PropertyUtils获取 Msisdn: " + msisdnValue);

            Integer idValue = (Integer) PropertyUtils.getProperty(emp, "id");
            System.out.println("通过PropertyUtils获取 Id: " + idValue);

        } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
            System.err.println("获取属性时发生错误: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

登录后复制

运行上述代码将输出：

通过PropertyUtils获取 Msisdn: 1404850126
通过PropertyUtils获取 Id: 1

登录后复制

获取所有属性及其值（实现C#示例功能）

为了实现类似C#中遍历所有属性并构建字符串的功能，我们可以结合PropertyUtils.getPropertyDescriptors(Object bean)方法来获取所有可读属性的描述符，然后逐一获取其值。

import org.apache.commons.beanutils.PropertyUtils;
import java.beans.PropertyDescriptor;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.List;

public class DynamicPropertyAccess {

    /**
     * 获取泛型对象的所有属性及其值，并格式化为字符串。
     * 类似于C#中的 GetProperty<T>(T obj) 方法。
     *
     * @param obj 待处理的泛型对象
     * @return 包含所有属性名和值的格式化字符串
     */
    public static <T> String convertObjectPropertiesToString(T obj) {
        if (obj == null) {
            return "";
        }

        StringBuilder s = new StringBuilder();
        try {
            // 获取对象的所有属性描述符
            PropertyDescriptor[] descriptors = PropertyUtils.getPropertyDescriptors(obj);

            for (PropertyDescriptor pd : descriptors) {
                String propertyName = pd.getName();
                // 排除class属性，它通常不是我们关注的业务属性
                if ("class".equals(propertyName)) {
                    continue;
                }

                // 检查属性是否有可读方法 (getter)
                if (PropertyUtils.isReadable(obj, propertyName)) {
                    Object propertyValue = PropertyUtils.getProperty(obj, propertyName);
                    if (s.length() > 0) {
                        s.append("  "); // 添加分隔符
                    }
                    s.append(propertyName).append(":").append(propertyValue);
                }
            }
        } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
            System.err.println("处理对象属性时发生错误: " + e.getMessage());
            e.printStackTrace();
            return "Error processing properties.";
        }
        return s.toString();
    }

    public static void main(String[] args) {
        Emp emp = new Emp();
        emp.setId(1);
        emp.setMsisdn("1404850126");

        String resultString = convertObjectPropertiesToString(emp);
        System.out.println("格式化后的属性字符串: " + resultString);

        // 另一个对象示例
        class Product {
            private String name;
            private double price;

            public Product(String name, double price) {
                this.name = name;
                this.price = price;
            }

            public String getName() { return name; }
            public void setName(String name) { this.name = name; }
            public double getPrice() { return price; }
            public void setPrice(double price) { this.price = price; }
        }

        Product product = new Product("Laptop", 1200.50);
        String productString = convertObjectPropertiesToString(product);
        System.out.println("格式化后的产品属性字符串: " + productString);
    }
}

登录后复制

运行上述代码，将得到与C#示例相似的输出：

格式化后的属性字符串: Id:1  Msisdn:1404850126
格式化后的产品属性字符串: Name:Laptop  Price:1200.5

登录后复制

注意事项与最佳实践

异常处理: PropertyUtils的方法可能会抛出IllegalAccessException (访问权限问题)、InvocationTargetException (getter/setter方法内部抛出的异常) 和 NoSuchMethodException (找不到对应的getter/setter方法)。在生产代码中，应捕获这些具体的异常并进行适当的处理，而不是简单地捕获泛型Exception。
性能考量: 虽然PropertyUtils简化了API，但底层依然依赖Java反射机制。反射操作通常比直接方法调用慢。如果需要在性能敏感的场景中频繁访问属性，可以考虑缓存PropertyDescriptor或直接缓存Method对象以减少重复查找的开销。对于极高性能要求，可能需要权衡使用代码生成或手动编写访问器。
属性命名约定: PropertyUtils严格遵循JavaBeans的命名约定。例如，对于属性foo，它会查找getFoo()和setFoo()方法。如果您的类不遵循这些约定，PropertyUtils可能无法正确识别和操作属性。
只读/只写属性: PropertyUtils.isReadable(obj, propertyName)和PropertyUtils.isWriteable(obj, propertyName)方法可以用来检查属性是否具有对应的getter或setter方法，从而判断属性是否可读或可写。
嵌套属性: PropertyUtils也支持访问嵌套属性，例如PropertyUtils.getProperty(bean, "user.address.city")。
安全性: 反射机制能够绕过Java的访问控制，但PropertyUtils通常会通过公共的getter/setter方法进行操作，因此在默认情况下，它会尊重访问修饰符。

总结

Apache Commons BeanUtils库的PropertyUtils类为Java开发者提供了一种强大且简洁的方式来动态访问和操作JavaBeans的属性。它极大地简化了原本复杂的反射操作，使得在通用工具、框架或需要运行时属性操作的场景中，代码更加清晰、易于维护。通过理解其工作原理和遵循最佳实践，开发者可以高效地利用这一工具来提升开发效率。

以上就是Java中动态获取对象属性：使用Apache Commons BeanUtils的详细内容，更多请关注php中文网其它相关文章！