文章目录

一、注解节点类型
二、JavaPoet 简介
三、注解处理器中使用 JavaPoet 生成代码
四、路由框架说明
五、博客资源

组件化系列博客 :

【Android 组件化】从模块化到组件化
【Android 组件化】使用 Gradle 实现组件化 ( Gradle 变量定义与使用 )
【Android 组件化】使用 Gradle 实现组件化 ( 组件模式与集成模式切换 )
【Android 组件化】使用 Gradle 实现组件化 ( 组件 / 集成模式下的 Library Module 开发 )
【Android 组件化】路由组件 ( 路由组件结构 )
【Android 组件化】路由组件 ( 注解处理器获取被注解的节点 )

在【Android 组件化】路由组件 ( 注解处理器获取被注解的节点 ) 博客中声明了支持的注解类型 , 并在 Activity 中使用了注解 , 在注解处理器中检测出来使用注解的类节点 TypeElement ;

本篇博客中讲解 " 注解处理器 " 后续开发 , 生成 Java 代码 ;

一、注解节点类型

在 " 注解处理器 " AbstractProcessor 中的 process 方法中 , 可以获取使用注解的节点 ;

使用注解标注的 Element 节点类型 : 注解节点都是 javax.lang.model.element.Element 的子类

ExecutableElement : 使用注解的方法节点类型 ;
VariableElement : 使用注解的字段节点类型 , 类的成员变量 ;
TypeElement : 使用注解的类节点类型 ;
PackageElement : 使用注解的包节点类型 ;

在类上使用 @Route 注解 , 则获取的节点类型都是 TypeElement ;

二、JavaPoet 简介

JavaPoet 的作用是用于生成 Java 源代码 ;

JavaPoet 项目 GitHub 地址 : https://github.com/square/javapoet

添加依赖库 : 在 Android Studio 项目中的 Module 下的 build.gradle 添加如下依赖库 , 即可使用 JavaPoet ;

compile 'com.squareup:javapoet:1.13.0'

使用 JavaPoet 生成方法 : 调用 MethodSpec 的如下方法可以完成 Java 函数创建 ;

methodBuilder 静态方法 , 创建方法 , 参数是函数名 ,
addModifiers 方法可以设置函数的可见性 , 是否是静态方法 ,
returns 方法设置返回值 ,
addParameter 方法设置函数参数类型 , 以及参数名称 ,
addStatement 方法设置函数体 ,
build 方法正式生成函数 ;

// 生成 public static void main(String[] args) 函数
MethodSpec main = MethodSpec.methodBuilder("main").addModifiers(Modifier.PUBLIC, Modifier.STATIC).returns(void.class).addParameter(String[].class, "args").addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!").build();

生成的 Java 函数如下 :

  public static void main(String[] args) {System.out.println("Hello, JavaPoet!");}

使用 JavaPoet 生成方法 : 调用 TypeSpec 的如下方法可以完成 Java 类创建 ;

classBuilder 静态方法 , 创建类 , 参数是类名 ,
addModifiers 方法可以设置类的可见性 , 是否是 final 方法 ,
addMethod 方法设置类中的函数 ;

// 指定 public final class HelloWorld 类
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC, Modifier.FINAL).addMethod(main).build();

生成的 HelloWoirld 类如下 :

public final class HelloWorld {public static void main(String[] args) {System.out.println("Hello, JavaPoet!");}
}

三、注解处理器中使用 JavaPoet 生成代码

在【Android APT】注解处理器 ( 根据注解生成 Java 代码 ) 博客中使用字符输出流 Writer 直接写出字符串的方式 , 生成了 Java 代码 , 不过每行代码都需要自己生成 ,

注解处理器中 , 使用 Filer 对象写出 Java 代码 , 获取 Filer 对象 , 保存在成员字段 Filer mFiler 中 ;

AbstractProcessor 注解处理器的 init 方法中 , 调用 ProcessingEnvironment processingEnvironment 参数的 getFiler 方法 , 获取 Filer 对象 ;

在 AbstractProcessor 注解处理器的 process 中根据获取的注解 , 生成相关代码 ;

注解处理器使用 JavaPoet 示例 :

