使用javassist增强ValueObject对象功能——给ValueObject属性设置Get和Set方法

最新推荐文章于 2022-08-04 12:04:39 发布

benwdm

最新推荐文章于 2022-08-04 12:04:39 发布

阅读量385

点赞数

分类专栏： T_java 文章标签： OO AOP 框架 SQL JDK

T_java 专栏收录该内容

145 篇文章

订阅专栏

ValueObject是长天公司自己开发的数据操作对象，它提供了通过配置文件自动生成POJO对象的功能、自动生成简单SQL语句、动态读取配置文件中的SQL语句执行数据库操作等功能，给系统开发带了很大的便利，较大地提高了开发效率，减少了开发时间、缩短了项目周期，在各个项目中被广泛使用。
但是，ValueObject对象在给开发人员提供了便利的同时，也存在着一些缺陷，有时候给开发带了一些麻烦，增加了代码量。例如：ValueObject使用Map来存储属性“键－值”数据，在操作属性时，不能按照通常的POJO对象那样去使用getXXX或setXXX方式操作属性，而必须使用带属性名的诸如getString(XXX)和setString(XXX,value)的方式来操作。由于这个原因，在Struts1.X标签中使用ValueObject对象时，不能使用“VO对象名.属性名”的方式来使用，而必须改成“VO对象名.string(属性名)”，这样不但仅增加了代码量，而且在有些时候还会带来其他问题；而在Struts2中，由于Struts2操作对象属性方式改变了，导致了无法使用“VO对象名.string(属性名)”方式来操作属性，而必须改成“VO对象名.values[属性名]”的方式，这样直接操作对象里的属性Map，破坏了封装性，而且也给开发造成了不小的麻烦。
在最近一段时间，我们在厦门地税绩效考评项目中使用Struts2开发时，感觉ValueObject的这种限制给开发带了不少麻烦，所以我一直想找一种方法来改造ValueObject对象，使之能跟正常的POJO对象一样操作属性，使之提高与时下广泛使用的一些软件框架的兼容性。
说起要改造ValueObject对象，我必须面对的一个现实是：ValueObject已经在各个项目中广泛使用，如何改造才能保证兼容性，使现有各个项目无须作任何修改呢？比较好的解决方法就是把改造内容做成插件式的，在需要的时候，调用即可使用增加的功能，不调用即按原来的方式使用。如果能做到插件式，就可以做到无侵入，也就能保证与现有系统的兼容性了。可是，如何来设计这个插件呢？
参考时下流行的各种应用开发框架，最时髦也最有效的莫过于AOP了，而实现AOP的手法无非两种：反射和动态代码生成。反射是JDK自己提供的，其特点就是方便易用，OO特性好，而缺点就是效率低，实现功能有限；动态代码生成的特点是在字节码的层次对类进行修改，一旦修改完成，就不再有性能损耗，所以运行性能比反射高很多，缺点是多数的代码动态生成工具需要了解JVM规范中定义的字节码结构的基础。
经过比较，我发现反射无法满足我的要求，只能求助于字节码修改工具了。在流行的字节码工具中，ASM是性能最好、体积最小的，但是易用性却不好，我在网上搜了很久，都没有搜到多少可参考的资料，所以还是选择了javassist，它的性能和体积虽然都比不上ASM，但易用性很好，按照OO的方式即可对类进行修改。
确定了改造方案后，开始着手改造。

第一步：获取javassist.jar：
从www.javassist.org 下载最新的javassist.jar包，顺便关注了一下它的环境要求，它要求JDK 1.3 或以上版本，这个要求对于我们公司的项目一般都能达到。

第二步：分析如何给ValueObject属性增加Get、Set方法及如何动态生成代码：
因为ValueObject是每个POJO对象公用的类，不同Model有不同的属性，我们无法直接修改ValueObject类来生成属性的操作方法，所以我们需要为每个Model生成一个带属性操作方法的类，这个类从ValueObject类继承，每次需要根据Model生成ValueObject实例时，就根据Model名创建对应类的实例。动态生成Model对应的类的代码如下：

/**
* 生成原类的子类
* @param clz Class ValueObject类
* @param newName String 需要生成的新类的类名
* @return CtClass javassist的类包装对象
* @throws NotFoundException
* @throws CannotCompileException
* @throws RuntimeException
*/
protected CtClass makeNewClass(Class clz, String newName)
throws NotFoundException, CannotCompileException, RuntimeException {
Class _clz = clz;
String _clzName = _clz.getName(); //取得ValueObject的类名
CtClass _cClass = null;
//取得javassist的ClassPool（javassist把新生成或更改过的类都放在ClassPool中，
//以便于下次修改时使用）
ClassPool _pool = ClassPool.getDefault();
try {
//看看需要生成的类是否已经存在，
//方法就是尝试ClassPool中根据需要生成的类名取CtClass，
//如果能取到，说明类已经存在，就不再重复生成
_cClass = _pool.get( newName ); //从ClassPool中取
throw new RuntimeException("Class already exists.");
} catch (NotFoundException ex) {
log.debug(ex);
//根据新的类名生成新类
_cClass = _pool.makeClass( newName );
//把新类的父类设为ValueObject类
_cClass.setSuperclass( _pool.get( _clzName ) );
//给新类生成一个默认构造方法，以便使用Class.newInstance()方式生成类实例，
//但这需要父类有一个无参数的构造方法。
//新类的默认构造方法不是必须的，只要父类有无参数的构造方法即可。
// CtConstructor cons = CtNewConstructor.defaultConstructor(_cClass);
// _cClass.addConstructor(cons);
}
return _cClass;
}

