更多知识,更多乐趣

当前位置:首页软件开发Android → Android Apt之Activity Route的示例

Android Apt之Activity Route的示例

时间:2018-01-31 01:57:03来源:互联网我要评论(0)

前言

什么是Apt

APT从原理上讲是一个编译期的注解处理工具(Annotation Processing Tool)。一些主流的三方库(ButterKnife,Glide)都用到了这个技术来生成代码。

Apt有什么好处

  1. 自动生成模板代码,提高了开发效率

  2. 编译期对注解的处理,相对于运行期对注解的处理,性能上要好的多。

Gradle脚本中的apt和annotationProcessor

这两个从广义上说都是编译期的注解处理工具。只不过android-apt(其实是一个gradle插件,apt是插件命令)是早期的github的一个开源项目,annotationProcessor是gradle build tools 2.2之后自带的编译期注解工具(官方支持的,可替代开源的gradle插件android-apt)。android-apt的作者已经发表声明表示Android Studio插件已经支持annotationProcessor,并且会警告和阻止使用android-apt。总的来说,看你的gradle build tools的版本,低版本用android-apt(需要引入插件),高版本用annotationProcessor(无需引入插件)

代码设计

需求分析

这里将route模块分成三部分(一个android library,两个java library)
1、router-annotation(java library)

这里java工程里面只放注解的声明类。这里只实现了两个注解RouterActivity、RouterField。

2、router-compiler (java library)

这个工程是编译期依赖的工程,作用是编译期扫描代码,根据RouterActivity、RouterField这两个注解的使用,生成相关代码。这里需要讲下如何扫描代码并且生成代码的。这部分功能的实现主要依赖两个库:Google的auto-service(扫描代码),Squareup的javapoet(生成代码)

3、router (android library)

主要逻辑代码。在这个模块中会定义一些功能类和接口。router-compiler模块可以根据这些接口和功能类generate逻辑代码。需要注意的是router-compiler是不需要依赖router的,router-compiler是根据包名+类名的方式获取类的。

代码实现

router-annotation

RouterActivity是一个注解,用此注解修饰的Activity根据指定的路由地址,会自动添加到路由表中,当系统挂载了路由表之后,就可根据指定的路由地址来访问特定的Activity了。代码如下:

?

1
2
3
4
5
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RouterActivity {
  String[] value();
}

这里Activity可用多个路由地址修改。

RouterField是一个用于表示Activity跳转时参数传递的注解,用这个注解修饰的成员变量,表示为接收Intent参数的变量。

?

1
2
3
4
5
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RouterField {
  String[] value();
}

router-compiler

这个模块只包含一个类RouterProcessor,这个类的大致结构如下:

?

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
//此处用AutoService注解,就可实现编译期自动扫描代码
@AutoService(Processor.class)
public class RouterProcessor extends AbstractProcessor{
  private Elements elementUtils;
  private String targetModuleName = "";
  @Override
  public Set<String> getSupportedAnnotationTypes() {
    //支持的注解类型
    return Collections.singleton(RouterActivity.class.getCanonicalName());
  }
 
  @Override
  public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
   //处理代码扫描结果的关键函数
   ...
    return true;
  }
 
  @Override
  public synchronized void init(ProcessingEnvironment processingEnvironment) {
    super.init(processingEnvironment);
    //在扫描代码之前可从build.gradle中读取一些配置项
  }
 
  @Override
  public SourceVersion getSupportedSourceVersion() {
    //表示支持的Jdk版本
    return SourceVersion.RELEASE_7;
  }
}

下面分别讲解一下函数的实现:

1、init函数

我们的项目大多都是多module的形式,这时候我们就需要为每个module创建一个Activity路由注册表,然后在Application初始化的时候将所有的路由注册表挂载上,达到Activity路由跳转的目的。这里我们在init函数中,配置每个模块路由表的前缀名称。

?

1
2
3
4
5
6
7
8
9
10
11
@Override
 public synchronized void init(ProcessingEnvironment processingEnvironment) {
   super.init(processingEnvironment);
   elementUtils = processingEnvironment.getElementUtils();
   Map<String, String> map = processingEnvironment.getOptions();
   Set<String> keys = map.keySet();
   for (String key: keys) {
     if ("targetModuleName".equals(key)) {
       this.targetModuleName = map.get(key);
     }
     System.out.println(key + " + " + map.get(key));

并在module的build.gradle文件下配置如下代码:

?

1
2
3
4
5
apt {
  arguments {
    targetModuleName 'moduleName'
  }
}

2、process函数

这个函数的大致流程如下:找到所有被RouterActivity修饰的Activity;实现router模块中的RouterInitializer接口,将每个Activity的路由地址加入路由表中;同时为每个Activity创建一个XXXActivityHelper(用于更友好的Activity调整),并将每个XXXAcitivyHelper放入RouterHelper中,提供get方法获取。process函数的具体实现,可详见项目源码(都是一些代码生成的语句,没有多少逻辑)。

router

  1. RouterInitializer接口,用于每个module注册表的实现

  2. ActivityHelper,封装了一些参数解析逻辑,更方便的Activity跳转

  3. SafeBundle, 对Activity的参数进行了封装

  4. Router, 路由核心类,支持url跳转,解析url,并实现跳转。

  5. 'RouterCenterActivity', 可被外部浏览器唤起的中转Activity(外面根据url scheme唤醒RouterCenterActivity,RouterCenterActivity分发路由地址)

代码使用

初始化Router

?

1
2
3
4
5
6
7
8
public class DemoApp extends Application {
 
  @Override
  public void onCreate() {
    super.onCreate();
    Router.init("demo"); //自定义scheme协议
  }
}

Activity跳转

?

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@RouterActivity({"main"})
public class MainActivity extends AppCompatActivity {
 
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    findViewById(R.id.btn_second).setOnClickListener(new View.OnClickListener() {
      @Override
      public void onClick(View v) {
        RouterHelper.getSecondActivityHelper().start(MainActivity.this);
      }
    });
  }
}
 
@RouterActivity({"second"})
public class SecondActivity extends AppCompatActivity {
  @Override
  protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_second);
  }
}

build目录生成的代码如下:


相关文章

网友评论

热门评论

最新评论

发表评论 查看所有评论()

昵称:
表情: 高兴 可 汗 我不要 害羞 好 下下下 送花 屎 亲亲
字数: 0/500 (您的评论需要经过审核才能显示)

关于万荚 | 联系方式 | 发展历程 | 版权声明 | 帮助(?) | 网站地图 | 友情链接

Copyright 2005-2018 16WJ.COM 〖万荚网〗 版权所有 桂ICP备18000060号 |

声明: 本站所有文章来自互联网 如有异议 请与本站联系