0 前言

要實現(xiàn)一個功能，我們通常編寫一系列的java文件，如果需求發(fā)生變化，則修改這些java文件或增加一些新的java文件。為了避免為適應千變?nèi)f化的需求而頻繁修改項目代碼，可以在運行時動態(tài)生成字節(jié)碼，當然運行時生成字節(jié)碼需要占用計算資源。當然，還有一種思路是根據(jù)條件動態(tài)生成java文件，而不是根據(jù)每種情況編寫固定的代碼，這樣生成的項目與完全手工編寫的代碼沒有任何區(qū)別。JavaPoet就是一個動態(tài)生成java文件的庫，在caffine、butterknife、自動生成rpc stub文件等中間件中得到了應用。

1 基本功能介紹

我們知道，一個java類由類聲明、字段、構(gòu)造方法、方法、參數(shù)、注解等元素組成，JavaPoet為這些基本組成元素分別定義了相應的類，分別用來管理、生成相應元素相關(guān)的代碼。

JavaPoet常用的一些類：

1.1 一個簡單的例子

public class JavapoetApplication {

    public static void main(String[] args) {
        try {
            // 定義一個方法名為test的方法
            MethodSpec test = MethodSpec.methodBuilder("test")
                    // 方法的修飾符
                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                    // 方法的返回值類型
                    .returns(void.class)
                    // 方法的參數(shù)
                    .addParameter(Integer.class, "loop")
                    // 方法body內(nèi)容
                    .addCode(""
                            + "int total = 0;\n"
                            + "for (int i = 0; i < loop; i++) {\n"
                            + "  total += i;\n"
                            + "}\n"
                            + "System.out.println(\"total value: \" + total);\n")
                    .build();

            // 定義一個類，名字為TestCode
            TypeSpec testCode = TypeSpec.classBuilder("TestCode")
                    // 類修飾符
                    .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                    // 添加方法
                    .addMethod(test)
                    .build();

            // 定義一個java文件，指定package和類定義
            JavaFile javaFile = JavaFile.builder("com.javatest.javapoet", testCode)
                    .build();

            // 將java文件內(nèi)容寫入文件中
            File file = new File("./javapoet");
            javaFile.writeTo(file);
        } catch (Exception e) {
            //
        }
    }

    public static void test1() throws Exception {

    }

}

生成的java文件內(nèi)容為：

package com.javatest.javapoet;

import java.lang.Integer;

public final class TestCode {
  public static void test(Integer loop) {
    int total = 0;
    for (int i = 0; i < loop; i++) {
      total += i;
    }
    System.out.println("total value: " + total);
  }
}

1.2 改進例子

上面的自動生成代碼中，雖然類和方法聲明、修飾符、返回值類型、包名等是用編程實現(xiàn)的（編程實現(xiàn)就意味這可以參數(shù)化，通過控制參數(shù)生成不同的內(nèi)容），但是方法體的內(nèi)容與手工編寫并沒有什么區(qū)別，像語句分號、縮進、換行等都是人工編寫的，看不出自動生成代碼的優(yōu)勢。但JavaPoet提供了addStatement()，beginControlFlow()，endControlFlow()，nextControlFlow()等方法方便代碼生成。addStatement()會自動在語句后添加分號，并換行；beginControlFlow()和nextControlFlow()會自動添加{符號并換行，控制后面語句的縮進；endControlFlow()會自動添加}符號，并換行，控制后面語句的縮進。

重新編寫上面test方法的生成代碼，生成的結(jié)果代碼是一樣的：

    MethodSpec test = MethodSpec.methodBuilder("test")
            // 方法的修飾符
            .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
            // 方法的返回值類型
            .returns(void.class)
            // 方法的參數(shù)
            .addParameter(Integer.class, "loop")
            // 方法body內(nèi)容
            .addStatement("int total = 0")
            .beginControlFlow("for (int i = 0; i < loop; i++)")
            .addStatement("total += i")
            .endControlFlow()
            .addStatement("System.out.println(\"total value: \" + total)")
            .build();

1.3 進一步改進例子

現(xiàn)在生成代碼的格式控制交給javaposet管理了，但是方法體的代碼全是硬編碼的，還沒體現(xiàn)自動生成代碼的靈活性，JavaPoet提供了S、N等替換符號來實現(xiàn)這方面的需求。

