简体中文 | English
🔥🔥🔥帮助 Android App 改造成AOP架构的框架 AndroidAOP
建议直接点击下边的 Docs 直接看体验更好的文档
这是一个帮助 Android App 改造成AOP架构的框架，只需一个注解就可以请求权限、切换线程、禁止多点、一次监测所有点击事件、监测生命周期等等，没有使用 AspectJ，也可以定制出属于你的 Aop 代码
1、本库内置了开发中常用的一些切面注解供你使用
2、本库支持让你自己做切面，语法简单易上手
3、本库同步支持 Java项目 和 Kotlin项目
4、本库支持切入三方库
5、本库支持切点方法为 Lambda 表达式的情况
6、本库支持切点方法为 suspend 修饰的协程函数
7、本库支持生成所有切点信息Json文件，方便一览所有切点位置在此配置
8、本库支持 debug 快速开发模式，让你打包速度几乎不变在此配置
9、本库支持 组件化开发在此配置
10、本库是纯静态织入AOP代码
11、本库不是基于 AspectJ 实现的，织入代码量极少，侵入性极低
12、丰富完善的使用文档助你完全理解本库的使用规则点此前往wiki文档
13、更有帮助你生成切面代码的插件助手供你使用点此前往下载
最低Gradle版本：7.6👇（支持8.0以上）
最低SDK版本：minSdkVersion >= 21
在开始之前可以给项目一个Star吗？非常感谢，你的支持是我唯一的动力。欢迎Star和Issues!
build.gradle 里依赖插件
-
新版本
plugins { //必须项 👇 apply 设置为 true 自动为所有module“预”配置debugMode，false则按下边步骤五的方式二 id "io.github.FlyJingFish.AndroidAop.android-aop" version "2.2.6" apply true }
或者老版本
buildscript { dependencies { //必须项 👇 classpath 'io.github.FlyJingFish.AndroidAop:android-aop-plugin:2.2.6' } } // 👇加上这句自动为所有module“预”配置debugMode，不加则按下边步骤五的方式二 apply plugin: "android.aop"
build.gradle 添加
-
新版本
//必须项 👇 plugins { ... id 'android.aop'//最好放在最后一行 }
或者老版本
//必须项 👇 apply plugin: 'android.aop' //最好放在最后一行
Caution
id 'android.aop' 这句尽量放在最后一行，尤其是必须在 id 'com.android.application' 或 id 'com.android.library' 的后边
-
直接在 app 的
build.gradle添加//必须项 👇 plugins { ... id "io.github.FlyJingFish.AndroidAop.android-aop" version "2.2.6"//最好放在最后一行 }
- 在 项目根目录 的
build.gradle里依赖插件
plugins {
//非必须项 👇，如果需要自定义切面，并且使用 android-aop-ksp 这个库的话需要配置 ，下边版本号根据你项目的 Kotlin 版本决定
id 'com.google.devtools.ksp' version '1.8.0-1.0.9' apply false
}plugins {
//非必须项 👇，如果需要自定义切面，并且使用 android-aop-ksp 这个库的话需要配置
id 'com.google.devtools.ksp'
}
dependencies {
//必须项 👇
implementation 'io.github.FlyJingFish.AndroidAop:android-aop-core:2.2.6'
//非必须项 👇这个包提供了一些常见的注解切面
implementation 'io.github.FlyJingFish.AndroidAop:android-aop-extra:2.2.6'
//必须项 👇如果您项目内已经有了这项不用加也可以
implementation 'androidx.appcompat:appcompat:1.3.0' // 至少在1.3.0及以上
//非必须项 👇，如果你想自定义切面需要用到，⚠️支持Java和Kotlin代码写的切面
ksp 'io.github.FlyJingFish.AndroidAop:android-aop-ksp:2.2.6'
//非必须项 👇，如果你想自定义切面需要用到，⚠️只适用于Java代码写的切面
annotationProcessor 'io.github.FlyJingFish.AndroidAop:android-aop-processor:2.2.6'
//⚠️上边的 android-aop-ksp 和 android-aop-processor 二选一
}Tip
1、ksp 或 annotationProcessor只能扫描当前 module ，在哪个 module 中有自定义切面代码就加在哪个 module，但是自定义的切面代码是全局生效的；必须依赖项可以通过 api 方式只加到公共 module 上
2、"android-aop-extra" 使用教程
| 注解名称 | 参数说明 | 功能说明 |
|---|---|---|
| @SingleClick | value = 快速点击的间隔，默认1000ms | 单击注解，加入此注解，可使你的方法只有单击时才可进入 |
| @DoubleClick | value = 两次点击的最大用时，默认300ms | 双击注解，加入此注解，可使你的方法双击时才可进入 |
| @IOThread | ThreadType = 线程类型 | 切换到子线程的操作，加入此注解可使你的方法内的代码切换到子线程执行 |
| @MainThread | 无参数 | 切换到主线程的操作，加入此注解可使你的方法内的代码切换到主线程执行 |
| @OnLifecycle* | value = Lifecycle.Event | 监听生命周期的操作，加入此注解可使你的方法内的代码在对应生命周期内才去执行 |
| @TryCatch | value = 你自定义加的一个flag | 加入此注解可为您的方法包裹一层 try catch 代码 |
| @Permission* | tag = 自定义标记 value = 权限的字符串数组 |
申请权限的操作，加入此注解可使您的代码在获取权限后才执行 |
| @Scheduled | initialDelay = 延迟开始时间 interval = 间隔 repeatCount = 重复次数 isOnMainThread = 是否主线程 id = 唯一标识 |
定时任务，加入此注解，可使你的方法每隔一段时间执行一次，调用AndroidAop.shutdownNow(id)或AndroidAop.shutdown(id)可停止 |
| @Delay | delay = 延迟时间 isOnMainThread = 是否主线程 id = 唯一标识 |
延迟任务，加入此注解，可使你的方法延迟一段时间执行，调用AndroidAop.shutdownNow(id)或AndroidAop.shutdown(id)可取消 |
| @CheckNetwork | tag = 自定义标记 toastText = 无网络时toast提示 invokeListener = 是否接管检查网络逻辑 |
检查网络是否可用，加入此注解可使你的方法在有网络才可进去 |
| @CustomIntercept | value = 你自定义加的一个字符串数组的flag | 自定义拦截，配合 AndroidAop.setOnCustomInterceptListener 使用，属于万金油 |
Tip
以上功能位于 android-aop-extra 库中，详细说明请看文档
本库通过以下五种注解，实现自定义切面
本篇介绍是大纲式的大致讲解，详细点此查看
- @AndroidAopPointCut 是为方法加注解的切面
- @AndroidAopMatchClassMethod 是匹配类的方法的切面
- @AndroidAopReplaceClass 是替换方法调用的
- @AndroidAopModifyExtendsClass 是修改继承类
- @AndroidAopCollectMethod 是收集继承类
一、@AndroidAopPointCut 是在方法上通过注解的形式做切面的，上述中注解都是通过这个做的，wiki文档
- 创建注解(将 @AndroidAopPointCut 加到你的注解上)
@AndroidAopPointCut(CustomInterceptCut::class)
@Target(
AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY_GETTER,
AnnotationTarget.PROPERTY_SETTER
)
@Retention(
AnnotationRetention.RUNTIME
)
annotation class CustomIntercept(vararg val value: String = [])Java写法:
@AndroidAopPointCut(CustomInterceptCut.class)
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomIntercept {
String[] value() default {};
}- 创建注解处理切面的类（需要实现 BasePointCut 接口，它的泛型填上边的注解）
class CustomInterceptCut : BasePointCut<CustomIntercept> {
override fun invoke(
joinPoint: ProceedJoinPoint,
annotation: CustomIntercept //annotation就是你加到方法上的注解
): Any? {
// 在此写你的逻辑
// joinPoint.proceed() 表示继续执行切点方法的逻辑，不调用此方法不会执行切点方法里边的代码
// 关于 ProceedJoinPoint 可以看wiki 文档，详细点击下方链接
return joinPoint.proceed()
}
}- 使用
直接将你写的注解加到任意一个方法上，例如加到了 onCustomIntercept() 当 onCustomIntercept() 被调用时首先会进入到上文提到的 CustomInterceptCut 的 invoke 方法上
@CustomIntercept("我是自定义数据")
fun onCustomIntercept(){
}
二、@AndroidAopMatchClassMethod 是做匹配某类及其对应方法的切面的,wiki文档
假如想 Hook 所有的 android.view.View.OnClickListener 的 onClick，说白了就是想全局监测所有的设置 OnClickListener 的点击事件，代码如下：
@AndroidAopMatchClassMethod(
targetClassName = "android.view.View.OnClickListener",
methodName = ["onClick"],
type = MatchType.EXTENDS //type 一定是 EXTENDS 因为你想 hook 所有继承了 OnClickListener 的类
)
class MatchOnClick : MatchClassMethod {
// @SingleClick(5000) //联合 @SingleClick ，给所有点击增加防多点，6不6
override fun invoke(joinPoint: ProceedJoinPoint, methodName: String): Any? {
Log.e("MatchOnClick", "=====invoke=====$methodName")
return joinPoint.proceed()
}
}三、@AndroidAopReplaceClass 是做替换方法调用的，wiki文档
此方式是对 @AndroidAopMatchClassMethod 的一个补充
- Kotlin写法
@AndroidAopReplaceClass("android.util.Log")
object ReplaceLog {
@AndroidAopReplaceMethod("int e(java.lang.String,java.lang.String)")
@JvmStatic
fun e( tag:String, msg:String) :Int{
return Log.e(tag, "ReplaceLog-$msg")
}
}
该例意思就是凡是代码中写Log.e的地方都被替换成ReplaceLog.e
Java写法
@AndroidAopReplaceClass(
"android.widget.Toast"
)
public class ReplaceToast {
@AndroidAopReplaceMethod(
"android.widget.Toast makeText(android.content.Context, java.lang.CharSequence, int)"
)
// 因为被替换方法是静态的，所以参数类型及顺序和被替换方法一一对应
public static Toast makeText(Context context, CharSequence text, int duration) {
return Toast.makeText(context, "ReplaceToast-"+text, duration);
}
@AndroidAopReplaceMethod(
"void setGravity(int , int , int )"
)
// 因为被替换方法不是静态方法，所以参数第一个是被替换类，之后的参数和被替换方法一一对应
public static void setGravity(Toast toast,int gravity, int xOffset, int yOffset) {
toast.setGravity(Gravity.CENTER, xOffset, yOffset);
}
@AndroidAopReplaceMethod(
"void show()"
)
// 虽然被替换方法没有参数，但因为它不是静态方法，所以第一个参数仍然是被替换类
public static void show(Toast toast) {
toast.show();
}
}该例意思就是凡是代码中写Toast.makeText和Toast.show ...的地方都被替换成ReplaceToast.makeText和ReplaceToast.show ...
四、@AndroidAopModifyExtendsClass 是修改目标类的继承类，wiki文档
通常是在某个类的继承关系中替换掉其中一层，然后重写一些函数，在重写的函数中加入一些你想加的逻辑代码，起到监听、改写原有逻辑的作用
@AndroidAopModifyExtendsClass("androidx.appcompat.widget.AppCompatImageView")
public class ReplaceImageView extends ImageView {
public ReplaceImageView(@NonNull Context context, @Nullable AttributeSet attrs) {
super(context, attrs);
}
@Override
public void setImageDrawable(@Nullable Drawable drawable) {
super.setImageDrawable(drawable);
//做一些监测或者再次修改
}
}该例就是要把 AppCompatImageView 的继承类替换成 ReplaceImageView
五、@AndroidAopCollectMethod 是收集继承类，wiki文档
使用起来极其简单，示例代码已经说明了
- Kotlin 写法
object InitCollect {
private val collects = mutableListOf<SubApplication>()
private val collectClazz: MutableList<Class<out SubApplication>> = mutableListOf()
@AndroidAopCollectMethod
@JvmStatic
fun collect(sub: SubApplication){
collects.add(sub)
}
@AndroidAopCollectMethod
@JvmStatic
fun collect2(sub:Class<out SubApplication>){
collectClazz.add(sub)
}
//直接调这个方法（方法名不限）上边的函数会被悉数回调
fun init(application: Application){
for (collect in collects) {
collect.onCreate(application)
}
}
}Java写法
public class InitCollect2 {
private static final List<SubApplication2> collects = new ArrayList<>();
private static final List<Class<? extends SubApplication2>> collectClazz = new ArrayList<>();
@AndroidAopCollectMethod
public static void collect(SubApplication2 sub) {
collects.add(sub);
}
@AndroidAopCollectMethod
public static void collect3(Class<? extends SubApplication2> sub) {
collectClazz.add(sub);
}
//直接调这个方法（方法名不限）上边的函数会被悉数回调
public static void init(Application application) {
Log.e("InitCollect2", "----init----");
for (SubApplication2 collect : collects) {
collect.onCreate(application);
}
}
}此资源库自带混淆规则，并且会自动导入，正常情况下无需手动导入。
都看到这里了，如果您喜欢 AndroidAOP，或感觉 AndroidAOP 帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢～ 😃
如果感觉 AndroidAOP 为您节约了大量开发时间、为您的项目增光添彩，您也可以扫描下面的二维码，请作者喝杯咖啡 ☕
如果在捐赠留言中备注名称，将会被记录到列表中~ 如果你也是github开源作者，捐赠时可以留下github项目地址或者个人主页地址，链接将会被添加到列表中
- 有问题可以加群大家一起交流 点此加QQ群：641697838
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}
