java - 递归 BeanUtils.describe()

Question

是否有一个版本的BeanUtils.describe(customer)递归调用“客户”的复杂属性上的 describe() 方法。

class Customer {

String id;
Address address;

}

在这里，我也希望使用 describe 方法来检索地址属性的内容。

目前，我所拥有的都可以看到类的名称如下：

{id=123, address=com.test.entities.Address@2a340e}

Answer 1

有趣的是，我也想要 describe 方法来检索嵌套属性的内容，我不明白为什么它不这样做。不过，我继续前进并推出了自己的产品。在这里，您可以调用：

Map<String,String> beanMap = BeanUtils.recursiveDescribe(customer); 

几个警告。

1. 我不确定 BeanUtils 如何在集合中格式化属性，所以我选择了“attribute [index]”。
2. 我不确定它如何格式化地图中的属性，所以我选择了“attribute [key]”。
3. 对于名称冲突，优先级如下：首先从超类的字段中加载属性，然后是类，然后是 getter 方法。
4. 我没有分析这种方法的性能。如果您的对象包含大量对象集合，其中还包含集合，您可能会遇到一些问题。
5. 这是 alpha 代码，不能保证没有错误。
6. 我假设您拥有最新版本的 commons beanutils

另外，仅供参考，这大致取自我一直在从事的一个项目，亲切地称为java in jails，因此您可以下载它然后运行：

Map<String, String[]> beanMap = new SimpleMapper().toMap(customer);

不过，您会注意到它返回的是 String[]，而不是 String，这可能无法满足您的需要。无论如何，下面的代码应该可以工作，所以开始吧！

public class BeanUtils {
    public static Map<String, String> recursiveDescribe(Object object) {
        Set cache = new HashSet();
        return recursiveDescribe(object, null, cache);
    }

    private static Map<String, String> recursiveDescribe(Object object, String prefix, Set cache) {
        if (object == null || cache.contains(object)) return Collections.EMPTY_MAP;
        cache.add(object);
        prefix = (prefix != null) ? prefix + "." : "";

        Map<String, String> beanMap = new TreeMap<String, String>();

        Map<String, Object> properties = getProperties(object);
        for (String property : properties.keySet()) {
            Object value = properties.get(property);
            try {
                if (value == null) {
                    //ignore nulls
                } else if (Collection.class.isAssignableFrom(value.getClass())) {
                    beanMap.putAll(convertAll((Collection) value, prefix + property, cache));
                } else if (value.getClass().isArray()) {
                    beanMap.putAll(convertAll(Arrays.asList((Object[]) value), prefix + property, cache));
                } else if (Map.class.isAssignableFrom(value.getClass())) {
                    beanMap.putAll(convertMap((Map) value, prefix + property, cache));
                } else {
                    beanMap.putAll(convertObject(value, prefix + property, cache));
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return beanMap;
    }

    private static Map<String, Object> getProperties(Object object) {
        Map<String, Object> propertyMap = getFields(object);
        //getters take precedence in case of any name collisions
        propertyMap.putAll(getGetterMethods(object));
        return propertyMap;
    }

    private static Map<String, Object> getGetterMethods(Object object) {
        Map<String, Object> result = new HashMap<String, Object>();
        BeanInfo info;
        try {
            info = Introspector.getBeanInfo(object.getClass());
            for (PropertyDescriptor pd : info.getPropertyDescriptors()) {
                Method reader = pd.getReadMethod();
                if (reader != null) {
                    String name = pd.getName();
                    if (!"class".equals(name)) {
                        try {
                            Object value = reader.invoke(object);
                            result.put(name, value);
                        } catch (Exception e) {
                            //you can choose to do something here
                        }
                    }
                }
            }
        } catch (IntrospectionException e) {
            //you can choose to do something here
        } finally {
            return result;
        }

    }

    private static Map<String, Object> getFields(Object object) {
        return getFields(object, object.getClass());
    }

    private static Map<String, Object> getFields(Object object, Class<?> classType) {
        Map<String, Object> result = new HashMap<String, Object>();

        Class superClass = classType.getSuperclass();
        if (superClass != null) result.putAll(getFields(object, superClass));

        //get public fields only
        Field[] fields = classType.getFields();
        for (Field field : fields) {
            try {
                result.put(field.getName(), field.get(object));
            } catch (IllegalAccessException e) {
                //you can choose to do something here
            }
        }
        return result;
    }

    private static Map<String, String> convertAll(Collection<Object> values, String key, Set cache) {
        Map<String, String> valuesMap = new HashMap<String, String>();
        Object[] valArray = values.toArray();
        for (int i = 0; i < valArray.length; i++) {
            Object value = valArray[i];
            if (value != null) valuesMap.putAll(convertObject(value, key + "[" + i + "]", cache));
        }
        return valuesMap;
    }

    private static Map<String, String> convertMap(Map<Object, Object> values, String key, Set cache) {
        Map<String, String> valuesMap = new HashMap<String, String>();
        for (Object thisKey : values.keySet()) {
            Object value = values.get(thisKey);
            if (value != null) valuesMap.putAll(convertObject(value, key + "[" + thisKey + "]", cache));
        }
        return valuesMap;
    }

    private static ConvertUtilsBean converter = BeanUtilsBean.getInstance().getConvertUtils();

    private static Map<String, String> convertObject(Object value, String key, Set cache) {
        //if this type has a registered converted, then get the string and return
        if (converter.lookup(value.getClass()) != null) {
            String stringValue = converter.convert(value);
            Map<String, String> valueMap = new HashMap<String, String>();
            valueMap.put(key, stringValue);
            return valueMap;
        } else {
            //otherwise, treat it as a nested bean that needs to be described itself
            return recursiveDescribe(value, key, cache);
        }
    }
}

Answer 2

挑战（或显示停止器）是我们必须处理对象图而不是简单树的问题。图可能包含循环，这需要为递归算法中的停止标准开发一些自定义规则或要求。

看看一个死的简单 bean（树结构，getter 被假定但未显示）：

public class Node {
   private Node parent;
   private Node left;
   private Node right;
}

并像这样初始化它：

        root
        /  \
       A    B

现在调用描述root。非递归调用将导致

{parent=null, left=A, right=B}

相反，递归调用会执行

1: describe(root) =>
2: {parent=describe(null), left=describe(A), right=describe(B)} =>
3: {parent=null, 
     {A.parent=describe(root), A.left=describe(null), A.right= describe(null)}
     {B.parent=describe(root), B.left=describe(null), B.right= describe(null)}}

并遇到 aStackOverflowError因为 describe 被对象 root、A 和 B 一遍又一遍地调用。

自定义实现的一种解决方案可能是记住到目前为止已描述的所有对象（将这些实例记录在一个集合中，如果 set.contains(bean) 返回 true，则停止）并在结果对象中 存储某种链接。

Answer 3

您可以从相同的 commom-beanutils 简单使用：

Map<String, Object> result = PropertyUtils.describe(obj);

返回指定 bean 为其提供读取方法的整个属性集。