進一步修改上面test方法的生成代碼，如下：

    // 定義一個方法名為test的方法
    // 定義一個參數(shù)
    ParameterSpec loopParam = ParameterSpec.builder(Integer.class, "loop")
            .addModifiers(Modifier.FINAL)
            .build();

    String total = "total";

    MethodSpec test = MethodSpec.methodBuilder("test")
            // 方法的修飾符
            .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
            // 方法的返回值類型
            .returns(void.class)
            // 方法的參數(shù)
            .addParameter(loopParam)
            // 方法body內(nèi)容
            // $L 會替換為變量total的值
            .addStatement("int $L = 0", total)
            // $N 會替換為 loopParam的名字
            .beginControlFlow("for (int i = 0; i < $N; i++)", loopParam)
            .addStatement("$L += i", total)
            .endControlFlow()
            // $T 會替換為類的名字，如果需要，會在文件頭添加相應的import語句
            // $S 會替換為變量的值，并用""包裹起來
            .addStatement("$T.out.println($S + $L)", System.class, "total value: ", total)
            .build();

1.4 替換符號功能說明

JavaPoet幾個常用替換符號的功能介紹如下：

替換符號還可以指定替換參數(shù)的位置（Relative Arguments）或參數(shù)的名字（Named Arguments）
例如：

addStatement("System.out.println(\"I ate $L $L\")", 3, "tacos")

和

# 指定參數(shù)位置
addStatement("System.out.println(\"I ate $2L $1L\")", "tacos", 3)

以及

# 指定參數(shù)名字
Map<String, Object> map = new LinkedHashMap<>();
map.put("food", "tacos");
map.put("count", 3);

addStatement("System.out.println(\"I ate $count:L $food:L\")", map)

生成的語句都是

System.out.println("I ate 3 tacos");

2 JavaPoet個組件使用說明

2.1 類型

變量、參數(shù)、返回值的類型即可以用java的class來表達，javapoet也定義了相應的類型表示系統(tǒng)，對應關(guān)系如下：

2.2 field

字段的生成比較簡單，只要指定字段的修飾符、類型、名字創(chuàng)建FieldSpec，然后添加到TypeSpec中就可以了

// 顯式創(chuàng)建FieldSpec


FieldSpec android = FieldSpec.builder(String.class, "description")
    .addModifiers(Modifier.PRIVATE, Modifier.FINAL)
    // 指定初始化值，可選
    .initializer("$S", "this is a example")
    .build();

ParameterizedTypeName type = ParameterizedTypeName.get(List.class, String.class);
FieldSpec android = FieldSpec.builder(type, "name").build();

分別生成：

private final String description = "this is a example";
List<String> name;

2.3 class

TypeSpec.classBuilder("Clazz")
    // 抽象類
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    // 泛型
    .addTypeVariable(TypeVariableName.get("T"))
    // 繼承與接口
    .superclass(String.class)
    .addSuperinterface(Serializable.class)
    .addSuperinterface(ParameterizedTypeName.get(Comparable.class, String.class))
    .addSuperinterface(ParameterizedTypeName.get(ClassName.get(Map.class), 
                                                 TypeVariableName.get("T"), 
                                                 WildcardTypeName.subtypeOf(String.class)))
    // 初始化塊
    .addStaticBlock(CodeBlock.builder().build())
    .addInitializerBlock(CodeBlock.builder().build())

    // 添加字段
    // .addField(fieldSpec)

    // 構(gòu)造方法和方法
    // .addMethod(constructorSpec)
    // .addMethod(methodSpec)

    // 內(nèi)部類
    .addType(TypeSpec.classBuilder("InnerClass").build())

    .build();

2.2 interface

通過TypeSpec的interfaceBuilder()方法創(chuàng)建interface，其他元素添加跟class差不多

TypeSpec helloWorld = TypeSpec.interfaceBuilder("TestInterface").build();

2.3 enum

通過TypeSpec的enumBuilder()方法創(chuàng)建interface, 通過addEnumConstant()添加enum成員
一個基本例子：

TypeSpec helloWorld = TypeSpec.enumBuilder("TestEnum")
    .addModifiers(Modifier.PUBLIC)
    .addEnumConstant("EXAM_0")
    .addEnumConstant("EXAM_1")
    .addEnumConstant("EXAM_2")
    .build();

生成的代碼如下：

public enum TestEnum {
  EXAM_0,
  EXAM_1,
  EXAM_2
}

一個復雜一點的例子：

