Android中Kotlin使用AspectJ的切面编程

本文写的时候 AndroidStudio版本为3.6.3 Gradle版本为5.6.4 若后续版本更新可能有版本兼容问题,需要读者自己适配,或者参照:
AspectJ的github地址 :https://github.com/HujiangTechnology/gradle_plugin_android_aspectjx
本文仅是对于AspectJ在kotlin中的使用的一个记录,不涉及到切面的概念及其详细的说明,
关于AspectJ的更详细的说明:https://blog.csdn.net/zlmrche/article/details/79643801

一、配置

1、依赖配置

//在项目根目录下的build.gradle中
classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.10'
--------------------------------------------------------------------------------------------------
//在app或其他module目录下的build.gradle中
...
apply plugin: 'android-aspectjx'
apply plugin: 'kotlin-kapt'

dependencies {
    ...
    implementation 'org.aspectj:aspectjrt:1.9.5'
}

2、离线配置
先在项目下创建一个plugins文件,然后下载gradle-android-plugin-aspectjx-2.0.9.jar包,将下载的jar放到plugins文件夹中,在项目的build.glide文件中按照下面的配置进行配置,然后让项目依赖该包(注意是项目依赖)
https://github.com/HujiangTechnology/AspectJX-Demo/tree/master/plugins

dependencies {
        ...
        classpath fileTree(dir:'plugins', include:['*.jar'])
    }
注意:上面两种依赖根据需要选择其中一种就行,第一种依赖配置有时候会涉及到翻墙(我依赖的时候在阿里云上是解析不到该库的需要翻墙)所以更推荐第二种

二、使用

这个使用的例子是定义一个打印方法执行时间的例子(在需要打印方法执行时间的方法上用定义的注解修饰,方法执行的时候会打印出方法名称及其执行时间)

/**
 * 第一步定义注解(这就是用来修饰需要打印时间方法的注解)
 */
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class PrintFunTime
/**
 * 第二步定义切面使用@Aspect修饰一个类
 */
@Aspect
class Aop {

    /**
     * 第三步定义切点 使用@Pointcut修饰一个用@Aspect修饰的类中的方法
     * @Pointcut 中execution的参数表示的是所有带PrintFunTime注解的方法
此处由于只是一个简单的示例所以只用了这一种方式,若需要适配更多的方法可以参考
[https://blog.csdn.net/zlmrche/article/details/79643801](https://blog.csdn.net/zlmrche/article/details/79643801)
这里面有更详细的说明

     */
    @Pointcut("execution(@com.weilai.study.PrintFunTime * *(..))")
    fun printFunTime() {}

    /**
     * 第四步关联切点与处理逻辑方法 使用@Around修饰定义的方法,参数为第三步的切点方法
     *
     */
    @Around("printFunTime()")
    @Throws(Throwable::class)
    fun aroundPrintFunTime(point:ProceedingJoinPoint) {
        //获取调用方法定义
        val method = (point.signature as? MethodSignature)?.method ?: return
        //判断方法上的注解,如果方法上有定义的注解PrintFunTime 打印方法调用时间
        if (method.isAnnotationPresent(PrintFunTime::class.java)) {
            val startTime = System.currentTimeMillis()
            point.proceed()
            println("printFunTime method ${method.name}  time = ${System.currentTimeMillis() - startTime}")
        }
    }
}

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        print()
    }
    //最后在需要打印时间的方法上,用PrintFunTime修饰,当print方法被调用完成的时候就会打印其执行的时间
    @PrintFunTime
    fun print() {
        println("小乖乖")
    }

以上是一个简单的AspectJ的使用方式,AspectJ的更多的使用需要根据业务去定义,比如项目已经开发得差不多了,这时候需要在项目中添加许多的用户权限判断的场景,使用切面的话可以让开发过程轻松许多,也好维护许多。
总的来说,切面的使用就四个步骤
1、定义注解
2、定义切面
3、定义切点
4、关联切点及逻辑处理

你可能感兴趣的:(Android中Kotlin使用AspectJ的切面编程)