如何运用Java动态获取对象属性的方法及实战技巧？

本文共计1547个文字，预计阅读时间需要7分钟。

在 HTML 中，使用 `` 标签创建超链接，可以设置 `style` 属性来自定义链接的样式。以下是一个示例，展示如何通过 `style` 属性改变链接的文本颜色：

Apache Commons BeanUtils：解决方案概览

Apache Commons BeanUtils是一个强大的工具库，旨在简化JavaBean属性的操作。它提供了一套易于使用的API，可以帮助开发者动态地获取、设置和描述Java对象的属性，而无需直接操作底层的Java反射API。这大大提高了代码的可读性和开发效率。

引入依赖

要在项目中使用Apache Commons BeanUtils，您需要将其作为依赖添加到您的构建配置中。

Maven:

<dependency> <groupId>commons-beanutils</groupId> <artifactId>commons-beanutils</artifactId> <version>1.9.4</version> </dependency>

Gradle:

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

implementation 'commons-beanutils:commons-beanutils:1.9.4'

请确保使用最新稳定版本。

核心功能：动态获取单个属性

Apache Commons BeanUtils库中的PropertyUtils类提供了丰富的静态方法来操作JavaBean的属性。其中，PropertyUtils.getProperty(Object bean, String name)方法是获取单个属性值的核心API。

示例类定义：

我们以一个简单的Emp类为例，演示如何使用PropertyUtils。

public class Emp { private int id; private String msisdn; public Emp() { } public Emp(int id, String msisdn) { this.id = id; this.msisdn = msisdn; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getMsisdn() { return msisdn; } public void setMsisdn(String msisdn) { this.msisdn = msisdn; } }

使用 PropertyUtils.getProperty() 获取单个属性：

import org.apache.commons.beanutils.PropertyUtils; public class PropertyAccessDemo { public static void main(String[] args) { Emp emp = new Emp(1, "1404850126"); try { // 获取 'id' 属性 Object idValue = PropertyUtils.getProperty(emp, "id"); System.out.println(String.format("ID: %s", idValue)); // 输出: ID: 1 // 获取 'msisdn' 属性 String msisdnValue = (String) PropertyUtils.getProperty(emp, "msisdn"); System.out.println(String.format("MSISDN: %s", msisdnValue)); // 输出: MSISDN: 1404850126 } catch (Exception e) { e.printStackTrace(); } } }

在上述代码中，我们通过传入对象实例和属性名（字符串形式），即可动态地获取到对应的属性值。getProperty方法返回Object类型，需要根据实际属性类型进行强制类型转换。

进阶应用：遍历并格式化所有属性

在某些场景下，我们需要像C#示例那样，遍历一个对象的所有属性并将其格式化为字符串。PropertyUtils.describe(Object bean)方法是实现这一目标的关键。它返回一个Map<String, Object>，其中键是属性名，值是对应的属性值。

C# 示例回顾：

C#中的GetProperty方法通过obj.GetType().GetProperties()遍历所有公共属性，并拼接成字符串：

public string GetProperty<T>(T obj) { var s = string.Empty; var t = obj.GetType(); foreach (var pi in t.GetProperties()) s += " " + pi.Name + ":" + pi.GetValue(obj, null); return s; }

期望输出格式：Id:1 Msisdn:1404850126

使用 PropertyUtils.describe() 在Java中实现：

import org.apache.commons.beanutils.PropertyUtils; import java.util.Map; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.beans.PropertyDescriptor; public class ObjectPropertyFormatter { /** * 将Java对象的所有属性（遵循JavaBean规范）格式化为字符串。 * 格式为 " 属性名:属性值 属性名:属性值..." * @param obj 要格式化的对象 * @return 格式化后的字符串 * @throws Exception 如果在访问属性时发生错误 */ public static String convertObjectPropertiesToString(Object obj) throws Exception { if (obj == null) { return ""; } StringBuilder s = new StringBuilder(); // 使用 PropertyUtils.describe() 获取所有属性的名称和值 Map<String, Object> properties = PropertyUtils.describe(obj); for (Map.Entry<String, Object> entry : properties.entrySet()) { String propertyName = entry.getKey(); Object propertyValue = entry.getValue(); // 排除 'class' 属性，这是所有Java对象都带有的属性 if (!"class".equals(propertyName)) { // 拼接字符串，注意PropertyUtils.describe()对于null值会返回null s.append(" ").append(propertyName).append(":").append(propertyValue); } } // 移除开头的空格并返回 return s.toString().trim(); } public static void main(String[] args) { Emp emp = new Emp(); emp.setId(1); emp.setMsisdn("1404850126"); try { String formattedString = convertObjectPropertiesToString(emp); System.out.println(formattedString); // 期望输出: Id:1 Msisdn:1404850126 } catch (Exception e) { e.printStackTrace(); } } }

在上述代码中，convertObjectPropertiesToString方法利用PropertyUtils.describe()获取一个Map，然后遍历这个Map来构建最终的字符串。我们特别排除了"class"属性，因为它是所有Java对象固有的，通常不属于业务属性。

注意事项与最佳实践

1. 异常处理： PropertyUtils的大多数方法都声明抛出IllegalAccessException、InvocationTargetException和NoSuchMethodException等受检异常。在实际应用中，务必进行适当的异常捕获和处理，以增强程序的健壮性。
2. 性能考量： 反射操作（包括BeanUtils内部使用的反射）通常比直接方法调用慢。对于性能敏感的循环或高频操作，应谨慎使用动态属性访问。如果可能，优先考虑直接方法调用或预先生成的代码。
3. 属性访问权限： PropertyUtils遵循JavaBean规范，主要通过公共的getter/setter方法访问属性。对于只有字段而没有getter/setter的私有属性，PropertyUtils可能无法直接访问。如果需要访问私有字段，可能需要直接使用Java的反射API。
4. 空值处理： PropertyUtils.describe()返回的Map中，如果属性值为null，则Map中的对应值也将是null。在拼接字符串时，需要考虑null值的表示方式，上述示例直接将null转换为字符串"null"。
5. 替代方案： 如果仅仅是为了生成对象的字符串表示，并且对象结构相对固定，可以考虑：
   • 重写 toString() 方法： 这是Java对象最常见的字符串表示方式。
   • 使用JSON库： 如Jackson或Gson，将对象序列化为JSON字符串，这通常更通用且易于解析。
   • Lombok的 @ToString： 如果使用Lombok，可以方便地自动生成toString()方法。

总结

Apache Commons BeanUtils库为Java开发者提供了一个强大且易用的工具集，用于动态操作JavaBean的属性。通过PropertyUtils.getProperty()可以轻松获取单个属性值，而PropertyUtils.describe()则能方便地获取对象的所有属性名称和值，从而实现类似C#中遍历所有属性的功能。在利用这些工具时，理解其工作原理、注意异常处理和性能考量，将有助于编写出更健壮、高效的Java代码。