TypeSpec testEnum = TypeSpec.enumBuilder("TestEnum")
    .addModifiers(Modifier.PUBLIC)
    .addEnumConstant("EXAM_0", TypeSpec.anonymousClassBuilder("$S", "exam0")
        .addMethod(MethodSpec.methodBuilder("toString")
            .addAnnotation(Override.class)
            .addModifiers(Modifier.PUBLIC)
            .addStatement("return $S", "exam0")
            .returns(String.class)
            .build())
        .build())
    .addEnumConstant("EXAM_1", TypeSpec.anonymousClassBuilder("$S", "exam1")
        .build())
    .addEnumConstant("EXAM_2", TypeSpec.anonymousClassBuilder("$S", "exam2")
        .build())
    .addField(String.class, "name", Modifier.PRIVATE, Modifier.FINAL)
    .addMethod(MethodSpec.constructorBuilder()
        .addParameter(String.class, "name")
        .addStatement("this.$N = $N", "name", "name")
        .build())
    .build();

生成如下代碼：

public enum TestEnum {
  EXAM_0("exam0") {
    @Override
    public String toString() {
      return "exam0";
    }
  },

  EXAM_1("exam1"),

  EXAM_2("exam2");

  private final String name;

  Roshambo(String name) {
    this.name = name;
  }
}

2.4 匿名內(nèi)部類

使用TypeSpec的anonymousClassBuilder()方法生成匿名內(nèi)部類，舉例如下：

TypeSpec comparator = TypeSpec.anonymousClassBuilder("")
    .addSuperinterface(ParameterizedTypeName.get(Comparator.class, String.class))
    .addMethod(MethodSpec.methodBuilder("compare")
        .addAnnotation(Override.class)
        .addModifiers(Modifier.PUBLIC)
        .addParameter(String.class, "a")
        .addParameter(String.class, "b")
        .returns(int.class)
        .addStatement("return $N.length() - $N.length()", "a", "b")
        .build())
    .build();

TypeSpec testCode = TypeSpec.classBuilder("TestCode")
    .addMethod(MethodSpec.methodBuilder("sortByLength")
        .addParameter(ParameterizedTypeName.get(List.class, String.class), "strings")
        .addStatement("$T.sort($N, $L)", Collections.class, "strings", comparator)
        .build())
    .build();

生成代碼如下：

void sortByLength(List<String> strings) {
  Collections.sort(strings, new Comparator<String>() {
    @Override
    public int compare(String a, String b) {
      return a.length() - b.length();
    }
  });
}

2.5 annotation

給方法增加基本注解：

MethodSpec toString = MethodSpec.methodBuilder("toString")
    .addAnnotation(Override.class)
    .returns(String.class)
    .addModifiers(Modifier.PUBLIC)
    .addStatement("return $S", "testCode")
    .build();

給方法增加帶參數(shù)值的注解：

MethodSpec logRecord = MethodSpec.methodBuilder("recordEvent")
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    .addAnnotation(AnnotationSpec.builder(Headers.class)
        .addMember("accept", "$S", "application/json; charset=utf-8")
        .addMember("userAgent", "$S", "Square Cash")
        .build())
    .addParameter(LogRecord.class, "logRecord")
    .returns(LogReceipt.class)
    .build();

2.6 javadoc

類和方法都可以通過TypeSpec和MethodSpec的addJavadoc()方法添加javadoc

MethodSpec dismiss = MethodSpec.methodBuilder("dismiss")
    .addJavadoc("Hides {@code message} from the caller's history. Other\n"
        + "participants in the conversation will continue to see the\n"
        + "message in their own history unless they also delete it.\n")
    .addJavadoc("\n")
    .addJavadoc("<p>Use {@link #delete($T)} to delete the entire\n"
        + "conversation for all participants.\n", Conversation.class)
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    .addParameter(Message.class, "message")
    .build();

生成的結(jié)果為：

/**
   * Hides {@code message} from the caller's history. Other
   * participants in the conversation will continue to see the
   * message in their own history unless they also delete it.
   *
   * <p>Use {@link #delete(Conversation)} to delete the entire
   * conversation for all participants.
   */
  void dismiss(Message message);

2.7 import 靜態(tài)字段或方法

ClassName hoverboard = ClassName.get("com.mattel", "Hoverboard");
ClassName namedBoards = ClassName.get("com.mattel", "Hoverboard", "Boards");

JavaFile.builder("com.example.helloworld", hello)
    .addStaticImport(hoverboard, "createNimbus")
    .addStaticImport(namedBoards, "*")
    .addStaticImport(Collections.class, "*")
    .build();

生成代碼如下：

package com.example.helloworld;

import static com.mattel.Hoverboard.Boards.*;
import static com.mattel.Hoverboard.createNimbus;
import static java.util.Collections.*;

class HelloWorld {

}