android编译会生成class吗,Android编译时代码生成之二（javapoet）

前面通过一篇博客介绍了注解和Apt，今天介绍一个有意思的开源库javapoet。

poet意思是诗人，很形象的名称，没错，就像诗人能写出优美的诗句一样，它能够优雅的自动生成java代码。下面就来一步一步解开它神秘的面纱。

javapoet用法

按照惯例，我们先使用它写一个输出Hello World的类。看例子

FieldSpec fieldSpec = FieldSpec.builder(String.class, "helloWorld", Modifier.PRIVATE)

.initializer("\"Hello World!\"").build();

MethodSpec methodSpec = MethodSpec.methodBuilder("printHelloWorld")

.addModifiers(Modifier.PUBLIC)

.addCode("System.out.println(helloWorld)")

.build();

TypeSpec classSpec = TypeSpec.classBuilder("HelloWorld")

.addModifiers(Modifier.PUBLIC)

.addField(fieldSpec)

.addMethod(methodSpec)

.build();

JavaFile javaFile = JavaFile.builder("me.fdawei", classSpec).build();

System.out.print(javaFile.toString());

运行结果

image

可以看见，确实已经帮我们生成了需要的类。下面详细看看实现过程。

常用类

先介绍几个常用类。看名字可能大家就已经能够猜到他们是什么了。

FieldSpec 代表一个成员变量，一个字段声明。

MethodSpec 代表一个构造函数或方法声明。

TypeSpec 代表一个类，接口，或者枚举声明。

ParameterSpec 用来创建参数。

JavaFile包含一个顶级类的Java文件。

AnnotationSpec 用来创建注解。

TypeName 类型名，如在添加返回值类型是使用 TypeName.VOID

ClassName 用来包装一个类，提供类名。

添加修饰关键字

Modifier是用来设置一些修饰关键字的，如，public、final、static等等，看其取值就一目了然。FieldSpec、MethodSpec、TypeSpec中都可以使用。

生成成员变量

FieldSpec fieldSpec = FieldSpec.builder(String.class, "helloWorld", Modifier.PRIVATE)

.initializer("\"Hello World!\"").build();

使用initializer方法，可以在定义成员变量时对其添加初始化代码。这里添加了一个String类型的成员变量helloWorld，并将它初始化为字符串 “Hellow World!”。

生成成员方法

MethodSpec methodSpec = MethodSpec.methodBuilder("printHelloWorld")

.addModifiers(Modifier.PUBLIC)

.addCode("System.out.println(helloWorld)")

.build();

生成Public类型的方法printHelloWorld，实现输出helloWorld变量的值。

addCode方法的使用比较简单。javapoet中，除了使用addCode以字符串拼凑的方式添加代码执行逻辑，javapoet还提供了更加优雅的方式。

MethodSpec methodSpec = MethodSpec.methodBuilder("printHelloWorld")

.addModifiers(Modifier.PUBLIC)

.addStatement("System.out.println(helloWorld)")

.build();

addStatement添加一行执行代码，并自动在末尾添加“;”和换行。如果是for、while、if这样的控制结构，可以使用beginControlFlow和endControlFlow来实现

MethodSpec methodSpec = MethodSpec.methodBuilder("printHelloWorld")

.addModifiers(Modifier.PUBLIC)

.beginControlFlow("for(int i = 0; i < 5; i++)")

.addStatement("System.out.println(helloWorld)")

.endControlFlow()

.build();

很明显，这里使用for循环输出五次"Hello World!"。

生成类

TypeSpec classSpec = TypeSpec.classBuilder("HelloWorld")

.addModifiers(Modifier.PUBLIC)

.addField(fieldSpec)

.addMethod(methodSpec)

.build();

生成名为 HelloWorld 的类，并添加了一个成员变量和一个方法。

TypeSpec创建类时，如果需要生成实现了接口或继承其他类的类怎么办？TypeSpec提供addSuperinterface方法和superclass方法供使用。

生成Java源文件

JavaFile javaFile =

JavaFile.builder("me.fdawei", classSpec).build();

builder方法的第一个参数制定了源文件的包名，第二个参数就是需要生成的类的信息。

占位符

使用FieldSpec生成成员变量时，可以通过initializer方法为其设置初始化代码，例子中就使用字符串“Hello World!”来初始化String类型的成员变量helloWorld。这样问题就来了，如果使用字符串拼接的话，字符串中需要包含引号，这样就非常难处理了，需要进行转义。就是这样的写法

FieldSpec fieldSpec = FieldSpec.builder(String.class, "helloWorld", Modifier.PRIVATE)

.initializer("\"Hello World!\"").build();

这样话显得很麻烦，如果字符串复杂的话，很容易出错。这就要用到占位符了。这里可以使用$S来进行占位。

FieldSpec fieldSpec = FieldSpec.builder(String.class, "helloWorld", Modifier.PRIVATE)

.initializer("$S", "Hello World!").build();

$S用来给一个字符串占位。除了$S之外，javapoet中还有三个占位符，分别是：

$L 用来给一个数字占位

$T 用来给一个类，接口，或者枚举占位

$N 用来给我们自己生成的方法名或者变量名等占位

有了占位符，生成成员方法时我们也可以这样写

MethodSpec methodSpec = MethodSpec.methodBuilder("printHelloWorld")

.addModifiers(Modifier.PUBLIC)

.addCode("$T.out.println(helloWorld);\n", System.class)

.build();

比较运行结果

image

看到不同了没有，对，就是多了import java.lang.System。说明单纯的字符串，javapoet只会原样添加到代码中，使用了占位符$T，则会被视为一种类型，会自动导入对应的包。

如果你想静态导入，当然也是可以的，使用addStaticImport方法即可。

JavaFile javaFile = JavaFile.builder("me.fdawei", classSpec)

.addStaticImport(Modifier.class, "*").build();

image

除了最基本的这些方法来组装代码外，javapoet还提供很多其他的添加不同元素的方法

TypeSpec.enumBuilder() 生成枚举类型

TypeSpec.interfaceBuilder() 生成接口

MethodSpec.addJavadoc() 给方法添加注释

MethodSpec.constructorBuilder() 创建构造方法

MethodSpec.addAnnotation() 添加注解

其实javapoet可以做的还不止这些，在以后的使用中可以慢慢发掘。