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

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对应的类的代码如下：
1./**
2. * 生成原类的子类
3. * @param clz Class ValueObject类
4. * @param newName String 需要生成的新类的类名
5. * @return CtClass javassist的类包装对象
6. * @throws NotFoundException
7. * @throws CannotCompileException
8. * @throws RuntimeException
9. */
10.protected CtClass makeNewClass(Class clz, String newName)
1. throws NotFoundException, CannotCompileException, RuntimeException {
2. Class _clz = clz;
3. String _clzName = _clz.getName(); //取得ValueObject的类名
4.
5. CtClass _cClass = null;
6.
7. //取得javassist的ClassPool（javassist把新生成或更改过的类都放在ClassPool中，
8. //以便于下次修改时使用）
9. ClassPool _pool = ClassPool.getDefault();
10.
11. try {
12. //看看需要生成的类是否已经存在，
13. //方法就是尝试ClassPool中根据需要生成的类名取CtClass，
14. //如果能取到，说明类已经存在，就不再重复生成
15. _cClass = _pool.get( newName ); //从ClassPool中取
16. throw new RuntimeException("Class already exists.");
17. } catch (NotFoundException ex) {
18. log.debug(ex);
19. //根据新的类名生成新类
20. _cClass = _pool.makeClass( newName );
21.
22. //把新类的父类设为ValueObject类
23. _cClass.setSuperclass( _pool.get( _clzName ) );
24.
25. //给新类生成一个默认构造方法，以便使用Class.newInstance()方式生成类实例，
26. //但这需要父类有一个无参数的构造方法。
27. //新类的默认构造方法不是必须的，只要父类有无参数的构造方法即可。
28.// CtConstructor cons = CtNewConstructor.defaultConstructor(_cClass);
1.// _cClass.addConstructor(cons);
1. }
2. return _cClass;
3. }

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

1./**
2. * 根据VO里的属性值生成getXXX和setXXX方法
3. * @param newVoClass CtClass 前面步骤生成的新类（继承自ValueObject）
4. * @param vo ValueObject 与新类对应Model的ValueObject实例
5. * @throws CannotCompileException
6. */
7.protected void makeGetSet(CtClass newVoClass, ValueObject vo )
1. throws CannotCompileException {
2. //取出Model中的所有属性名称
3. String[] fieldNames = getFiledNames(vo);
4.
5. //循环给每个属性增加Set和Get方法
6. for(int ii=0; ii<fieldNames.length; ii++) {
7. Object _obj = vo.getObject( fieldNames[ii] );
8. //取得属性对应的类型
9. Class type = _obj.getClass();
10. //把属性名称改成小写字母且首字母大写的字符串
11. String filedName = StringUtils.capitalise( fieldNames[ii].toLowerCase() );
12.
13. //设置setXXX方法
14. //构造出Set方法的源代码
15. StringBuffer func = new StringBuffer("public void set").append(filedName).append( "(").append(type.getName()).append(" value) {" );
16. func.append( " this.setObject(\"").append(fieldNames[ii]).append("\", value);" );
17. func.append("}");
18. //生成Set方法
19. CtMethod setM = CtNewMethod.make( func.toString(), newVoClass);
20. newVoClass.addMethod(setM);
21.
22. //设置getXXX方法
23. //构造出Get方法的源代码
24. func = new StringBuffer("public ").append( type.getName() ).append( " get").append(filedName).append( "() {" );
25. func.append( " return (").append( type.getName()).append(") this.getObject(\"").append(fieldNames[ii]).append("\");" );
26. func.append("}");
27. //生成Set方法
28. CtMethod getM = CtNewMethod.make( func.toString(), newVoClass);
29. newVoClass.addMethod(getM);
30. }
31. }
32.
33./**
1. * 从ValueObect中取出所有属性名称
2. * @param vo MyValueObject
3. * @return String[]
4. */
5.protected String[] getFiledNames(ValueObject vo) {
1. String[] names = new String[vo.getValues().size()];
2. Set keys = vo.getValues().keySet();
3. Iterator it = keys.iterator();
4. int ii=0;
5. while(it.hasNext()){
6. names[ii++] = ((String)it.next());
7. }
8. return names;
9. }
调用上面的方法生成新类并根据属性生成Get和Set方法，然后再转换成byte数组：

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

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

