递归BeanUtils.describe()

时间:2011-05-26 04:26:08

标签: java reflection apache-commons-beanutils

是否有BeanUtils.describe(customer)版本以'customer'的复杂属性递归调用describe()方法。

class Customer {

String id;
Address address;

}

在这里,我想使用describe方法来检索address属性的内容。

目前,我所有人都可以看到该课程的名称如下:

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

3 个答案:

答案 0 :(得分:11)

有趣的是,我想使用describe方法来检索嵌套属性的内容,我不明白为什么它没有。不过,我继续前进并自己动手。在这里,你可以打电话:

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

有几点需要注意。

  1. 我不知道公共BeanUtils如何在集合中格式化属性,所以我选择了“attribute [index]”。
  2. 我不确定它是如何在地图中格式化属性的,所以我选择了“attribute [key]”。
  3. 对于名称冲突,优先级如下:第一个属性从超类的字段加载,然后从类加载,然后从getter方法加载。
  4. 我没有分析这种方法的表现。如果您的对象包含大量对象也包含集合,则可能会出现一些问题。
  5. 这是alpha代码,不是没有bug的。
  6. 我假设你有最新版本的commons beanutils
  7. 另外,fyi,这大致取自我一直在致力于的项目,亲切地,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);
            }
        }
    }
    

答案 1 :(得分:7)

挑战(或显示停止)是我们必须处理对象图形而不是简单树的问题。图形可能包含循环,需要在递归算法中为停止条件开发一些自定义规则或要求。

看看一个死的简单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)}}

并遇到StackOverflowError,因为一次又一次地使用对象root,A和B调用describe。

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

答案 2 :(得分:4)

您可以从相同的commom-beanutils中轻松使用:

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

返回指定bean提供read方法的整个属性集。