JavaPoet的常用类
- TypeSpec————用于生成类、接口、枚举对象的类
- MethodSpec————用于生成方法对象的类
- ParameterSpec————用于生成参数对象的类
- AnnotationSpec————用于生成注解对象的类
- FieldSpec————用于配置生成成员变量的类
- ClassName————通过包名和类名生成的对象,在JavaPoet中相当于为其指定Class
- ParameterizedTypeName————通过MainClass和IncludeClass生成包含泛型的Class
- JavaFile————控制生成的Java文件的输出的类
JavaPoet的常用方法
设置修饰关键字
addModifiers(Modifier… modifiers)
Modifier是一个枚举对象,枚举值为修饰关键字Public、Protected、Private、Static、Final等等。 所有在JavaPoet创建的对象都必须设置修饰符(包括方法、类、接口、枚举、参数、变量)。
设置注解对象
addAnnotation(AnnotationSpec annotationSpec)
addAnnotation(ClassName annotation)
addAnnotation(Class<?> annotation)
该方法即为类或方法或参数设置注解,参数即可以是AnnotationSpec,也可以是ClassName,还可以直接传递Class对象。 一般情况下,包含复杂属性的注解一般用AnnotationSpec,如果单纯添加基本注解,无其他附加属性可以直接使用ClassName或者Class即可。
设置注释
addJavadoc(CodeBlock block)
addJavadoc(String format, Object… args)
在编写类、方法、成员变量时,可以通过addJavadoc来设置注释,可以直接传入String对象,或者传入CodeBlock(代码块)。
JavaPoet生成类、接口、枚举对象
在JavaPoet中生成类、接口、枚举,必须得通过TypeSpec生成,而classBuilder、interfaceBuilder、enumBuilder便是创建其关键的方法:
创建类:
TypeSpec.classBuilder("类名“)
TypeSpec.classBuilder(ClassName className)
创建接口:
TypeSpec.interfaceBuilder(“接口名称”)
TypeSpec.interfaceBuilder(ClassName className)
创建枚举:
TypeSpec.enumBuilder(“枚举名称”)
TypeSpec.enumBuilder(ClassName className)
继承、实现接口
继承类:
.superclass(ClassName className)
实现接口
.addSuperinterface(ClassName className)
继承存在泛型的父类
当继承父类存在泛型时,需要使用ParameterizedTypeName
ParameterizedTypeName get(ClassName rawType, TypeName… typeArguments)
返回的ParameterizedTypeName对象,已经被添加泛型信息
方法
addMethod(MethodSpec methodSpec)
通过配置MethodSpec对象,使用addMethod方法将其添加进TypeSpec中。
枚举
addEnumConstan(String enumValue)
通过addEnumConstan方法添加枚举值,参数为枚举值名称。
JavaPoet生成成员变量
JavaPoet生成成员变量是通过FieldSpec的build方法生成.
builder(TypeName type, String name, Modifier… modifiers)
只要传入TypeName(Class)、name(名称)、Modifier(修饰符),就可以生成一个基本的成员变量。
成员变量一般来说由注解(Annotation)、修饰符(Modifier)、Javadoc(注释)、initializer(实例化)。
注解
addAnnotation(TypeName name)
修饰符
addModifiers(Modifier …modifier)
注释
addJavadoc(String format, Object… args)
由于上述三个方法,都在通用方法介绍过这里就不再重复介绍。
实例化
initializer(String format, Object… args)
即成员变量的实例化,例:
public Activity mActivity = new Activity;
而initializer方法中的内容就是“=”后面的内容,下面看下具体的代码实现,上面的成员变量:
ClassName activity = ClassName.get(“android.app”, “Activity”);
FieldSpec spec = FieldSpec.builder(activity, “mActivity”)
.addModifiers(Modifier.PUBLIC)
.initializer(“new $T”, activity)
.build();
JavaPoet生成方法
JavaPoet生成方法分为两种,第一种是构造方法,另一种为常规的方法。
构造方法
MethodSpec.constructorBuilder()
常规方法
MethodSpec.methodBuilder(String name)
方法的主要构成有方法参数、注解、返回值、方法体、抛出异常五种,注解可以参考通用方法addAnnotation,其他方法我们将会一一介绍:
方法参数
addParameter(ParameterSpec parameterSpec)
设置方法参数的方法通过addParameterSpec来实现,ParameterSpec的具体使用参考下一小节。
返回值
returns(TypeName returnType)
设置方法的返回值,只需传入一个TypeName对象,而TypeName是ClassName,ParameterizedTypeName的基类。
方法体
在JavaPoet中,设置方法体内容有两个方法,分别是addCode和addStatement:
addCode()
addStatement()
这两个本质上都是设置方法体内容,但是不同的是使用addStatement()方法时,你只需要专注于该段代码的内容,至于结尾的分号和换行它都会帮你做好。 而addCode()添加的方法体内容就是一段无格式的代码片,需要开发者自己添加其格式。
方法体模板
在JavaPoet中,设置方法体使用模板是比较常见的,因为addCode和addStatement方法都存在这样的一个重载:
addCode(String format, Object… args)
addStatement(String format, Object… args)
在JavaPoet中,format中存在三种特定的占位符:
$T
$T 在JavaPoet代指的是TypeName,该模板主要将Class抽象出来,用传入的TypeName指向的Class来代替。
ClassName bundle = ClassName.get(“android.os”, “Bundle”);
addStatement(“$T bundle = new $T()”,bundle)
上述添加的代码内容为:
Bundle bundle = new Bundle();
$N
$N在JavaPoet中代指的是一个名称,例如调用的方法名称,变量名称,这一类存在意思的名称
addStatement(“data.$N()”,toString)
上述代码添加的内容:
data.toString();
$S
S 在 J a v a P o e t 中就和 S t r i n g . f o r m a t 中 S在JavaPoet中就和String.format中%s一样,字符串的模板,将指定的字符串替换到 S在JavaPoet中就和String.format中S的地方
.addStatement(“super.$S(savedInstanceState)”,“onCreate”)
即将"onCreate"字符串代替到$S的位置上.
抛出异常
.addException(TypeName name)
设置方法抛出异常,可以使用addException方法,传入指定的异常的ClassName,即可为该方法设置其抛出该异常.
JavaPoet生成方法参数
JavaPoet生成有参方法时,需要填充参数,而生成参数则需要通过ParameterSpec这个类。
addParameter(ParameterSpec parameterSpec)
初始化ParameterSpec
ParameterSpec.builder(TypeName type, String name, Modifier… modifiers)
给参数设置其Class,以及参数名称,和修饰符.
通常来说参数的构成包括:参数的类型(Class)、参数的名称(name)、修饰符(modifiers)、注解(Annotation)
除了builder方法初始化类型、以及名称、修饰符之外,其余可以通过如下方法进行设置:
添加修饰符
.addModifiers(Modifier modifier)
添加注解
addAnnotation(TypeName name)
添加修饰符、注解具体使用可参考通用方法。
JavaPoet生成注解
在JavaPoet创建类、成员变量、方法参数、方法,都会用到注解。
如果使用不包含属性的注解可以直接通过
.addAnnotation(TypeName name)
直接传入TypeName或者Class进行设置。
如果使用的注解包含属性,并且不止一个时,这时候就需要生成AnnotationSpec来解决,下面简单了解下AnnotationSpec。
最后
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长,自己不成体系的自学效果低效漫长且无助。
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,不论你是刚入门Java开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门!
如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
40)]
[外链图片转存中…(img-OO5tuJmq-1715712187041)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,不论你是刚入门Java开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门!
如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!