根据Model中的属性，调用javassist给新生成的类生成Get和Set方法：

/**
* 根据VO里的属性值生成getXXX和setXXX方法
* @param newVoClass CtClass 前面步骤生成的新类（继承自ValueObject）
* @param vo ValueObject 与新类对应Model的ValueObject实例
* @throws CannotCompileException
*/
protected void makeGetSet(CtClass newVoClass, ValueObject vo )
throws CannotCompileException {
//取出Model中的所有属性名称
String[] fieldNames = getFiledNames(vo);
//循环给每个属性增加Set和Get方法
for(int ii=0; ii<fieldNames.length; ii++) {
Object _obj = vo.getObject( fieldNames[ii] );
//取得属性对应的类型
Class type = _obj.getClass();
//把属性名称改成小写字母且首字母大写的字符串
String filedName = StringUtils.capitalise( fieldNames[ii].toLowerCase() );
//设置setXXX方法
//构造出Set方法的源代码
StringBuffer func = new StringBuffer("public void set").append(filedName).append( "(").append(type.getName()).append(" value) {" );
func.append( " this.setObject(\"").append(fieldNames[ii]).append("\", value);" );
func.append("}");
//生成Set方法
CtMethod setM = CtNewMethod.make( func.toString(), newVoClass);
newVoClass.addMethod(setM);
//设置getXXX方法
//构造出Get方法的源代码
func = new StringBuffer("public ").append( type.getName() ).append( " get").append(filedName).append( "() {" );
func.append( " return (").append( type.getName()).append(") this.getObject(\"").append(fieldNames[ii]).append("\");" );
func.append("}");
//生成Set方法
CtMethod getM = CtNewMethod.make( func.toString(), newVoClass);
newVoClass.addMethod(getM);
}
}
/**
* 从ValueObect中取出所有属性名称
* @param vo MyValueObject
* @return String[]
*/
protected String[] getFiledNames(ValueObject vo) {
String[] names = new String[vo.getValues().size()];
Set keys = vo.getValues().keySet();
Iterator it = keys.iterator();
int ii=0;
while(it.hasNext()){
names[ii++] = ((String)it.next());
}
return names;
}

调用上面的方法生成新类并根据属性生成Get和Set方法，然后再转换成byte数组：

/**
* 生成新类的字节码
* @param clz Class ValueObject类
* @param newName String 要生成新类的名称
* @param vo ValueObject 原来的ValueObject对象，从中取出属性名称和属性类型
* @return byte[] 生成类的byte数据
* @throws RuntimeException
* @throws CannotCompileException
* @throws NotFoundException
* @throws IOException
*/
public byte[] generate(Class clz, String newName, ValueObject vo)
throws RuntimeException, CannotCompileException, NotFoundException, IOException {
byte[] data = null;
//生成新类
CtClass _cc = makeNewClass(clz, newName);
//生成Get和Set方法
makeGetSet(_cc, vo);
//把类文件写到磁盘上
//_cc.writeFile();
//把类转换成字节数组
data = _cc.toBytecode();
//把刚才的CtClass类从ClassPool中删除，以节约内存
_cc.detach();
return data;
}

生成带Get和Set方法的ValueObject类之后，再生成实例，并把原始的ValueObject对象的所有值赋给新类：

/**
* 对类进行增加
* @param vo ValueObject 原始的ValueObject类的POJO对象
* @return ValueObject 新生成的ValueObject子类的POJO对象
* @throws RuntimeException
* @throws CannotCompileException
* @throws NotFoundException
* @throws IllegalAccessException
* @throws InstantiationException
* @throws IOException
*/
public MyValueObject enhance(ValueObject vo) {
ValueObject _vo = vo;
//根据VO对象的Model名生成新类的名称
StringBuffer _newClzName = new StringBuffer(vo.getClass().getName());
_newClzName.append( vo.getModelName()==null? "" : ("$" + vo.getModelName()) );
//private static final String CLS_SUFFIX = "$EnhancedBySYF";
_newClzName.append(CLS_SUFFIX);
Class _voClz = null;
try{
try {
//先调用类装载器尝试装载新类，如果类已经生成，则可以直接装载成功，
//不需要再生新生成
//private static EnhancedValueObjectGeneratorClassLoader loader = new EnhancedValueObjectGeneratorClassLoader();
_voClz = loader.loadClass(_newClzName.toString());
} catch (ClassNotFoundException ex) {
log.debug(ex);
//如果类装载器如果未找到新类，则生成新类
byte[] data = generate(vo.getClass(), _newClzName.toString(), vo);
//根据生成类字节数组生成类
_voClz = loader.defineClass(_newClzName.toString(), data);
}
if (_voClz != null) {
//给新类生成一个实例，然后把原来的VO对象的属性赋给新VO对象
//这里使用newInstance方法来实例化类，需要ValueObject类有一个
//Public或Protected的无参数构造方法，所以需要少量修改ValueObject类
_vo = (ValueObject) _voClz.newInstance();
vo.ConvertAnotherVO(_vo);
}
}catch(RuntimeException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}catch(CannotCompileException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}catch(NotFoundException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}catch(IllegalAccessException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}catch(InstantiationException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}catch(IOException ex) {
log.warn("Enhance [ValueObject] object failed, return original object.");
}
return _vo;
}
为了能调用defindClass方法，需要自定义一个类装载器：
/**
* 自定义类装载器
* @author not attributable
* @version 1.0
*/
private static class EnhancedValueObjectGeneratorClassLoader extends ClassLoader {
public Class defineClass(String className, byte[] classFile) throws ClassFormatError {
return defineClass(className, classFile, 0, classFile.length );
}
}