一. 目的
有時候我們可能面臨這樣的需求,即在運行時給一個對象增加屬性,或者在運行時創(chuàng)建一個對象,一個應(yīng)用場景就是使用AspectJ 在一個方法中插入代碼,并為該方法的返回值對象增加屬性。
二. 實現(xiàn)
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);
/**
* 動態(tài)為對象增加屬性
*
* @param dest 要增加屬性的對象
* @param addProperties 要增加的屬性名及值,屬性名可以和原有屬性重名,但如果重名的話,值的類型必須一致,否則拋異常
* @param discardOldValue 是否舍棄原有屬性的值,如果true,則原有屬性的值將都被置為默認(rèn)值
* @return 返回增加了屬性的新對象
*/
public static Object addProperties(Object dest, Map<String, Object> addProperties, boolean discardOldValue) {
Map<String, Class> 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 {
/**
* 目標(biāo)對象
*/
private Object target;
/**
* 屬性集合
*/
private BeanMap beanMap;
public DynamicBean(Class superClass, Map<String, Class> 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;
}
/**
* 根據(jù)屬性生成對象
*/
private Object generateBean(Class superClass, Map<String, Class> propertyMap) {
BeanGenerator generator = new BeanGenerator();
if (superClass != null) {
generator.setSuperclass(superClass);
}
BeanGenerator.addProperties(generator, propertyMap);
return generator.create();
}
}
}
上面這個類主要用到的有cglib 的BeanGenerator、BeanMap 和 Apache 的工具類 PropertyUtilsBean。在使用時,直接調(diào)用addProperties 方法即可,但是這個實現(xiàn)方式有一定的局限性,那就是,
要想完整地保留對象的原有屬性值,那么這個類的屬性一定要有對應(yīng)的getter 和setter,同時,屬性和getter、setter 的命名一定要符合Java bean 的命名規(guī)范,否則就會丟失數(shù)據(jù)。