Android编译时代码生成之二(javapoet)

博客搬迁到这里 http://blog.fdawei.club,欢迎访问,大家一起学习交流。

前面通过一篇博客介绍了注解和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可以做的还不止这些,在以后的使用中可以慢慢发掘。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,652评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,079评论 25 707
  • 就算前路一个人再漫长再不可测都没关系 怕的是没那勇气 有些事 硬着头皮也就过了 无论有多少风雨 要知道还有许多和你...
    未签收阅读 149评论 0 0
  • 今天女儿上小学一年级报名,按学校要求进行一场入学测试考试。在孩子们考试的时间,等在教室外的家长们聊起来。有些...
    朣昽阅读 641评论 2 3
  • 随着越来越长大,接触的人越来越多,听到女生反对男生抽烟的声音就越来越大,大部分的理由是好臭、不健康,但是我对...
    箜莳阅读 484评论 0 0