Post Views: 13

JavaPoet 是用来生成 Java 代码的一个 Java Library. 学习 JavaPoet, 唯一也是最快的方法是自己动手生成一个 Java Code 文件. 我们用一个非常简单而又全面的例子, 只要你跟着看完, 基本就没有不知道怎么生成的 Java 代码了.

gradle 引用:

compile 'com.squareup:javapoet:1.8.0'

比如, 我们想生成如下的代码, 这段代码基本涵盖了你能遇到的所有用法. 如果哪里不知道怎么生成的, 可以在下面的生成代码里找.

package com.walfud.howtojavapoet;

import java.io.IOException;

import java.io.Serializable;

import java.lang.Comparable;

import java.lang.Exception;

import java.lang.Integer;

import java.lang.Object;

import java.lang.Override;

import java.lang.Runnable;

import java.lang.RuntimeException;

import java.lang.String;

import java.util.HashMap;

import java.util.Map;

public abstract class Clazz extends String implements Serializable, Comparable, Comparable extends String> {

public static final Map mFoo = new HashMap();

static {

}

{

}

@Override

public int method(String string, T t, Map map) throws IOException,

RuntimeException {

int foo = 1;

String bar = "a string";

Object obj = new HashMap(5);

baz(new Runnable(String param) {

@Override

void run() {

}

});

for (int i = 0; i < 5; i++) {

}

while (false) {

}

do {

} while (false);

if (false) {

} else if (false) {

} else {

}

try {

} catch (Exception e) {

e.printStackTrace();

} finally {

}

return 0;

}

class InnerClass {

}

}

JavaPoet 代码:

package com.walfud.howtojavapoet;

import com.squareup.javapoet.*;

import sun.reflect.generics.scope.ClassScope;

import java.io.IOException;

import java.io.Serializable;

import java.lang.annotation.Documented;

import java.lang.reflect.ParameterizedType;

import java.lang.reflect.TypeVariable;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import javax.lang.model.element.Modifier;

/**

* http://android.walfud.com/javapoet-看这一篇就够了/

*/

public class HowToJavaPoetDemo {

public static void main(String[] args) {

TypeSpec clazz = clazz(field(), method(code()));

JavaFile file = JavaFile.builder("com.walfud.howtojavapoet", clazz).build();

System.out.println(file.toString());

}

/**

* `public abstract class Clazz extends String implements Serializable, Comparable, Comparable extends String> {

* ...

* }`

* @param fieldSpec

* @param methodSpec

* @return

*/

public static TypeSpec clazz(FieldSpec fieldSpec, MethodSpec methodSpec) {

return 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(Comparable.class), WildcardTypeName.subtypeOf(String.class)))

.addType(TypeSpec.classBuilder("InnerClass").build())

.addStaticBlock(CodeBlock.builder().build())

.addInitializerBlock(CodeBlock.builder().build())

.addField(fieldSpec)

.addMethod(methodSpec)

.build();

}

/**

* `public static final Map mFoo = new HashMap();`

*

* @return

*/

public static FieldSpec field() {

return FieldSpec.builder(ParameterizedTypeName.get(ClassName.get(Map.class), ClassName.get(String.class), TypeVariableName.get("T")), "mFoo", Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)

.initializer("new $T()", HashMap.class)

.build();

}

/**

* `@Override

* public Integer method(String string, T t, Map map) throws IOException, RuntimeException {

* ...

* }`

*

* @param codeBlock

* @return

*/

public static MethodSpec method(CodeBlock codeBlock) {

return MethodSpec.methodBuilder("method")

.addAnnotation(Override.class)

.addTypeVariable(TypeVariableName.get("T"))

.addModifiers(Modifier.PUBLIC)

.returns(int.class)

.addParameter(String.class, "string")

.addParameter(TypeVariableName.get("T"), "t")

.addParameter(ParameterizedTypeName.get(ClassName.get(Map.class), ClassName.get(Integer.class), WildcardTypeName.subtypeOf(TypeVariableName.get("T"))), "map")

.addException(IOException.class)

.addException(RuntimeException.class)

.addCode(codeBlock)

.build();

}

public static CodeBlock code() {

return CodeBlock.builder()

.addStatement("int foo = 1")

.addStatement("$T bar = $S", String.class, "a string")

// Object obj = new HashMap(5);

.addStatement("$T obj = new $T(5)", Object.class, ParameterizedTypeName.get(ClassName.get(HashMap.class), ClassName.get(Integer.class), WildcardTypeName.subtypeOf(TypeVariableName.get("T"))))

// method(new Runnable(String param) {

// @Override

// void run() {

// }

// });

.addStatement("baz($L)", TypeSpec.anonymousClassBuilder("$T param", String.class)

.superclass(Runnable.class)

.addMethod(MethodSpec.methodBuilder("run")

.addAnnotation(Override.class)

.returns(TypeName.VOID)

.build())

.build())

// for

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

.endControlFlow()

// while

.beginControlFlow("while (false)")

.endControlFlow()

// do... while

.beginControlFlow("do")

.endControlFlow("while (false)")

// if... else if... else...

.beginControlFlow("if (false)")

.nextControlFlow("else if (false)")

.nextControlFlow("else")

.endControlFlow()

// try... catch... finally

.beginControlFlow("try")

.nextControlFlow("catch ($T e)", Exception.class)

.addStatement("e.printStackTrace()")

.nextControlFlow("finally")

.endControlFlow()

.addStatement("return 0")

.build();

}

}

为了方便记忆, 我总结了一张图, 标注了关键或者稍微复杂的那些用法:

$L 是字面量替换, 比如 ("abc$L123", "FOO") => abcFOO123 . 也就是直接替换

$T 是类型替换, 一般用于 ("$T foo", List.class) => List foo . $T 的好处在于 JavaPoet 会自动帮你补全文件开头的  import .

$S 是字符串替换, 比如: ("$S.length()", "foo") => "foo".length() 注意 $S 是将参数替换为了一个带双引号的字符串

$N 是名称替换, 比如你之前定义了一个函数 MethodSpec methodSpec = MethodSpec.methodBuilder("foo").build(); 现在你可以通过 $N 获取这个函数的名称 ("$N", methodSpec) => foo .

注意: 在 Android 工程中, 是无法使用 `javax.lang.model.element.Modifier` 包的, 因为 Android 运行时没有相关的 class. 对于 Android Annotation 的正确姿势(工程结构以及用法), 请参考:Java 注解技术