使用JAVA ASM 框架 實現(xiàn)一個簡單AOP功能
?本文是一個介紹通過java?ASM框架實現(xiàn)一個AOP環(huán)繞通知的簡單實現(xiàn)。
一、簡單介紹一下ASM框架
????ASM框架是個用來操作java字節(jié)碼與創(chuàng)建字節(jié)碼的工具，可以通過框架提供的API生成class文件，現(xiàn)在比較流行的框架底層基本都使用了ASM框架來動態(tài)編輯字節(jié)碼。
二、簡單介紹AOP
????????AOP為Aspect Oriented Programming的縮寫，意為：面向切面編程，通過預(yù)編譯方式和運行期間動態(tài)代理實現(xiàn)程序功能的。
三、實現(xiàn)一個AOP環(huán)繞通知
????????我們先定義一個AspectHandle類來實現(xiàn)記錄被切入的方法的一些信息。
? ? ? ? ?類的定義如下：
? ? ? ? ??
public class AspectHandle {
?//記錄被切入的對象實例
?private Object instance;
?//記錄被切入的方法實參
?private Object[] arguments;
?//記錄被切入的方法
?private Method method;
?//調(diào)用實際的方法
?public Object invoke() {
? ?try {
? ? ?return this.method.invoke(this.instance, this.arguments);
? ?} catch (Throwable _e) {
? ? ?throw Exceptions.sneakyThrow(_e);
? ?}
?}
?...
}????????????
我們定義完AspectHandle類后接下來，我們看一下如何通過ASM框架實現(xiàn)AOP功能，我們先實現(xiàn)一個用來創(chuàng)建字節(jié)碼的工具，先生成類基本構(gòu)造函數(shù)等
public class GenerateUtils {
? ?/**
? ? * 定義一個接口用來提供除構(gòu)造函數(shù)外的字節(jié)碼操作
? ? */
?public interface Asm {
? ?void code(final ClassVisitor visitor, final Class<?> superClass, final Class<?>[] interfaces);
?}
public byte[] gen(final String className, final Class<?> superClass, final Class<?>[] interfaces, final GenerateUtils.Asm asm) {
? ? /**
? ? ? * 創(chuàng)建一個ClassWriter的對象,用于拼接字節(jié)碼
? ? ? * COMPUTE_MAXS 告訴ASM 自動計算棧的最大值以及最大數(shù)量的方法的本地變量。
? ? ? * COMPUTE_FRAMES 標(biāo)識讓ASM 自動計算方法的棧楨
? ? ? */
? ?final ClassWriter classWriter = new ClassWriter((ClassWriter.COMPUTE_MAXS + ClassWriter.COMPUTE_FRAMES));
? ?PrintWriter pw = new PrintWriter(System.err);
? ?/**
? ? * 創(chuàng)建一個TraceClassVisitor對象，將java字節(jié)碼以文本的方式展現(xiàn)出來，方便查看生成的字節(jié)碼
? ? */
? ?final ClassVisitor classVisitor = new TraceClassVisitor(classWriter, pw);
? /**
? ?* 將 class[] 類的數(shù)據(jù)轉(zhuǎn)換為 String[]
? ?*/
? ?final Vector<String> interfaceStr = new Vector<String>();
? ?if ((interfaces != null)) {
? ? ?final Consumer<Class<?>> _function = (Class<?> inter) -> {
? ? ? ?interfaceStr.add(inter.getName().replace(".", "/"));
? ? ?};
? ? ?IterableExtensions.<Class<?>>filterNull(((Iterable<Class<?>>)Conversions.doWrapArray(interfaces))).forEach(_function);
? ?}
? ? ? /**
? ? ? ? * 判斷如果superClass 為 null 就設(shè)置一個默認(rèn)值 Object 就是
? ? ? ? * 目的是創(chuàng)建的子類如果沒有父類 就默認(rèn)繼承Object類
? ? ? ? */
? ?Class<?> _xifexpression = null;
? ?if ((superClass == null)) {
? ? ?_xifexpression = Object.class;
? ?} else {
? ? ?_xifexpression = superClass;
? ?}
? ?final Class<?> superZlass = _xifexpression;
? ?//開始創(chuàng)建一個類，創(chuàng)建的類版本為 jdk1.8,類的作用域為public
? ?classVisitor.visit(Opcodes.V1_8, Opcodes.ACC_PUBLIC, className, null, superZlass.getTypeName().replace(".", "/"), ((String[])Conversions.unwrapArray(interfaceStr, String.class)));
? ? ? /**
? ? ? ? * 對繼承的父類中的構(gòu)建函數(shù)進(jìn)行處理
? ? ? ? * 就是創(chuàng)建子類構(gòu)造函數(shù)，并調(diào)用父類構(gòu)造
? ? ? ? */
? ?final Consumer<Constructor<?>> _function_1 = (Constructor<?> c) -> {
? ? ?Method m = Method.getMethod(c);
? ? ?final GeneratorAdapter ga = new GeneratorAdapter(Opcodes.ACC_PUBLIC, m, null, null, classVisitor);
? ? ?ga.loadThis();
? ? ?int _size = ((List<Parameter>)Conversions.doWrapArray(c.getParameters())).size();
? ? ?boolean _greaterThan = (_size > 0);
? ? ?if (_greaterThan) {
? ? ? ?int _size_1 = ((List<Parameter>)Conversions.doWrapArray(c.getParameters())).size();
? ? ? ?int _minus = (_size_1 - 1);
? ? ? ?ga.loadArgs(0, _minus);
? ? ?}
? ? ?ga.invokeConstructor(Type.getType(superZlass), m);
? ? ?ga.returnValue();
? ? ?ga.endMethod();
? ?};
? ?IterableExtensions.<Constructor<?>>filterNull(((Iterable<Constructor<?>>)Conversions.doWrapArray(superZlass.getConstructors()))).forEach(_function_1);
? ?//其他字節(jié)碼操作
? ?if ((asm != null)) {
? ? ?asm.code(classVisitor, superZlass, interfaces);
? ?}
? ?//創(chuàng)建類結(jié)束
? ?classVisitor.visitEnd();
? ?//返回創(chuàng)建的字節(jié)碼
? ?return classWriter.toByteArray();
?}
}? ?創(chuàng)建字節(jié)的工具我們編寫完了，接下來我們實現(xiàn)AspectUtils的類來實現(xiàn)我們的AOP的環(huán)繞通知功能
public class AspectUtils extends ClassLoader {
?private final HashMap<String, Class<?>> aspectClassMap = new HashMap<String, Class<?>>();
?
?private static final AspectUtils instance = new AspectUtils();
?
?private AspectUtils() {
?}
?
?public static synchronized AspectUtils getInstance() {
? ?return AspectUtils.instance;
?}
/**
?* dest 要添加切面的類
?* aspect 切面類
?* methodName 指定切面類的方法
?*/
public Class<?> ?aspect(final Class<?> dest, final Class<?> aspect, final String methodName) {
? ? // 根據(jù)dest創(chuàng)建子類
? ?GenerateUtils g = new GenerateUtils();
? ?//創(chuàng)建一個子類名
? ?String _replace = UUID.randomUUID().toString().replace("-", "");
? ?String uuid = ("FigAspect_" + _replace);
? ?/添加一個重寫父類中的方法，并創(chuàng)建AspectHandle給 切面類
? ?final GenerateUtils.Asm _function = new GenerateUtils.Asm() {
? ? ?public void code(final ClassVisitor v, final Class<?> s, final Class<?>[] i) {
? ? ? ?final Consumer<Method> _function = new Consumer<Method>() {
? ? ? ? ?public void accept(final Method m) {
? ? ? ? ? ?try {
? ? ? ? ? ? ?final org.objectweb.asm.commons.Method method = org.objectweb.asm.commons.Method.getMethod(m);
? ? ? ? ? ? ?final GeneratorAdapter ga = new GeneratorAdapter(Opcodes.ACC_PUBLIC, method, null, null, v);
? ? ? ? ? ? ? // 實例aspect
? ? ? ? ? ? ?ga.newInstance(Type.getType(aspect));
? ? ? ? ? ? ?ga.dup();
? ? ? ? ? ? ?//調(diào)用實例的構(gòu)造方法
? ? ? ? ? ? ?ga.invokeConstructor(Type.getType(aspect), org.objectweb.asm.commons.Method.getMethod("void <init>()"));
? ? ? ? ? ? ?//將創(chuàng)建的切面類實例賦值給本地變量
? ? ? ? ? ? ?int l1 = ga.newLocal(Type.getType(aspect));
? ? ? ? ? ? ?ga.storeLocal(l1, Type.getType(aspect));
? ? ? ? ? ? ?// 創(chuàng)建AspectHandle
? ? ? ? ? ? ?ga.newInstance(Type.getType(AspectHandle.class));
? ? ? ? ? ? ?ga.dup();
? ? ? ? ? ? ?//調(diào)用實例的構(gòu)造方法
? ? ? ? ? ? ?ga.invokeConstructor(Type.getType(AspectHandle.class), org.objectweb.asm.commons.Method.getMethod("void <init>()"));
? ? ? ? ? ? ?//將實例給本地變量 l2
? ? ? ? ? ? ?int l2 = ga.newLocal(Type.getType(AspectHandle.class));
? ? ? ? ? ? ?ga.storeLocal(l2, Type.getType(AspectHandle.class));
? ? ? ? ? ? ?//加載本地變量l2
? ? ? ? ? ? ?ga.loadLocal(l2, Type.getType(AspectHandle.class));
? ? ? ? ? ? ?//創(chuàng)建object數(shù)組，數(shù)組大小為 getArgumentTypes 的大小
? ? ? ? ? ? ?ga.push(((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size());
? ? ? ? ? ? ?ga.newArray(Type.getType(Object.class));
? ? ? ? ? ? ?//構(gòu)建實參，將創(chuàng)建的方法的參數(shù)值付給Object數(shù)組
? ? ? ? ? ? ?AspectUtils.this.buildArguments(method, ga);
? ? ? ? ? ? ?//調(diào)用AspectHandle 中的setArguments方法并傳入Object數(shù)組
? ? ? ? ? ? ?ga.invokeVirtual(Type.getType(AspectHandle.class), org.objectweb.asm.commons.Method.getMethod("void setArguments(Object[])"));
? ? ? ? ? ? ?//加載本地變量l2
? ? ? ? ? ? ?ga.loadLocal(l2, Type.getType(AspectHandle.class));
? ? ? ? ? ? ?ga.push(Type.getType(dest));
? ? ? ? ? ? ?ga.push(method.getName());
? ? ? ? ? ? ?ga.push(((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size());
? ? ? ? ? ? ?ga.newArray(Type.getType(Class.class));
? ? ? ? ? ? ?int _size = ((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size();
? ? ? ? ? ? ?boolean _greaterThan = (_size > 0);
? ? ? ? ? ? ?if (_greaterThan) {
? ? ? ? ? ? ? ?for (int index = 0; (index < ((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size()); index++) {
? ? ? ? ? ? ? ? ?{
? ? ? ? ? ? ? ? ? ?ga.dup();
? ? ? ? ? ? ? ? ? ?ga.push(index);
? ? ? ? ? ? ? ? ? ?ga.push(method.getArgumentTypes()[index]);
? ? ? ? ? ? ? ? ? ?ga.visitInsn(Opcodes.AASTORE);
? ? ? ? ? ? ? ? ?}
? ? ? ? ? ? ? ?}
? ? ? ? ? ? ?} else {
? ? ? ? ? ? ? ?ga.visitInsn(Opcodes.ACONST_NULL);
? ? ? ? ? ? ?}
? ? ? ? ? ? ?ga.invokeVirtual(Type.getType(Class.class),
? ? ? ? ? ? ? ?org.objectweb.asm.commons.Method.getMethod("java/lang/reflect/Method getDeclaredMethod (java/lang/String,java/lang/Class[])",
? ? ? ? ? ? ? ? ?true));
? ? ? ? ? ? ?ga.invokeVirtual(Type.getType(AspectHandle.class),
? ? ? ? ? ? ? ?org.objectweb.asm.commons.Method.getMethod("void setMethod(java/lang/reflect/Method)", true));
? ? ? ? ? ? ?ga.newInstance(Type.getType(dest));
? ? ? ? ? ? ?ga.dup();
? ? ? ? ? ? ?ga.invokeConstructor(Type.getType(dest), org.objectweb.asm.commons.Method.getMethod("void <init>()"));
? ? ? ? ? ? ?int l3 = ga.newLocal(Type.getType(dest));
? ? ? ? ? ? ?ga.storeLocal(l3, Type.getType(dest));
? ? ? ? ? ? ?ga.loadLocal(l2, Type.getType(AspectHandle.class));
? ? ? ? ? ? ?ga.loadLocal(l3, Type.getType(dest));
? ? ? ? ? ? ?ga.invokeVirtual(Type.getType(AspectHandle.class), org.objectweb.asm.commons.Method.getMethod("void setInstance(Object)"));
? ? ? ? ? ? ?ga.loadLocal(l1, Type.getType(aspect));
? ? ? ? ? ? ?ga.loadLocal(l2, Type.getType(dest));
? ? ? ? ? ? ?//調(diào)用切面類中的方法
? ? ? ? ? ? ?Method aspectMethodName = aspect.getDeclaredMethod(methodName, AspectHandle.class);
? ? ? ? ? ? ?ga.invokeVirtual(Type.getType(aspect), org.objectweb.asm.commons.Method.getMethod(aspectMethodName));
? ? ? ? ? ? ?//構(gòu)建返回值類型
? ? ? ? ? ? ?AspectUtils.this.buildReturnValue(m, ga);
? ? ? ? ? ? ?ga.returnValue();
? ? ? ? ? ? ?ga.endMethod();
? ? ? ? ? ?} catch (Throwable _e) {
? ? ? ? ? ? ?throw Exceptions.sneakyThrow(_e);
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ?};
? ? ? ?((List<Method>)Conversions.doWrapArray(dest.getDeclaredMethods())).forEach(_function);
? ? ?}
? ?};
? ?//生成子類
? ?byte[] newClassBytes = g.gen(uuid, dest, null, _function);
? ?return this.defineClass(uuid, newClassBytes, 0, newClassBytes.length);
?}
?
?/**
? * 構(gòu)建返回值
? */
?protected void buildReturnValue(final Method m, final GeneratorAdapter ga) {
? ?Class<?> _returnType = m.getReturnType();
? ?boolean _matched = false;
? ?if (Objects.equal(_returnType, int.class)) {
? ? ?_matched=true;
? ? ?ga.checkCast(Type.getType(Integer.class));
? ? ?ga.invokeVirtual(Type.getType(Integer.class), org.objectweb.asm.commons.Method.getMethod("int intValue()"));
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, long.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Long.class));
? ? ? ?ga.invokeVirtual(Type.getType(Long.class), org.objectweb.asm.commons.Method.getMethod("long longValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, double.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Double.class));
? ? ? ?ga.invokeVirtual(Type.getType(Double.class), org.objectweb.asm.commons.Method.getMethod("double doubleValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, float.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Float.class));
? ? ? ?ga.invokeVirtual(Type.getType(Float.class), org.objectweb.asm.commons.Method.getMethod("float floatValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, boolean.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Boolean.class));
? ? ? ?ga.invokeVirtual(Type.getType(Boolean.class), org.objectweb.asm.commons.Method.getMethod("boolean booleanValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, short.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Short.class));
? ? ? ?ga.invokeVirtual(Type.getType(Short.class), org.objectweb.asm.commons.Method.getMethod("short shortValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, char.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Character.class));
? ? ? ?ga.invokeVirtual(Type.getType(Character.class), org.objectweb.asm.commons.Method.getMethod("char charValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, byte.class)) {
? ? ? ?_matched=true;
? ? ? ?ga.checkCast(Type.getType(Byte.class));
? ? ? ?ga.invokeVirtual(Type.getType(Byte.class), org.objectweb.asm.commons.Method.getMethod("byte byteValue()"));
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?if (Objects.equal(_returnType, void.class)) {
? ? ? ?_matched=true;
? ? ?}
? ?}
? ?if (!_matched) {
? ? ?ga.checkCast(Type.getType(m.getReturnType()));
? ?}
?}
?
?/**
? * 構(gòu)建AspectHandle的參數(shù)
? */
?protected void buildArguments(final org.objectweb.asm.commons.Method method, final GeneratorAdapter ga) {
? ?int _size = ((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size();
? ?boolean _greaterThan = (_size > 0);
? ?if (_greaterThan) {
? ? ?for (int index = 0; (index < ((List<Type>)Conversions.doWrapArray(method.getArgumentTypes())).size()); index++) {
? ? ? ?{
? ? ? ? ?ga.dup();
? ? ? ? ?ga.push(index);
? ? ? ? ?String _descriptor = (method.getArgumentTypes()[index]).getDescriptor();
? ? ? ? ?boolean _matched = false;
? ? ? ? ?if (Objects.equal(_descriptor, "Z")) {
? ? ? ? ? ?_matched=true;
? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ?ga.invokeStatic(Type.getType(Boolean.class), org.objectweb.asm.commons.Method.getMethod("Boolean valueOf(boolean)"));
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "C")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Character.class), org.objectweb.asm.commons.Method.getMethod("Character valueOf(char)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "B")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Byte.class), org.objectweb.asm.commons.Method.getMethod("Byte valueOf(byte)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "S")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Short.class), org.objectweb.asm.commons.Method.getMethod("Short valueOf(short)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "I")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Integer.class), org.objectweb.asm.commons.Method.getMethod("Integer valueOf(int)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "F")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Float.class), org.objectweb.asm.commons.Method.getMethod("Float valueOf(float)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "J")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Float.class), org.objectweb.asm.commons.Method.getMethod("Long valueOf(long)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?if (Objects.equal(_descriptor, "D")) {
? ? ? ? ? ? ?_matched=true;
? ? ? ? ? ? ?ga.loadArg(index);
? ? ? ? ? ? ?ga.invokeStatic(Type.getType(Float.class), org.objectweb.asm.commons.Method.getMethod("Double valueOf(double)"));
? ? ? ? ? ?}
? ? ? ? ?}
? ? ? ? ?if (!_matched) {
? ? ? ? ? ?ga.visitVarInsn(Opcodes.ALOAD, (index + 1));
? ? ? ? ?}
? ? ? ? ?ga.visitInsn(Opcodes.AASTORE);
? ? ? ?}
? ? ?}
? ?} else {
? ? ?ga.visitInsn(Opcodes.ACONST_NULL);
? ?}
?}
}以上是我們實現(xiàn)的AOP功能的全部代碼，接下來我寫個小例子，驗證一下我們
public class AspectTest2 {
public static class Dest{
public void print(String msg) {
System.out.println("我是dest的print方法");
}
}
public static class Aspect {
public void handle(AspectHandle ah) {
if(ah.getArguments()[0].equals("Hello World")) {
System.out.println("我是Aspect的handle方法");
}else {
ah.invoke();
}
}
}
public static void main(String[] args) throws InstantiationException, IllegalAccessException {
Class<?> cl = AspectUtils.getInstance().aspect(Dest.class, Aspect.class, "handle");
Dest dest = (Dest)cl.newInstance();
dest.print("Hello Dest");
}
}以上測試代碼，輸出的結(jié)果為 “ 我是dest的print方法 “ ，如果將Hello Dest 改為iHello World,輸出的結(jié)果為 “ 我是Aspect的handle方法 “ 至此我們就使用ASM框架實現(xiàn)了一個AOP環(huán)繞通知的功能
標(biāo)簽：
