Javassist字节码增强示例

概述

　　Javassist是一款字节码编辑工具，可以直接编辑和生成Java生成的字节码，以达到对.class文件进行动态修改的效果。熟练使用这套工具，可以让Java编程更接近与动态语言编程。

　　下面一个方法的目的是获取一个类加载器（ClassLoader），以加载指定的.jar或.class文件，在之后的代码中会使用到。

1. private static ClassLoader getLocaleClassLoader() throws Exception {
2. List<URL> classPathURLs = new ArrayList<>();
3. // 加载.class文件路径
4. classPathURLs.add(classesPath.toURI().toURL());
5. // 获取所有的jar文件
6. File[] jarFiles = libPath.listFiles(new FilenameFilter() {
7. @Override
8. public boolean accept(File dir, String name) {
9. return name.endsWith(".jar");
10. }
11. });
12. Assert.assertFalse(ObjectHelper.isArrayNullOrEmpty(jarFiles));
13. // 将jar文件路径写入集合
14. for (File jarFile : jarFiles) {
15. classPathURLs.add(jarFile.toURI().toURL());
16. }
17. // 实例化类加载器
18. return new URLClassLoader(classPathURLs.toArray(new URL[classPathURLs.size()]));
19. }

获取类型信息

1. @Test
2. public void test() throws NotFoundException {
3. // 获取默认类型池对象
4. ClassPool classPool = ClassPool.getDefault();
5. // 获取指定的类型
6. CtClass ctClass = classPool.get("java.lang.String");
7. System.out.println(ctClass.getName());  // 获取类名
8. System.out.println("\tpackage " + ctClass.getPackageName());    // 获取包名
9. System.out.print("\t" + Modifier.toString(ctClass.getModifiers()) + " class " + ctClass.getSimpleName());   // 获取限定符和简要类名
10. System.out.print(" extends " + ctClass.getSuperclass().getName());  // 获取超类
11. // 获取接口
12. if (ctClass.getInterfaces() != null) {
13. System.out.print(" implements ");
14. boolean first = true;
15. for (CtClass c : ctClass.getInterfaces()) {
16. if (first) {
17. first = false;
18. } else {
19. System.out.print(", ");
20. }
21. System.out.print(c.getName());
22. }
23. }
24. System.out.println();
25. }

修改类方法

1. @Test
2. public void test() throws Exception {
3. // 获取本地类加载器
4. ClassLoader classLoader = getLocaleClassLoader();
5. // 获取要修改的类
6. Class<?> clazz = classLoader.loadClass("edu.alvin.reflect.TestLib");
7. // 实例化类型池对象
8. ClassPool classPool = ClassPool.getDefault();
9. // 设置类搜索路径
10. classPool.appendClassPath(new ClassClassPath(clazz));
11. // 从类型池中读取指定类型
12. CtClass ctClass = classPool.get(clazz.getName());
13. // 获取String类型参数集合
14. CtClass[] paramTypes = {classPool.get(String.class.getName())};
15. // 获取指定方法名称
16. CtMethod method = ctClass.getDeclaredMethod("show", paramTypes);
17. // 赋值方法到新方法中
18. CtMethod newMethod = CtNewMethod.copy(method, ctClass, null);
19. // 修改源方法名称
20. String oldName = method.getName() + "$Impl";
21. method.setName(oldName);
22. // 修改原方法
23. newMethod.setBody("{System.out.println(\"执行前\");" + oldName + "($$);System.out.println(\"执行后\");}");
24. // 将新方法添加到类中
25. ctClass.addMethod(newMethod);
26. // 加载重新编译的类
27. clazz = ctClass.toClass();      // 注意，这一行会将类冻结，无法在对字节码进行编辑
28. // 执行方法
29. clazz.getMethod("show", String.class).invoke(clazz.newInstance(), "hello");
30. ctClass.defrost();  // 解冻一个类，对应freeze方法
31. }

动态创建类

