Javassist字节码增强

通常对一个方法增加日志记录，安全检查都会说采用AOP或CGLIB动态代理，但无论哪种方式都必需改变原有的调用方式；
同时，大量的反射调用也必增加系统的开销。下面介绍一种不需要改变客户端调用方式而又能实现对指定方法增加缓存或日志的方式，那就是——字节码增强！

 

 

 在实际项目中通常需要对一些频繁访问数据库的方法采用对象缓存，从而提高系统性能减少不必要的网络开销。
这时候一般我们会去修改方法的源码，增加Cache的put,get调用，要么采用AspectJ或cglib进行方法执行前或执行后的拦截

但采用无论采用哪种方式都必需改变客户端原有的调用方式，可能涉及变动的模块又零散(如对Account,Bank,Customer对象增加Log或Cache)，况且如果对于遗留系统而又没有源码呢？

因此采用字节码增强成立一种可选的手段，允许在不改变原调用方式的情况下进行字节码增强

最直接的改造 Java 类的方法莫过于直接改写 class 文件。Java 规范详细说明了class 文件的格式，直接编辑字节码确实可以改变 Java 类的行为。操作字节码开源实现有ObjectWeb ASM,JBOSS Javassist等，最终选择Javassist是由于它操作简单，直观。

以下是字节码增强的生成器ClassEnhancedGenerator，实现对一个类的多个方法进行字节码增强 

public class ClassEnhancedGenerator {


private ClassEnhancedGenerator(){

}

/**
* 类方法增强<BR>
*
* 对指定类的方法进行代码增强(将指定的原方法名改为$enhanced,同时复制原方法名进行代码注入)
* @param className 待增强的类名
* @param methodName 待增强的方法名
* @param injectType {@link InjectType}注入类型
* @param provider {@link ClassInjectProvider}实现类
* @throws Exception
*/
public static void enhancedMethod(String className,String[] methods,
InjectType injectType,
ClassInjectProvider provider)throws Exception{

CtClass ctClass = ClassPool.getDefault().get(className);

for(int i=0;i<methods.length;i++){
injectCodeForMethod(ctClass,methods[i],injectType,provider);
}

String resource = className.replace(".", "/") + ".class";
URI uri = ClassLoader.getSystemClassLoader().getResource(resource).toURI();
String classFilePath = uri.getRawPath().substring(0,uri.getRawPath().length() - resource.length());
ctClass.writeFile(classFilePath);
}

private static void injectCodeForMethod(CtClass ctClass,String methodName,InjectType injectType,ClassInjectProvider provider)throws Exception{
CtMethod oldMethod = ctClass.getDeclaredMethod(methodName);

//修改原有的方法名称为"方法名$enhanced"，如果已存在该方法则返回
String originalMethod = methodName + "$enhanced";
CtMethod[] methods=ctClass.getMethods();
for(int i=0;i<methods.length;i++){
CtMethod method=methods[i];
if(method.getName().equals(originalMethod)){
return ;
}
}
oldMethod.setName(originalMethod);

//增加代码,复制原来的方法名作为增强的新方法,同时调用原有方法即"方法名$enhanced"
CtMethod enhancedMethod = CtNewMethod.copy(oldMethod, methodName, ctClass, null);
//对复制的方法注入代码
StringBuffer methodBody = new StringBuffer();
methodBody.append("{");
switch(injectType){
case AFTER:
methodBody.append(provider.injectCode(enhancedMethod));
methodBody.append(originalMethod + "($$); ");
break;
case BEFORE:
methodBody.append(originalMethod + "($$); ");
methodBody.append(provider.injectCode(enhancedMethod));
break;
default:
String injectCode=provider.injectCode(enhancedMethod);
methodBody.append(injectCode);

}
methodBody.append("}");
enhancedMethod.setBody(methodBody.toString());

ctClass.addMethod(enhancedMethod);
}

}

代码注入Provider接口

public interface ClassInjectProvider {

/**
* 对指定的方法注入代码
*
* @param ctMethod CtMethod
* @return
*/
public String injectCode(final CtMethod ctMethod)throws Exception;

}

缓存注入的实现类：

public class CacheInjectProvider implements ClassInjectProvider{

private static MyLogger logger=new MyLogger(CacheInjectProvider.class);

public CacheInjectProvider(){

}

/**
* 注入缓存，缓存键值以类名+#+方法名(参数值1...参数值n)为key
*
* @param method CtMethod
*/
public String injectCode(final CtMethod method) throws Exception{

StringBuffer cacheCode=new StringBuffer();

try{

if(method.getReturnType()==CtClass.voidType){
cacheCode.append(method.getName()+"$enhanced($$); ");
}
else{
cacheCode.append("StringBuilder cacheKeyBuilder=new StringBuilder(); ");
cacheCode.append("MethodCacheKey cacheKey=new MethodCacheKey(); ");
cacheCode.append("cacheKey.setClassName("").append(method.getDeclaringClass().getName()).append(""); ");
cacheCode.append("cacheKey.setMethodName("").append(method.getName()).append(""); ");

CtClass[] ctClass=method.getParameterTypes();
cacheCode.append("Object[] parameters=new Object[").append(ctClass.length).append("]; ");
for(int i=0;i<ctClass.length;i++){
cacheCode.append("parameters["+i+"]=").append("($w)$"+(i+1)).append("; ");
}
cacheCode.append("cacheKey.setParameters(parameters); ");

cacheCode.append("Cache cache=CacheFactory.getCache();").append(" ");
cacheCode.append("if(cache.get(cacheKey)==null)").append(" ");
cacheCode.append("{").append(" ");
if(method.getReturnType().isPrimitive()){
cacheCode.append("Object result=($w)").append(method.getName()+"$enhanced($$);").append(" ");
}
else{
cacheCode.append("Object result=").append(method.getName()+"$enhanced($$);").append(" ");
}
cacheCode.append("cache.put(cacheKey,result);").append(" ");
cacheCode.append("}").append(" ");
cacheCode.append("return ").append("($r)cache.get(cacheKey);");
}

}catch(Exception e){
}
logger.log("inject sourcecode>>>: "+cacheCode.toString());
return cacheCode.toString();
}

}

说明：
    $1,$2 表示方法的第一个参数值，第二个参数值
    $w 表示将指定的基本类型变量转换为对象，如($w)$1 即为Integer i=new Integer(1);
    $$ 表示方法的所有参数
    $r 方法的返回类型

缺点：
1)类重新编译后，字节码增强生成器要重新执行

这一点可以通过StartupRuntime 接口的方式在系统启动的时候运行指定方法，如

public interface StartupRuntime {

/**
* 系统启动加载执行方法
* @throws Throwable
*/
public void execute()throws SystemRuntimeException;
}

转自：http://gocom.primeton.com/blog3936_16703.htm