Android 编译时代码生成技术探究 二 JavaPoet生成 .java源文件的Java API

https://github.com/979451341/TestAPT

这篇说如何生成Java文件,所使用的就是JavaPoet这个API提供的代码,让我们来学习如何去使用它。

1.添加定死的代码

比如我想要生成如下代码的java文件

package com.example;

public final class TestClass {

void main() {

int total = 0;

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

total += i;

}

}

}

那生成代码如下

MethodSpec main = MethodSpec.methodBuilder("main")

.addCode(""

+ "int total = 0;\n"

+ "for (int i = 0; i < 10; i++) {\n"

+ "  total += i;\n"

+ "}\n")

.build();

TypeSpec testClass = TypeSpec.classBuilder("TestClass")

.addModifiers(Modifier.PUBLIC,Modifier.FINAL)

.addMethod(main)

.build();

JavaFile javaFile = JavaFile.builder("com.example",testClass)

.build();

通过以上代码可以看出,JavaPoet很多时候都是用的Builder模式来构建代码,这个MethodSpec是用来新建函数的,通过methodBuilder取函数名并通过addCode来添加代码,TypeSpec则是用来生成类,通过classBuilder来创建和去类名,通过addModifiers来规定类的属性,然后通过addMethod添加函数。最后是通过JavaFile来生成相应包下的java文件,指定了包名和类。

后面我会重点说MethodSpec如何用,就不贴完整代码了

2.引用自己给参数

以上代码还有另一种方法生成,addStatement() 负责分号和换行,beginControlFlow() + endControlFlow() 需要一起使用,相当于{ }

MethodSpec main = MethodSpec.methodBuilder("main")

.addStatement("int total = 0")

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

.addStatement("total += i")

.endControlFlow()

.build();

还能给生成有参数的函数

private MethodSpec computeRange(String name, int from, int to, int op) {

return MethodSpec.methodBuilder(name)

.returns(int.class)

.addStatement("int result = 0")

.beginControlFlow("for (int i = " + from + "; i < " + to + "; i++)")

.addStatement("result = result +" + op + "+ i")

.endControlFlow()

.addStatement("return result")

.build();

}

还有另一种生成有参数的函数,Literals 直接写在输出代码中,没有转义。 它的类型可以是所有基础类型。

private MethodSpec computeRange(String name, int from, int to, int op) {

return MethodSpec.methodBuilder(name)

.returns(int.class)

.addStatement("int result = 0")

.beginControlFlow("for (int i = $L; i < $L; i++)", from, to)

.addStatement("result = result + $L+ i", op)

.endControlFlow()

.addStatement("return result")

.build();

}

然后$S 表示可以一个 string

private static MethodSpec whatsMyName(String name) {

return MethodSpec.methodBuilder(name)

.returns(String.class)

.addStatement("return $S", name)

.build();

}

3.导包

通过 $T 进行映射,会自动import声明

MethodSpec today = MethodSpec.methodBuilder("today")

.returns(Date.class)

.addStatement("return new $T()", Date.class)

.build();

ClassName 可以识别任何声明类。具体看下面的例子:

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

ClassName list = ClassName.get("java.util", "List");

ClassName arrayList = ClassName.get("java.util", "ArrayList");

TypeName listOfHoverboards = ParameterizedTypeName.get(list, hoverboard);

MethodSpec beyond = MethodSpec.methodBuilder("beyond")

.returns(listOfHoverboards)

.addStatement("$T result = new $T<>()", listOfHoverboards, arrayList)

.addStatement("result.add(new $T())", hoverboard)

.addStatement("result.add(new $T())", hoverboard)

.addStatement("result.add(new $T())", hoverboard)

.addStatement("return result")

.build();

还有import static

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

import static com.mattel.Hoverboard.Boards.*;

还有生成的函数引用自己生成的函数

通过$N来引用 hexDigit()方法作为一个参数:

addStatement("result[1] = $N(1)", hexDigit)

4.构造函数

addParameter(String.class, "greeting")

public HelloWorld(String greeting)

还可以指定类型

addParameter(String.class, "robot", Modifier.FINAL)

5.成员变量Fields

FieldSpec android = FieldSpec.builder(String.class, "android")

.addModifiers(Modifier.PRIVATE, Modifier.FINAL)

.build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")

.addModifiers(Modifier.PUBLIC)

.addField(android)

.addField(String.class, "robot", Modifier.PRIVATE, Modifier.FINAL)

.build();

public class HelloWorld {

private final String android;

private final String robot;

}

6.接口

TypeSpec helloWorld = TypeSpec.interfaceBuilder("HelloWorld")

.addModifiers(Modifier.PUBLIC)

.build();

7.枚举

TypeSpec helloWorld = TypeSpec.enumBuilder("Roshambo")

.addModifiers(Modifier.PUBLIC)

.addEnumConstant("ROCK")

.addEnumConstant("SCISSORS")

.addEnumConstant("PAPER")

.build();

参考文章

http://blog.csdn.net/crazy1235/article/details/51876192

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • 背景 一年多以前我在知乎上答了有关LeetCode的问题, 分享了一些自己做题目的经验。 张土汪:刷leetcod...
    土汪阅读 12,743评论 0 33
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,605评论 18 399
  • 在踏浪100学习文案,各种虐心
    TONY先生的假期阅读 166评论 0 1
  • 且置人间无尽事,深园长桐自春风。 不可恣愁销白昼,静夜风吹花满楼。 将君还饮此美酒,白驹狩猎西山头。 偏听素湍送白...
    屈乔柯阅读 327评论 1 1