一、AOP
全称“Aspect Oriented Programming”,面向切面编程,由于面向对象的思想要求高内聚,低耦合的风格,使模块代码间的可见性变差,对于埋点,日志输出等需求,就会变的十分复杂,如果手动编写代码,入侵性很大,不利于扩展,AOP应运而生。
二、使用场景
当我们需要在某个方法运行前和运行后做一些处理时,便可使用AOP技术。具体有:
- 统计埋点
- 日志打印/打点
- 数据校验
- 行为拦截
- 性能监控
- 动态权限控制
***三、环境配置
我们以Android工程+官方的AspectJ为例
1.项目根目录build.gradle配置
dependencies {
classpath 'org.aspectj:aspectjtools:1.8.9'
classpath 'org.aspectj:aspectjweaver:1.8.9'
}
2.具体使用AspectJ的工程build.gradle中配置
dependencies {
implementation 'org.aspectj:aspectjrt:1.8.13'
}
import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main
final def log = project.logger
final def variants = project.android.applicationVariants
variants.all { variant ->
if (!variant.buildType.isDebuggable()) {
log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
return;
}
JavaCompile javaCompile = variant.javaCompile
javaCompile.doLast {
String[] args = ["-showWeaveInfo",
"-1.8",
"-inpath", javaCompile.destinationDir.toString(),
"-aspectpath", javaCompile.classpath.asPath,
"-d", javaCompile.destinationDir.toString(),
"-classpath", javaCompile.classpath.asPath,
"-bootclasspath", project.android.bootClasspath.join(File.pathSeparator)]
log.debug "ajc args: " + Arrays.toString(args)
MessageHandler handler = new MessageHandler(true);
new Main().run(args, handler);
for (IMessage message : handler.getMessages(null, true)) {
switch (message.getKind()) {
case IMessage.ABORT:
case IMessage.ERROR:
case IMessage.FAIL:
log.error message.message, message.thrown
break;
case IMessage.WARNING:
log.warn message.message, message.thrown
break;
case IMessage.INFO:
log.info message.message, message.thrown
break;
case IMessage.DEBUG:
log.debug message.message, message.thrown
break;
}
}
}
}
以上配置完成后,便可以项目中进行使用了,当然,除了官方提供的,还有其他三方的aspectJ框架供我们使用,如https://github.com/HujiangTechnology/gradle_plugin_android_aspectjx,其配置与上面的略有不同,开发者根据自己选择的具体框架进行相应的配置
三、代码实例
public class AspectJActivity extends AppCompatActivity {
private String TAG = "AspectJActivity";
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_aspect);
Log.i(TAG,hashCode()+"");
aspectTest();//以普通方法进行aspectJ处理
aspectTestAnn();//以注解方式进行
}
public void aspectTest() {
Log.i(TAG, "aspect test");
}
@AspectAnn
public void aspectTestAnn() {
Log.i(TAG, "aspect by annoation test");
}
}
要求,在运行aspectTest()前先打印一个信息,在运行aspectTestAnn后也打印一个信息,两者最大的区别在于,前者使用类名和方法名来实现切面,而后者则使用注解来实现,在实际开发中,用注解来实现切面的场景更多一些。
自定义注解AspectAnn
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AspectAnn {
}
关键的切面处理类 AspectUtil
@Aspect
public class AspectUtil {
@Pointcut
("execution(* com.game.xiangxuemytest.aspectj.AspectJActivity.aspectTest(..))")
public void pointActionMethod() {}
@Before("pointActionMethod()")
public void testBefore(){
Log.i("AspectJActivity","AspectUtil method1 Before");
}
// @Pointcut
// ("@annotation(com.game.xiangxuemytest.aspectj.AspectAnn)")
// public void pointActionMethod2(AspectAnn ann) {
//
// }
@Pointcut
("execution(@com.game.xiangxuemytest.aspectj.AspectAnn * *(..))")
public void pointActionMethod2() {
}
@After("pointActionMethod2()")
public void testAfter(JoinPoint point) {
Log.i("AspectJActivity", "AspectUtil method2 After");
}
}
@Aspect 标志切面的处理类
@Pointcut标志切点是谁,后面跟符合切点的规则。
1> 包名+类名+方法名来确定切点规则:
pointActionMethod()上,com.game.xiangxuemytest.aspectj.AspectJActivity.aspectTest(..)。其中第一个 * 号表示返回值可为任意类型,括号内表示参数列表, .. 表示匹配任意个参数,参数类型为任何类型
2>以注解来确定切点规则的:
方法 pointActionMethod2(),@com.game.xiangxuemytest.aspectj.AspectAnn * (..)),注意两个 之间有个空格,和方式1略有不同。
@Before
切入代码运行在目标代码前,同理还有 @After,@Around等,表示目标后,及目标前+后。其目的表示切入点运行的代码。同时,由于可以存在多个切入点,所以该注解后要跟上切入点的方法名,
execution,这个我理解的为实现切入的方式吧。另外还有一个call,随后我们可以根据.class文件看一下两者的区别。
运行结果:
AspectUtil method1 Before
aspect test
aspect by annoation test
AspectUtil method2 After
四、实现原理
通过Gradle Transform,在class文件生成后至dex文件生成前,遍历并匹配所有符合AspectJ文件中声明的切点,更改我们原有的.class文件,将事先声明好的代码在切点前后织入。因此,这个增加我们的编译时间,下面来看一下上述代码的最终的.class文件
image.png
为了方便后面的问题,我们以截图的方式显示,注意红框部分。从.class文件可以看到,我们原有的方法前或后,增加了新的代码。从而实现了我们想要的切面功能。
五、call与execution
上面我们说了,这两个会影响切面实现的方式,我们把execution改为call后,看一下其.class
image.png比较两者,可以发现,call的方式,不会改变原有的代码,而是在目标方法的调用前后,进行了相应的新代码的插入。
以上是个人对AspecJ的一些入门理解,希望能对小伙伴们有所帮助。
网友评论