深入Dagger:JavaPoet的使用

前言

最近在用Dagger开发应用，Dagger是google在square的基础上去反射的依赖注入框架。

Dagger会根据定义的注解在编译阶段根据依赖注入的配置生成相应的代码，来减少运行期间反射的开销。

Dagger依赖了JavaPoet和JavaFormat来辅助实现生成代码，这里主要介绍下JavaPoet的内容和使用。

JavaPoet

JavaPoet这样定义自己的项目。

Use beautiful Java code to generate beautiful Java code

所以JavaPoet定义了一系列类来尽可能优雅的描述java源文件的结构。观察JavaPoet的代码主要的类可以分为以下几种：

• Spec 用来描述Java中基本的元素，包括类型，注解，字段，方法和参数等。
  • AnnotationSpec
  • FieldSpec
  • MethodSpec
  • ParameterSpec
  • TypeSpec
• Name 用来描述类型的引用，包括Void，原始类型（int，long等）和Java类等。
  • TypeName
  • ArrayTypeName
  • ClassName
  • ParameterizedTypeName
  • TypeVariableName
  • WildcardTypeName
• CodeBlock 用来描述代码块的内容，包括普通的赋值，if判断，循环判断等。
• JavaFile 完整的Java文件，JavaPoet的主要的入口。
• CodeWriter 读取JavaFile并转换成可阅读可编译的Java源文件。

示例

下面通过一个例子来完整的实现一个Java类的定义。

通过下面的maven依赖可以引用JavaPoet包。

    <dependency>
        <groupId>com.squareup</groupId>
        <artifactId>javapoet</artifactId>
        <version>1.7.0</version>
    </dependency>

完整的代码放在Github。这里介绍一下主要的方法。

1. AnnotationSpec 添加MyAnnotation的注解，然后设置属性hello=world。

    private static AnnotationSpec makeAnnotationSpec() {
        AnnotationSpec.Builder builder = AnnotationSpec.builder(ClassName.get("org.wcong.test.poet", "MyAnnotation"));
        CodeBlock.Builder codeBlockBuilder = CodeBlock.builder().add("$S", "world");
        builder.addMember("hello", codeBlockBuilder.build());
        return builder.build();
    }

1. FieldSpec 创建hello的字段并初始化为“world”。

    private static FieldSpec makeFieldSpec() {
		FieldSpec.Builder fileSpecBuilder = FieldSpec.builder(String.class, "hello", Modifier.PRIVATE);
		fileSpecBuilder.initializer(CodeBlock.of("\"world\""));
		return fileSpecBuilder.build();
	}

1. MethodSpec 创建getHello,setHello,toString方法。
   
   toString使用了ControlFlow判断了hello不等于null，返回"hello world"，等于null的时候返回空。

    private static MethodSpec makeToStringMethod() {
		MethodSpec.Builder toStringBuilder = MethodSpec.methodBuilder("toString");
		toStringBuilder.addModifiers(Modifier.PUBLIC);
		toStringBuilder.returns(TypeName.get(String.class));
		CodeBlock.Builder toStringCodeBuilder = CodeBlock.builder();
        toStringCodeBuilder.beginControlFlow("if( hello != null )");
        toStringCodeBuilder.add(CodeBlock.of("return \"hello \"+hello;\n"));
        toStringCodeBuilder.nextControlFlow("else");
        toStringCodeBuilder.add(CodeBlock.of("return \"\";\n"));
		toStringCodeBuilder.endControlFlow();
		toStringBuilder.addCode(toStringCodeBuilder.build());
		return toStringBuilder.build();
	}
    private static MethodSpec makeSetMethod() {
		MethodSpec.Builder setMethodSpecBuilder = MethodSpec.methodBuilder("setHello");
		setMethodSpecBuilder.addModifiers(Modifier.PUBLIC);
		setMethodSpecBuilder.returns(TypeName.VOID);
		ParameterSpec.Builder parameterBuilder = ParameterSpec.builder(TypeName.get(String.class), "hello");
		setMethodSpecBuilder.addParameter(parameterBuilder.build());
		setMethodSpecBuilder.addCode(CodeBlock.builder().add("this.hello = hello;\n").build());
		return setMethodSpecBuilder.build();
	}
	private static MethodSpec makeGetMethod() {
		MethodSpec.Builder getMethodSpecBuilder = MethodSpec.methodBuilder("getHello");
		getMethodSpecBuilder.addModifiers(Modifier.PUBLIC);
		getMethodSpecBuilder.returns(TypeName.get(String.class));
		getMethodSpecBuilder.addCode(CodeBlock.builder().add("return hello;\n").build());
		return getMethodSpecBuilder.build();
	}

1. JavaFile JavaPoet的主入口，用来描述Java源文件。

    public static void main(String[] args) {
		TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder("JavaFile");
		typeSpecBuilder.addAnnotation(makeAnnotationSpec());
		typeSpecBuilder.addField(makeFieldSpec());
		typeSpecBuilder.addMethods(makeMethodSpec());
		JavaFile.Builder javaFileBuilder = JavaFile.builder("org.wcong.test.poet", typeSpecBuilder.build());
		System.out.println(javaFileBuilder.build().toString());
	}

运行后输出下面的信息，就是一个完整的类文件了

package org.wcong.test.poet;

import java.lang.String;

@MyAnnotation(
    hello = "world"
)
class JavaFile {
  private String hello = "world";

  public String getHello() {
    return hello;
  }

  public void setHello(String hello) {
    this.hello = hello;
  }

  public String toString() {
    if( hello != null ) {
      return "hello "+hello;
    } else {
      return "";
    }
  }
}

结语

dagger使用JavaPoet来保存自动生成的类的信息，并通过JavaFormat来格式化生成的Java源文件。后面会介绍关于JavaFormat的内容。