1./**
2. * 对类进行增加
3. * @param vo ValueObject 原始的ValueObject类的POJO对象
4. * @return ValueObject 新生成的ValueObject子类的POJO对象
5. * @throws RuntimeException
6. * @throws CannotCompileException
7. * @throws NotFoundException
8. * @throws IllegalAccessException
9. * @throws InstantiationException
10. * @throws IOException
11. */
12.public MyValueObject enhance(ValueObject vo) {
1. ValueObject _vo = vo;
2.
3. //根据VO对象的Model名生成新类的名称
4. StringBuffer _newClzName = new StringBuffer(vo.getClass().getName());
5. _newClzName.append( vo.getModelName()==null? "" : ("$" + vo.getModelName()) );
6.
7. //private static final String CLS_SUFFIX = "$EnhancedBySYF";
8. _newClzName.append(CLS_SUFFIX);
9.
10. Class _voClz = null;
11.
12. try{
13. try {
14. //先调用类装载器尝试装载新类，如果类已经生成，则可以直接装载成功，
15. //不需要再生新生成
16. //private static EnhancedValueObjectGeneratorClassLoader loader = new EnhancedValueObjectGeneratorClassLoader();
17. _voClz = loader.loadClass(_newClzName.toString());
18. } catch (ClassNotFoundException ex) {
19. log.debug(ex);
20. //如果类装载器如果未找到新类，则生成新类
21. byte[] data = generate(vo.getClass(), _newClzName.toString(), vo);
22. //根据生成类字节数组生成类
23. _voClz = loader.defineClass(_newClzName.toString(), data);
24. }
25. if (_voClz != null) {
26. //给新类生成一个实例，然后把原来的VO对象的属性赋给新VO对象
27. //这里使用newInstance方法来实例化类，需要ValueObject类有一个
28. //Public或Protected的无参数构造方法，所以需要少量修改ValueObject类
29. _vo = (ValueObject) _voClz.newInstance();
30. vo.ConvertAnotherVO(_vo);
31. }
32. }catch(RuntimeException ex) {
33. log.warn("Enhance [ValueObject] object failed, return original object.");
34. }catch(CannotCompileException ex) {
35. log.warn("Enhance [ValueObject] object failed, return original object.");
36. }catch(NotFoundException ex) {
37. log.warn("Enhance [ValueObject] object failed, return original object.");
38. }catch(IllegalAccessException ex) {
39. log.warn("Enhance [ValueObject] object failed, return original object.");
40. }catch(InstantiationException ex) {
41. log.warn("Enhance [ValueObject] object failed, return original object.");
42. }catch(IOException ex) {
43. log.warn("Enhance [ValueObject] object failed, return original object.");
44. }
45. return _vo;
46. }
47.
48. 为了能调用defindClass方法，需要自定义一个类装载器：
49./**
1. * 自定义类装载器
2. * @author not attributable
3. * @version 1.0
4. */
5.private static class EnhancedValueObjectGeneratorClassLoader extends ClassLoader {
1. public Class defineClass(String className, byte[] classFile) throws ClassFormatError {
2. return defineClass(className, classFile, 0, classFile.length );
3. }
4. }
第三步：如何使用这个工具类呢：
下面通过一段代码来演示如何使用这个工具类：

1.ArrayList cpList = JxcpMgr.getCpList(String userid);
2.ArrayList newCpList = new ArrayList();
3.EnhancedValueObjectGenerator enhancer = new EnhancedValueObjectGenerator();
4.for(int ii=0; ii<cpList.size(); ii++) {
1. ValueObject vo = (ValueObject)cpList.get(ii);
2. //给VO增加Get、Set方法得到新类，并放入新List
3. newCpList.add( enhancer.enhance(vo) );
4.}
/*在JSP中*/

1.<logic:iterate id="cpjl" property="newCpList" name="rycpForm">
2. <tr>
3. <td>用户代码：<html:text name="cpjl" property="USER_ID" size="10" /></td>
4. <td>单位代码：<html:text name="cpjl" property="DW_ID" size="10" /></td>
5. <td>测评得分：<html:text name="cpjl" property="CPDF" size="15" /></td>
6. <td>测评等级：<html:text name="cpjl" property="CPDJ" size="10" /></td>
7. </tr>
8.</logic:iterate>
结束语：
字节代码工具给了我们一个很好的工具，让我们可以自由地在任意类中插入代码，真正实现面向方面编程。用好这类工具，能给我们的开发框架带来极大的灵活性，当我们在框架开发时感觉走投无路时，不妨把思路打开，试试动态生成代码。

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

《JAVA练习题目11》学生类有属性姓名（字符串类型）和选修课程信息（ArrayList＜Course＞对象）两个属性，和三个方法
学生类有属性姓名(字符串类型)和选修课程信息(ArrayList对象)两个属性,和三个方法一个用于初始化学生名字的构造方法:一个添加选修课程的addCourse方法:一个获取所有课程平均分的getA ...
JS-面向对象-创建具有私有属性的构造函数(2种方法)
方式1 <!DOCTYPE html> <html lang="zh"><head><meta charset="UTF-8&q ...
要重定向 IO 流，Process 对象必须将 UseShellExecute 属性设置为 False。
Process p1= new Process(); p1.StartInfo.UseShellExecute = false;
Process对象必须将UseShellExecute属性设置为False才能使用环境变量解决办法
加下面两行 proc.StartInfo.UseShellExecute = false; proc.StartInfo.CreateNoWindow = true; The reason being ...
【MATLAB】基本绘图 ( 图形属性 | 绘图对象 | 图形属性界面 | 坐标轴属性 | 线属性 | 文本属性 | 图形属性设置策略 )
文章目录一.图形属性 1.图形属性列举 2.绘图对象二.图形属性设置 1.图形属性界面 2.坐标轴属性 3.线属性 4.文本属性三.图形属性设置策略一.图形属性 1.图形属性列举图形属性 : ...
js sort方法根据数组中对象的某一个属性值进行排序（实用方法）
js sort方法根据数组中对象的某一个属性值进行排序 sort方法接收一个函数作为参数,这里嵌套一层函数用来接收对象属性名,其他部分代码与正常使用sort方法相同. var arr = [{name ...
Pdfium.Net SDK增强您的功能快速生成PDF
Pdfium.Net SDK增强您的功能快速生成PDF PDF领导者是否想在Windows和Mac上仅用几行代码来创建,渲染,打印,保护,合并,拆分和操作PDF文件?使用 Pdfium.Net SDK ...
android 新浪财经截屏分享,[图]Android 12截图曝光：启用全新UI 增强隐私保护功能...
原标题:[图]Android 12截图曝光:启用全新UI 增强隐私保护功能来源:cnBeta.COM Android 12 有望在今年秋季上线,相关的开发者预览版和 Beta 版本有望在本月晚些时候 ...
const的使用 || 对象增强写法 (对象字面量)
const的使用 <!DOCTYPE html> <html lang="en"> <head><meta charset="U ...

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

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

最新文章

热门文章