解决Android AOP，Kotlin AspectJ 不生效的问题

深藏阁楼爱情的钟 2023-10-18 14:54 124阅读 0赞

#### 原本配置 ####

根目录gradle

buildscript {
    
        ext.kotlin_version = '1.2.71'
        repositories {
            google()
            jcenter()
        }
        
        dependencies {
            classpath 'com.android.tools.build:gradle:3.2.1'
    
            classpath 'org.aspectj:aspectjtools:1.8.9'
            classpath 'org.aspectj:aspectjweaver:1.8.9'
            classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        }
    }

app gradle

apply plugin: 'com.android.application'
    
    apply plugin: 'kotlin-android'
    apply plugin: 'kotlin-android-extensions'
    apply plugin: 'kotlin-kapt'
    
    dependencies {
    	implementation 'org.aspectj:aspectjrt:1.8.9'
    }
    
    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;
                }
            }
        }
    }

在此配置情况下，Kotlin代码使用 AOP无法生效，在网上寻找解决方法，终于找到了如下的方法。

#### 解决方法 ####

使用沪江的[gradle\_plugin\_android\_aspectjx][gradle_plugin_android_aspectjx]

在根目录的gradle的dependencies领域下，增加如下代码

classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.4'

删除如下代码

classpath 'org.aspectj:aspectjtools:1.8.9'
      classpath 'org.aspectj:aspectjweaver:1.8.9'

> 注意，此处的2.0.4版本和app.gradle的dependencies领域下的org.aspectj:aspectjrt:1.8.9版本需要对应，否则会报错。

在app的gradle中，增加如下代码

apply plugin: 'android-aspectjx'

删除下面这些代码

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;
                }
            }
        }
    }

更改了这些配置后，Kotlin代码就可以使用AOP了

#### 贴出完整配置代码 ####

根目录gradle

buildscript {
        ext.kotlin_version = '1.2.71'
        repositories {
            google()
            jcenter()
        }
        dependencies {
            classpath 'com.android.tools.build:gradle:3.2.1'
            classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
            classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.4'
        }
    }
    
    ......

app的gradle

apply plugin: 'com.android.application'
    
    apply plugin: 'kotlin-android'
    apply plugin: 'android-aspectjx'
    apply plugin: 'kotlin-android-extensions'
    apply plugin: 'kotlin-kapt'
    
    android {
        ......
        aspectjx {
        	include "包名" //可加可不加，有些第三方库不加会编译会报错
        }
    }
    
    dependencies {
        ......
        implementation 'org.aspectj:aspectjrt:1.8.9'
    }

#### 相关Demo ####

[AspectJKotlinTest][]  
[AspectJXTest][]

关于Android AspectJ的使用，推荐看这篇文章: [Android AspectJ详解][Android AspectJ]

[gradle_plugin_android_aspectjx]: https://github.com/HujiangTechnology/gradle_plugin_android_aspectjx
[AspectJKotlinTest]: https://github.com/EthanCo/PettyModules/tree/master/PettyTest2018/AspectJKotlinTest
[AspectJXTest]: https://github.com/EthanCo/PettyModules/tree/master/AOP/AspectJXTest
[Android AspectJ]: https://juejin.im/post/6844903941054922760