Java自定义注解实现Router跳转

简介

      Android项目架构中,随着业务的复杂越来越大,模块化/组件化是必须的。对于Activity之间的跳转希望通过注解自动实现,模仿ARouter做法,实现简单路由组件。

思路

  1. 创建注解lib模块,自定义注解
  2. 创建注解编译处理lib模块,实现添加注解标识的类和注解的映射关系
  3. 创建公用跳转的Router工具类

实现

  1. 项目中创建自定义注解module,类型为Java Library,如lib_annotation.创建自定义注解IRouter,如下
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface IRouter {
    // 注解参数
    String path();
}
image.png
  1. 项目中创建注解编译module,类型为Java Library,如lib_compiler。创建继承自AbstractProcessor的处理类并且重写方法process。
    lib_compiler模块的build.gradle添加依赖:
implementation 'com.squareup:javapoet:1.11.1' //一款可以自动生成Java文件的第三方依赖
    implementation 'com.google.auto.service:auto-service:1.0-rc5' //自动在META-INF文件夹下生成Processor配置信息文件
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc5'
    implementation project(":lib_annotation")

重写process方法

@AutoService(value = {Processor.class})
@SupportedAnnotationTypes(value = {"com.supcon.mes.lib_annotation.IRouter"})
@SupportedSourceVersion(value = SourceVersion.RELEASE_8)
public class IActivityProcess extends AbstractProcessor {

    private Filer mFiler;

    private static final String ROUTER_PACKAGE = "com.supcon.mes.router";
    private static final String ROUTER_NAME = "Activity_Router_Mapper";

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        mFiler = processingEnv.getFiler();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 获取添加IRouter注解的所有类
        Set<? extends Element> annotatedElements = roundEnv.getElementsAnnotatedWith(IRouter.class);
        // 使用JavaPoet工具 创建注解映射类
        TypeSpec.Builder builder = TypeSpec.classBuilder(ROUTER_NAME).addModifiers(PUBLIC);
        for (Element annotatedElement : annotatedElements) {
            // 获取注解参数path
            String path = annotatedElement.getAnnotation(IRouter.class).path();
            // 获取被注解的类名
            String name = annotatedElement.getSimpleName().toString();
            // 获取类名全称
            TypeElement typeElement = (TypeElement) annotatedElement;
            String className = typeElement.getQualifiedName().toString();
            // 创建字段:以path为变量名,以类名为值
            FieldSpec fieldSpec = FieldSpec.builder(String.class,path).addModifiers(PUBLIC).addModifiers(STATIC)
                    .initializer("$S",className).build();
            // 将字段添加到类中
            builder.addField(fieldSpec);
        }
        try {
            // 创建Java文件
            JavaFile javaFile = JavaFile.builder(ROUTER_PACKAGE,builder.build()).build();
            javaFile.writeTo(mFiler);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return true;
    }
}
image.png

3.需要的模块引入依赖,rebuild后在相应的模块路径.../build/generated/source/apt/debug/com.supcon.mes.router/下,创建一个名为Activity_Router_Mapper的映射java文件

implementation project(":lib_annotation")
implementation project(":lib_compiler")
annotationProcessor project(":lib_compiler")
image.png

4.实现公用Router工具类

public class RouterHelper {
    public static void goActivity(Context context,String path, Bundle extra){
        Intent intent = new Intent(context,getActivity(path));
//        intent.setClass(context,getActivity(path));
        if (extra != null){
            intent.putExtras(extra);
        }
        context.startActivity(intent);
    }

    private static Class<?> getActivity(String path) {
        try {
            Class<?> routerClass = Activity_Router_Mapper.class;
            Field field = routerClass.getField(path);
            return  Class.forName(field.get(routerClass).toString());
        } catch (NoSuchFieldException | ClassNotFoundException | IllegalAccessException e) {
            e.printStackTrace();
            return null;
        }
    }
}

5.使用

@IRouter(path = Constant.Router.LOGIN)
public class LoginActivity extends AppCompatActivity {
// ...TODO
}

@IRouter(path = Constant.Router.SETTING)
public class SettingsActivity extends AppCompatActivity {
// ...TODO
}

RouterHelper.goActivity(LoginActivity.this,Constant.Router.SETTING,null);

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容