java为对象添加属性_使用cglib 动态为对象增加属性

一. 目的

有时候我们可能面临这样的需求，即在运行时给一个对象增加属性，或者在运行时创建一个对象，一个应用场景就是使用AspectJ 在一个方法中插入代码，并为该方法的返回值对象增加属性。

二. 实现

import net.sf.cglib.beans.BeanGenerator;

import net.sf.cglib.beans.BeanMap;

import org.apache.commons.beanutils.PropertyUtilsBean;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import java.beans.PropertyDescriptor;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

public class AddPropertiesUtil {

private static Logger logger = LoggerFactory.getLogger(AddPropertiesUtil.class);

/**

* 动态为对象增加属性

*

* @param dest 要增加属性的对象

* @param addProperties 要增加的属性名及值，属性名可以和原有属性重名，但如果重名的话，值的类型必须一致，否则抛异常

* @param discardOldValue 是否舍弃原有属性的值，如果true，则原有属性的值将都被置为默认值

* @return 返回增加了属性的新对象

*/

public static Object addProperties(Object dest, Map addProperties, boolean discardOldValue) {

Map propertyMap = new HashMap<>();

PropertyUtilsBean utilsBean = new PropertyUtilsBean();

PropertyDescriptor[] descriptors = utilsBean.getPropertyDescriptors(dest);

for (PropertyDescriptor desc : descriptors) {

if (!"class".equalsIgnoreCase(desc.getName())) {

propertyMap.put(desc.getName(), desc.getPropertyType());

}

}

addProperties.forEach((k, v) -> propertyMap.put(k, v.getClass()));

DynamicBean dynamicBean = new DynamicBean(dest.getClass(), propertyMap);

// 添加旧属性值

if (!discardOldValue) {

propertyMap.forEach((k, v) -> {

try {

if (!addProperties.containsKey(k)) {

dynamicBean.setValue(k, utilsBean.getNestedProperty(dest, k));

}

} catch (Exception e) {

throw new RuntimeException("对象添加旧属性失败，" + e.getMessage());

}

});

}

// 添加新属性值

addProperties.forEach((k, v) -> {

try {

dynamicBean.setValue(k, v);

} catch (Exception e) {

throw new RuntimeException("对象添加新属性失败，" + e.getMessage());

}

});

return dynamicBean.getTarget();

}

public static class DynamicBean {

/**

* 目标对象

*/

private Object target;

/**

* 属性集合

*/

private BeanMap beanMap;

public DynamicBean(Class superClass, Map propertyMap) {

this.target = generateBean(superClass, propertyMap);

this.beanMap = BeanMap.create(this.target);

}

/**

* 添加属性和值

*/

public void setValue(String property, Object value) {

beanMap.put(property, value);

}

/**

* 获取属性值

*/

public Object getValue(String property) {

return beanMap.get(property);

}

/**

* 获取对象

*/

public Object getTarget() {

return this.target;

}

/**

* 根据属性生成对象

*/

private Object generateBean(Class superClass, Map propertyMap) {

BeanGenerator generator = new BeanGenerator();

if (superClass != null) {

generator.setSuperclass(superClass);

}

BeanGenerator.addProperties(generator, propertyMap);

return generator.create();

}

}

}

上面这个类主要用到的有cglib 的BeanGenerator、BeanMap 和 Apache 的工具类 PropertyUtilsBean。在使用时，直接调用addProperties 方法即可，但是这个实现方式有一定的局限性，那就是，

要想完整地保留对象的原有属性值，那么这个类的属性一定要有对应的getter 和setter，同时，属性和getter、setter 的命名一定要符合Java bean 的命名规范，否则就会丢失数据。