javapoet源码初识

javapoet源码初识


1.简介

android的一些比较流行的第三方库例如butterknife dagger等都是利用javapoet在编译期间生成java代码,于是抽空写一篇关于javapoet源码的文章,随笔写写。

JavaPoet是square推出的开源java代码生成框架,提供Java Api生成.java源文件。

项目主页及源码:https://github.com/square/javapoet


2.简单的设计思路

先不钻进源码的海洋,从抽象的方向来说,假如要我们写一套这样的源码,基于面向对象的设计思想,我们需要对java源文件进行抽象,我们可以先简单的抽象出好几个类。

1).最首先的应该就是java源文件本身的类,我们叫做TypeSpec,这个类代表着类,接口,枚举

2).java源文件中还有方法,我们也可以抽象一个类,叫做MethodSpec,这个类代表中构造函数或者方法。

3).FieldSpec,这个类代表着成员变量或者字段。

4).以上几个类是我们简单的对java源文件的抽象,我们还可以定义一个类用来生成java源文件,我们叫做JavaFile

通过以上简单的设计,我们可以大致写出生成java源文件的代码:

MethodSpec methodSpec = new MethodSpec(funcName,funcReturn,funcParameter ....);

FieldSpec fieldSpec = new FieldSpec(int,name,value....);

TypeSpec helloworld = new  TypeSpec(fieldSpec,methodSpec);

JavaFile javafile = new JavaFile(helloworld);

javafile.wirteTo(out);

有了个粗糙的思路,接下来我们看看javapoet中的设计。


3.javapoet设计思路(源码初探)

1)Spec 用来描述Java中基本的元素,包括类型,注解,字段,方法和参数等。

      AnnotationSpec

     FieldSpec

     MethodSpec

     ParameterSpec

     TypeSpec

2)Name 用来描述类型的引用,包括Void,原始类型(int,long等)和Java类等。

      TypeName

      ArrayTypeName

     ClassName

     ParameterizedTypeName

     TypeVariableName

     WildcardTypeName

3)CodeBlock 用来描述代码块的内容,包括普通的赋值,if判断,循环判断等。

4)JavaFile 完整的Java文件,JavaPoet的主要的入口。

5)CodeWriter 读取JavaFile并转换成可阅读可编译的Java源文件。


4.举个栗子:

package com.example.helloworld;

   public final class HelloWorld {

   public static void main(String[] args) {

            System.out.println("Hello, World!");

          }

     }

我们要生成如上java源文件:

MethodSpec main = MethodSpec.methodBuilder("main")

                                  .addModifiers(Modifier.PUBLIC, Modifier.STATIC)

                                  .returns(void.class)

                                  .addParameter(String[].class,"args")

                                 .addStatement("$T.out.println($S)", System.class,"Hello, World!")

                                 .build();

 TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")

                                  .addModifiers(Modifier.PUBLIC, Modifier.FINAL)

                                  .addMethod(main)

                                  .build();

JavaFile javaFile = JavaFile.builder("com.example.helloworld", helloWorld)

                                  .build();

javaFile.writeTo(System.out);

乍一看跟我们第二点简单的设计思路有丢丢像,不过类中的参数太多,用了builder模式。

CodeBlock中主要有:

final List<String> formatParts;//保存字面上的值

final List<String> args;//保存替代的值

前面几步骤都是对类的初始化,下面来看看调用了JavaFile的writeTo后实际做了些什么。

JavaPoet两次生成java文件字符串,在第一次中生成字符串用于收集import的类型信息,第二次才输出字符串到文件中。

在JavaPoet中,所有java文件的抽象元素都定义了emit方法,如TypeSepc,ParameterSepc等,emit方法传入CodeWriter对象输出字符串。上层元素调用下层元素的emit方法,如JavaFile的emit方法调用TypeSpec的emit方法,从而实现整个java文件字符串的生成。

所有的java文件抽象元素的emit方法最终都会调用CodeWriter的emit方法,CodeWriter是对字符串输出的抽象。

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

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,451评论 25 707
  • JavaPoet - 优雅地生成代码 [TOC] 一、项目简介 JavaPoet是square推出的开源java代...
    everlastxgb阅读 20,947评论 1 28
  • 露珠, 因为晶莹, 所以生命以时计! 红花, 因为美丽, 所以生命以天计! 绿叶, 因为单纯, 所以生命以月计! ...
    hsl_7cbf阅读 187评论 0 3
  • 汤汤是个憨态可掬的胖子。 我有时喊他汤汤,有时喊他胖胖。他都不恼,顶多回一句:“你个坏怂,死旁边去。” 汤汤是我初...
    Mozart的向阳花阅读 1,105评论 9 15