使用AspectJ在Android中实现Aop登录拦截

绝地灬酷狼 2023-10-06 22:17 49阅读 0赞

Java后端人员，业余搞着玩，不对的地方请见谅。

### 1、build.gradle 配置 ###

在app/build.gradle中配置如下

#### 导入gradle的插件包 ####

//buildscript中的声明是gradle脚本自身需要使用的资源,而在build.gradle文件中直接声明的依赖项、仓库地址等信息是项目自身需要的资源。放在文件开头。
    buildscript {
        repositories {
            mavenCentral()
        }
        dependencies {
            classpath 'org.aspectj:aspectjtools:1.8.9'
            classpath 'org.aspectj:aspectjweaver:1.8.9'
        }
    }

#### 导入jar包 ####

dependencies {
        implementation 'org.aspectj:aspectjrt:1.9.6' //引入 aspectj
    }

#### 使 AspectJ 配置生效 ####

import org.aspectj.bridge.IMessage
    import org.aspectj.bridge.MessageHandler
    import org.aspectj.tools.ajc.Main
    
    // 获取log打印工具和构建配置
    final def log = project.logger
    final def variants = project.android.applicationVariants
    variants.all { variant ->
        if (!variant.buildType.isDebuggable()) {
            // 判断是否debug，如果打release把return去掉就可以
            log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
            // return;
        }
        // 使aspectj配置生效
        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);
            //在编译时打印信息如警告、error等等
            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;
                }
            }
        }
    }

### 2、自定义注解 ###

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    /**自定义注解*/
    @Retention(RetentionPolicy.RUNTIME)//定义我们自己写的注解何时有效
    @Target(ElementType.METHOD)//定义我们写的注解可以描述的成员
    public @interface LoginFilter {
    
        //在注解里加了个loginDefine，就是为了给用户提供自定义实现，如根据loginDefine值不同做不同的登录处理。
        int loginDefine() default 0;
    
    }

### 3、配置切面 ###

import android.content.Context;
    
    import com.app.pest.anno.LoginFilter;
    
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.Signature;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.aspectj.lang.reflect.MemberSignature;
    import org.aspectj.lang.reflect.MethodSignature;
    
    /**
     * 登录切面处理
     */
    
    @Aspect//此注解描述的类为切面类，其内部可以定义切入点表达式和通知方法
    public class LoginFilterAspect {
        private static final String TAG = "LoginFilterAspect";
    
        //@annotation(包名.注解名)
        @Pointcut("@annotation(com.app.pest.anno.LoginFilter)")
        public void LoginFilter() {//承载切入点表达式的定义，方法不写任何内容
        }
    
    
        // @Around("@annotation(com.app.pest.anno.LoginFilter)")
        @Around("LoginFilter()")
        public void aroundLoginPoint(ProceedingJoinPoint joinPoint) throws Throwable {
            //获取用户实现的ILogin类，如果没有初始化就抛出异常。
            ILoginFilter iLoginFilter = LoginAssistant.getInstance().getILoginFilter();
            if (iLoginFilter == null) {
                throw new RuntimeException("LoginManger没有初始化");
            }
            //先得到方法的签名methodSignature，然后得到@LoginFilter注解，如果注解为空，就不再往下走。
            Signature signature = joinPoint.getSignature();
            if (!(signature instanceof MemberSignature)) {
                throw new RuntimeException("该注解只能用于方法上");
            }
            MethodSignature methodSignature = (MethodSignature) signature;
            LoginFilter loginFilter = methodSignature.getMethod().getAnnotation(LoginFilter.class);
            if (loginFilter == null) {
                return;
            }
            Context mContext = LoginAssistant.getInstance().getApplicationContext();
            //调用iLogin的isLogin()方法判断是否登录，这个isLogin是留给使用者自己实现的，如果登录，就会继续执行方法体调用方法直到完成，如果没有登录，执行下一个
            if (iLoginFilter.isLogin(mContext)) {//已经登录
                joinPoint.proceed();//执行目标方法
            } else {
                iLoginFilter.login(mContext, loginFilter.loginDefine());
            }
    
        }
    }

### 4、使用登录拦截器 ###

在需要拦截的方法上加上注解即可

@LoginFilter(loginDefine = 0)
        @Override
        //跳转到需要拦截登录的Activity
        public void onClick(View v) {
            startActivity(new Intent(this, SecondActivity.class));
        }

### 踩坑 ###

**okhttp3的4.9.x版本让aop失效，降低版本就行了。**

implementation 'com.squareup.okhttp3:okhttp:4.8.1' //引入 okhttp

![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16][] ![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 1][] ![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 2][] ![watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 3][]

源码：

[https://github.com/antporter/pest][https_github.com_antporter_pest]

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/dfd318470ae84dad97c10afd465cd209.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP55m-6I-c,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/fcda148b7e8b4996a1937ff7be38bcf9.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP55m-6I-c,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/7ae27f23e570406da9bca819910a0263.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP55m-6I-c,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP55m-6I-c_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/c3ae0ecb4f4b4268b5db6f21de175c5b.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP55m-6I-c,size_20,color_FFFFFF,t_70,g_se,x_16
[https_github.com_antporter_pest]: https://github.com/antporter/pest