1. @Test
2. public void test() throws Exception {
3. ClassPool classPool = ClassPool.getDefault();
4. // 创建一个类
5. CtClass ctClass = classPool.makeClass("edu.alvin.reflect.DynamiClass");
6. // 为类型设置接口
7. //ctClass.setInterfaces(new CtClass[] {classPool.get(Runnable.class.getName())});
8. // 为类型设置字段
9. CtField field = new CtField(classPool.get(String.class.getName()), "value", ctClass);
10. field.setModifiers(Modifier.PRIVATE);
11. // 添加getter和setter方法
12. ctClass.addMethod(CtNewMethod.setter("setValue", field));
13. ctClass.addMethod(CtNewMethod.getter("getValue", field));
14. ctClass.addField(field);
15. // 为类设置构造器
16. // 无参构造器
17. CtConstructor constructor = new CtConstructor(null, ctClass);
18. constructor.setModifiers(Modifier.PUBLIC);
19. constructor.setBody("{}");
20. ctClass.addConstructor(constructor);
21. // 参数构造器
22. constructor = new CtConstructor(new CtClass[] {classPool.get(String.class.getName())}, ctClass);
23. constructor.setModifiers(Modifier.PUBLIC);
24. constructor.setBody("{this.value=$1;}");
25. ctClass.addConstructor(constructor);
26. // 为类设置方法
27. CtMethod method = new CtMethod(CtClass.voidType, "run", null, ctClass);
28. method.setModifiers(Modifier.PUBLIC);
29. method.setBody("{System.out.println(\"执行结果\" + this.value);}");
30. ctClass.addMethod(method);
31. // 加载和执行生成的类
32. Class<?> clazz = ctClass.toClass();
33. Object obj = clazz.newInstance();
34. clazz.getMethod("setValue", String.class).invoke(obj, "hello");
35. clazz.getMethod("run").invoke(obj);
36. obj = clazz.getConstructor(String.class).newInstance("OK");
37. clazz.getMethod("run").invoke(obj);
38. }

创建代理类

1. @Test
2. public void test() throws Exception {
3. // 实例化代理类工厂
4. ProxyFactory factory = new ProxyFactory();
5. //设置父类，ProxyFactory将会动态生成一个类，继承该父类
6. factory.setSuperclass(TestProxy.class);
7. //设置过滤器，判断哪些方法调用需要被拦截
8. factory.setFilter(new MethodFilter() {
9. @Override
10. public boolean isHandled(Method m) {
11. return m.getName().startsWith("get");
12. }
13. });
14. Class<?> clazz = factory.createClass();
15. TestProxy proxy = (TestProxy) clazz.newInstance();
16. ((ProxyObject)proxy).setHandler(new MethodHandler() {
17. @Override
18. public Object invoke(Object self, Method thisMethod, Method proceed, Object[] args) throws Throwable {
19. //拦截后前置处理，改写name属性的内容
20. //实际情况可根据需求修改
21. System.out.println(thisMethod.getName() + "被调用");
22. try {
23. Object ret = proceed.invoke(self, args);
24. System.out.println("返回值: " + ret);
25. return ret;
26. } finally {
27. System.out.println(thisMethod.getName() + "调用完毕");
28. }
29. }
30. });
31. proxy.setName("Alvin");
32. proxy.setValue("1000");
33. proxy.getName();
34. proxy.getValue();
35. }

　　其中，TestProxy类内容如下：

1. public class TestProxy {
2. private String name;
3. private String value;
4. public String getName() {
5. return name;
6. }
7. public void setName(String name) {
8. this.name = name;
9. }
10. public String getValue() {
11. return value;
12. }
13. public void setValue(String value) {
14. this.value = value;
15. }
16. }

获取方法名称

1. @Test
2. public void test() throws Exception {
3. // 获取本地类加载器
4. ClassLoader classLoader = getLocaleClassLoader();
5. // 获取要修改的类
6. Class<?> clazz = classLoader.loadClass("edu.alvin.reflect.TestLib");
7. // 实例化类型池
8. ClassPool classPool = ClassPool.getDefault();
9. classPool.appendClassPath(new ClassClassPath(clazz));
10. CtClass ctClass = classPool.get(clazz.getName());
11. // 获取方法
12. CtMethod method = ctClass.getDeclaredMethod("show", ObjectHelper.argumentsToArray(CtClass.class, classPool.get("java.lang.String")));
13. // 判断是否为静态方法
14. int staticIndex = Modifier.isStatic(method.getModifiers()) ? 0 : 1;
15. // 获取方法的参数
16. MethodInfo methodInfo = method.getMethodInfo();
17. CodeAttribute codeAttribute = methodInfo.getCodeAttribute();
18. LocalVariableAttribute localVariableAttribute = (LocalVariableAttribute)codeAttribute.getAttribute(LocalVariableAttribute.tag);
19. for (int i = 0; i < method.getParameterTypes().length; i++) {
20. System.out.println("第" + (i + 1) + "个参数名称为: " + localVariableAttribute.variableName(staticIndex + i));
21. }
22. }

　　关于“获取方法名称”，其主要作用是：当Java虚拟机加载.class文件后，会将类方法“去名称化”，即丢弃掉方法形参的参数名，而是用形参的序列号来传递参数。如果要通过Java反射获取参数的参数名，则必须在编辑是指定“保留参数名称”。Javassist则不存在这个问题，对于任意方法，都能正确的获取其参数的参数名。

　　Spring MVC就是通过方法参数将请求参数进行注入的，这一点比struts2 MVC要方便很多，Spring也是借助了Javassist来实现这一点的。