package kim.hsl.router_compiler;import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;import java.io.IOException;
import java.util.Set;import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Filer;
import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;// 自动注册注解处理器
@AutoService(Processor.class)
// 支持的注解类型
@SupportedAnnotationTypes({"kim.hsl.router_annotation.Route"})
// 支持的 Java 版本
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class RouterProcessor extends AbstractProcessor {/*** 注解处理器中使用 Messager 对象打印日志*/private Messager mMessager;/*** 用于写出生成的 Java 代码*/private Filer mFiler;/*** 该函数在初始化时调用 , 相当于构造函数* @param processingEnvironment*/@Overridepublic synchronized void init(ProcessingEnvironment processingEnvironment) {super.init(processingEnvironment);// 获取打印日志接口this.mMessager = processingEnvironment.getMessager();mMessager.printMessage(Diagnostic.Kind.NOTE, "Messager Print Log");this.mFiler = processingEnvironment.getFiler();}/*** 该函数在注解处理器注册时自动执行, 是处理注解的核心函数** Set<? extends TypeElement> set 参数 : 该集合表示使用了相关注解的节点的集合** @param set* @param roundEnvironment* @return*/@Overridepublic boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {for (TypeElement typeElement: set){mMessager.printMessage(Diagnostic.Kind.NOTE, "SupportedAnnotationTypes : " + typeElement.getQualifiedName());}// 生成 public static void main(String[] args) 函数MethodSpec main = MethodSpec.methodBuilder("main").addModifiers(Modifier.PUBLIC, Modifier.STATIC).returns(void.class).addParameter(String[].class, "args").addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!").build();// 指定 public final class HelloWorld 类TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld").addModifiers(Modifier.PUBLIC, Modifier.FINAL).addMethod(main).build();// 正式在 "com.example.helloworld" 包名下创建 HelloWorld 类JavaFile javaFile = JavaFile.builder("com.example.helloworld", helloWorld).build();try {javaFile.writeTo(mFiler);} catch (IOException e) {e.printStackTrace();}return false;}
}

生成代码如下 :

package com.example.helloworld;import java.lang.String;
import java.lang.System;public final class HelloWorld {public static void main(String[] args) {System.out.println("Hello, JavaPoet!");}
}

代码生成在 " app\build\generated\ap_generated_sources\debug\out\com\example\helloworld " 路径下 ;

利用编译时技术 APT 生成的 HelloWorld 类在 Android 应用中是可以被调用的 ;

四、路由框架说明

路由框架主要是利用编译时技术 APT , 依据开发者在开发时标注的编译时注解 , 在编译的时候生成一系列 Java 代码 , 然后在运行时 , 可以调用这些 Java 代码 ;

生成的 Java 代码就是路由表数据 , 路由表中有若干路由选项 , 每个路由选项都由路由地址和路由信息组成 ,

路由地址 : 字符串地址 ;
路由信息 : Class 对象 , Activity 或 Service 的字节码类对象 ;

从路由表中 , 根据路由地址 , 获取相应的路由对象 , 可以直接跳转到对应 Activity 界面 , 或调用相应的 Service 服务 ;

下一篇博客开始开发上述路由表逻辑 ;

五、博客资源

博客源码 :

GitHub : https://github.com/han1202012/Component
CSDN 下载 : https://download.csdn.net/download/han1202012/18977569

【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 )相关推荐

android 组件化_Android 组件化路由框架设计（仿Arouter）
前言在组件化开发中一个必须要面对的问题就是组件间页面跳转,实现的方法有很多,简单的可以通过反射获取,但是比较耗费性能,也可以通过隐式跳转,但是随着页面的增多,过滤条件会随之增多,后期维护麻烦.那还有 ...
Android组件化实战五: APT的高级用法JavaPoet
Android 组件化实战一: Gradle基础语法 Android 组件化实战二: 项目部署 Android组件化实战三: 模块之间的交互 Android组件化实战四: APT的介绍与使用 Andr ...
Android组件化专题 - 组件化配置
demo地址 Android组件化专题,详细讲解组件化的使用及配置,以及实现的原理. 本文章讲解了组件化的由来及配置,下期讲解页面路由跳转及路由原理与apt 1. 组件化的由来模块化.组件化和插件化 ...
vue 如何处理两个组件异步问题_Vue异步组件处理路由组件加载状态的解决方案...
vue.js 组件组件(Component)是 Vue.js 最强大的功能之一. 组件可以扩展 HTML 元素,封装可重用的代码. 在大型单页面应用中,处于对性能的考虑和首屏加载速度的要求,我们一般 ...
Vue第二天学习总结—— Vue全家桶之组件化开发(组件化开发思想、组件注册、Vue调试工具用法、组件间数据交互传递、组件插槽、基于组件的案例——购物车)
(一) 组件化开发思想 1. 现实中的组件化思想体现组件化即是对某些可以进行复用的功能进行封装的标准化工作标准:要想组件能够成功组合在一起,每个组件必须要有标准分治:将不同的功能封装到不同的组件 ...
React - 一般组件 withRouter 的使用（让一般组件具备路由组件特有的API属性）
React - 一般组件 withRouter 的使用(让一般组件具备路由组件特有的API属性) 一. withRouter 理解二. withRouter 使用一. withRouter 理解 ...
[Android]如何做一个崩溃率少于千分之三噶应用app（22）-组件化路由跳转
大家好,我是苍王.以下是我这个系列的相关文章,有兴趣可以参考一下,可以给个喜欢或者关注我的文章. [Android]如何做一个崩溃率少于千分之三噶应用app--章节列表大家应该有看完我的第十二编简书 ...
android pod 组件化_Flutter组件化导入至iOS现有工程中（CocoaPods篇）
Flutter项目实战:方案有三纯Flutter项目,需要投入大量人力进入到Flutter编程中,且现有原生项目需要完全摒弃 Flutter项目混编,暂且不说Flutter所支持的框架,与原生交互的 ...
Android组件化之组件通信
Demo地址:https://github.com/751496032/ComponentDemo 本文是续上一篇Android组件化方案实践与思考文章一些思考,主要是针对组件间通信,比如: 每个组件 ...

【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 )