如何正確的使用JavaPoet

如何正確的使用JavaPoet？相信很多沒(méi)有經(jīng)驗(yàn)的人對(duì)此束手無(wú)策，為此本文總結(jié)了問(wèn)題出現(xiàn)的原因和解決方法，通過(guò)這篇文章希望你能解決這個(gè)問(wèn)題。

JavaPoet的基本介紹

（1）JavaPoet是一款可以自動(dòng)生成Java文件的第三方依賴

（2）簡(jiǎn)潔易懂的API，上手快

（3）讓繁雜、重復(fù)的Java文件，自動(dòng)化生成，提高工作效率，簡(jiǎn)化流程

JavaPoet的小試牛刀

為了展示JavaPoet的能力，這里以自動(dòng)生成一個(gè)全新的MainActivity為例。

public class MainActivity extends Activity{

  @Override
  protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
  }
}

我在使用JavaPoet的時(shí)候，習(xí)慣從外向內(nèi)逐一生成，但是這不是標(biāo)準(zhǔn),這里可以按照自己的方式來(lái)理解和生成.

public static void main(String[] args) {
    ClassName activity = ClassName.get("android.app", "Activity");

    TypeSpec.Builder mainActivityBuilder = TypeSpec.classBuilder("MainActivity")
        .addModifiers(Modifier.PUBLIC)
        .superclass(activity);

    ClassName override = ClassName.get("java.lang", "Override");

    ClassName bundle = ClassName.get("android.os", "Bundle");

    ClassName nullable = ClassName.get("android.support.annotation", "Nullable");

    ParameterSpec savedInstanceState = ParameterSpec.builder(bundle, "savedInstanceState")
        .addAnnotation(nullable)
        .build();

    MethodSpec onCreate = MethodSpec.methodBuilder("onCreate")
        .addAnnotation(override)
        .addModifiers(Modifier.PROTECTED)
        .addParameter(savedInstanceState)
        .addStatement("super.onCreate(savedInstanceState)")
        .addStatement("setContentView(R.layout.activity_main)")
        .build();

    TypeSpec mainActivity = mainActivityBuilder.addMethod(onCreate)
        .build();

    JavaFile file = JavaFile.builder("com.test", mainActivity).build();

    try {
      file.writeTo(System.out);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

通過(guò)在Main方法中運(yùn)行以上的代碼，就可以直接生成出MainActivity對(duì)象，自上而下的觀察上述代碼,你會(huì)發(fā)現(xiàn)JavaPoet讓java文件變得有邏輯性。

JavaPoet的常用類

•  TypeSpec————用于生成類、接口、枚舉對(duì)象的類

• MethodSpec————用于生成方法對(duì)象的類

• ParameterSpec————用于生成參數(shù)對(duì)象的類

• AnnotationSpec————用于生成注解對(duì)象的類

• FieldSpec————用于配置生成成員變量的類

• ClassName————通過(guò)包名和類名生成的對(duì)象，在JavaPoet中相當(dāng)于為其指定Class

• ParameterizedTypeName————通過(guò)MainClass和IncludeClass生成包含泛型的Class

• JavaFile————控制生成的Java文件的輸出的類

 JavaPoet的常用方法

設(shè)置修飾關(guān)鍵字

addModifiers(Modifier... modifiers)

Modifier是一個(gè)枚舉對(duì)象，枚舉值為修飾關(guān)鍵字Public、Protected、Private、Static、Final等等。

所有在JavaPoet創(chuàng)建的對(duì)象都必須設(shè)置修飾符(包括方法、類、接口、枚舉、參數(shù)、變量)。

設(shè)置注解對(duì)象

addAnnotation（AnnotationSpec annotationSpec）
addAnnotation（ClassName annotation）
addAnnotation(Class<?> annotation)

該方法即為類或方法或參數(shù)設(shè)置注解，參數(shù)即可以是AnnotationSpec，也可以是ClassName，還可以直接傳遞Class對(duì)象。

一般情況下，包含復(fù)雜屬性的注解一般用AnnotationSpec，如果單純添加基本注解，無(wú)其他附加屬性可以直接使用ClassName或者Class即可。

設(shè)置注釋

addJavadoc（CodeBlock block）
addJavadoc(String format, Object... args)

在編寫(xiě)類、方法、成員變量時(shí)，可以通過(guò)addJavadoc來(lái)設(shè)置注釋，可以直接傳入String對(duì)象，或者傳入CodeBlock（代碼塊）。

JavaPoet生成類、接口、枚舉對(duì)象

在JavaPoet中生成類、接口、枚舉，必須得通過(guò)TypeSpec生成，而classBuilder、interfaceBuilder、enumBuilder便是創(chuàng)建其關(guān)鍵的方法：

創(chuàng)建類：
TypeSpec.classBuilder("類名“) 
TypeSpec.classBuilder(ClassName className)

創(chuàng)建接口：
TypeSpec.interfaceBuilder("接口名稱")
TypeSpec.interfaceBuilder(ClassName className)

創(chuàng)建枚舉：
TypeSpec.enumBuilder("枚舉名稱")
TypeSpec.enumBuilder(ClassName className)

繼承、實(shí)現(xiàn)接口

繼承類：
.superclass(ClassName className)

實(shí)現(xiàn)接口
.addSuperinterface(ClassName className)

繼承存在泛型的父類

當(dāng)繼承父類存在泛型時(shí)，需要使用ParameterizedTypeName

ParameterizedTypeName get(ClassName rawType, TypeName... typeArguments)

返回的ParameterizedTypeName對(duì)象，已經(jīng)被添加泛型信息

方法

addMethod(MethodSpec methodSpec)

通過(guò)配置MethodSpec對(duì)象，使用addMethod方法將其添加進(jìn)TypeSpec中。

枚舉

addEnumConstan(String enumValue)

通過(guò)addEnumConstan方法添加枚舉值，參數(shù)為枚舉值名稱。

JavaPoet生成成員變量

JavaPoet生成成員變量是通過(guò)FieldSpec的build方法生成.

builder(TypeName type, String name, Modifier... modifiers)

只要傳入TypeName(Class)、name（名稱）、Modifier（修飾符），就可以生成一個(gè)基本的成員變量。

成員變量一般來(lái)說(shuō)由注解（Annotation）、修飾符（Modifier）、Javadoc(注釋)、initializer(實(shí)例化)。

注解

addAnnotation(TypeName name)

修飾符

addModifiers(Modifier ...modifier)

注釋

addJavadoc(String format, Object... args)

由于上述三個(gè)方法，都在通用方法介紹過(guò)這里就不再重復(fù)介紹。

實(shí)例化

initializer(String format, Object... args)

即成員變量的實(shí)例化，例：

public Activity mActivity = new Activity;

而 initializer方法中的內(nèi)容就是“=”后面的內(nèi)容 ，下面看下具體的代碼實(shí)現(xiàn)，上面的成員變量：

ClassName activity = ClassName.get("android.app", "Activity");
 FieldSpec spec = FieldSpec.builder(activity, "mActivity")
        .addModifiers(Modifier.PUBLIC)
        .initializer("new $T", activity)
        .build();

JavaPoet生成方法

JavaPoet生成方法分為兩種，第一種是構(gòu)造方法，另一種為常規(guī)的方法。

構(gòu)造方法

MethodSpec.constructorBuilder()

常規(guī)方法

MethodSpec.methodBuilder(String name)

方法的主要構(gòu)成有方法參數(shù)、注解、返回值、方法體、拋出異常五種，注解可以參考通用方法addAnnotation，其他方法我們將會(huì)一一介紹：

方法參數(shù)

addParameter(ParameterSpec parameterSpec)

設(shè)置方法參數(shù)的方法通過(guò)addParameterSpec來(lái)實(shí)現(xiàn)，ParameterSpec的具體使用參考下一小節(jié)。

返回值

returns(TypeName returnType)

設(shè)置方法的返回值，只需傳入一個(gè)TypeName對(duì)象，而TypeName是ClassName，ParameterizedTypeName的基類。

方法體

在JavaPoet中，設(shè)置方法體內(nèi)容有兩個(gè)方法，分別是addCode和addStatement：

addCode()
addStatement()

這兩個(gè)本質(zhì)上都是設(shè)置方法體內(nèi)容，但是不同的是使用addStatement()方法時(shí)，你只需要專注于該段代碼的內(nèi)容，至于結(jié)尾的分號(hào)和換行它都會(huì)幫你做好。

而addCode（）添加的方法體內(nèi)容就是一段無(wú)格式的代碼片，需要開(kāi)發(fā)者自己添加其格式。

方法體模板

在JavaPoet中，設(shè)置方法體使用模板是比較常見(jiàn)的，因?yàn)閍ddCode和addStatement方法都存在這樣的一個(gè)重載:

addCode(String format, Object... args)

addStatement(String format, Object... args)

在JavaPoet中，format中存在三種特定的占位符：

$T

$T 在JavaPoet代指的是TypeName，該模板主要將Class抽象出來(lái)，用傳入的TypeName指向的Class來(lái)代替。

ClassName bundle = ClassName.get("android.os", "Bundle");
addStatement("$T bundle = new $T()",bundle)

上述添加的代碼內(nèi)容為：

Bundle bundle = new Bundle();

$N

$N在JavaPoet中代指的是一個(gè)名稱，例如調(diào)用的方法名稱，變量名稱，這一類存在意思的名稱

addStatement("data.$N()",toString)

上述代碼添加的內(nèi)容：

data.toString();

$S

$S在JavaPoet中就和String.format中%s一樣,字符串的模板,將指定的字符串替換到$S的地方

.addStatement("super.$S(savedInstanceState)","onCreate")

即將"onCreate"字符串代替到$S的位置上.

拋出異常

.addException(TypeName name)

設(shè)置方法拋出異常,可以使用addException方法,傳入指定的異常的ClassName,即可為該方法設(shè)置其拋出該異常.

JavaPoet生成方法參數(shù)

JavaPoet生成有參方法時(shí),需要填充參數(shù),而生成參數(shù)則需要通過(guò)ParameterSpec這個(gè)類。

addParameter(ParameterSpec parameterSpec)

初始化ParameterSpec

ParameterSpec.builder(TypeName type, String name, Modifier... modifiers)

給參數(shù)設(shè)置其Class,以及參數(shù)名稱,和修飾符.

通常來(lái)說(shuō)參數(shù)的構(gòu)成包括:參數(shù)的類型(Class)、參數(shù)的名稱（name）、修飾符（modifiers）、注解（Annotation）

除了builder方法初始化類型、以及名稱、修飾符之外，其余可以通過(guò)如下方法進(jìn)行設(shè)置：

添加修飾符

.addModifiers(Modifier modifier)

添加注解

addAnnotation(TypeName name)

添加修飾符、注解具體使用可參考通用方法。

JavaPoet生成注解

在JavaPoet創(chuàng)建類、成員變量、方法參數(shù)、方法，都會(huì)用到注解。

如果使用不包含屬性的注解可以直接通過(guò)

  .addAnnotation(TypeName name)

直接傳入TypeName或者Class進(jìn)行設(shè)置。

如果使用的注解包含屬性，并且不止一個(gè)時(shí)，這時(shí)候就需要生成AnnotationSpec來(lái)解決，下面簡(jiǎn)單了解下AnnotationSpec。

初始化AnnotationSpec

AnnotationSpec.builder(ClassName type)

可以發(fā)現(xiàn)初始化，只需傳入ClassName或者Class即可。

設(shè)置屬性

addMember(String name, String format, Object... args)

使用addMember可以設(shè)置注解的屬性值，name對(duì)應(yīng)的就是屬性名稱，format的內(nèi)容即屬性體，同樣方法體的格式化在這里也是適用的。

JavaPoet如何生成代碼

如果上述內(nèi)容你已經(jīng)看完，那么恭喜你，你已經(jīng)明白JavaPoet的意圖，但是現(xiàn)在的你，還差最后一步，即如何生成代碼。

JavaPoet中負(fù)責(zé)生成的類是JavaFile

JavaFile.builder(String packageName, TypeSpec typeSpec)

JavaFile通過(guò)向build方法傳入PackageName（Java文件的包名）、TypeSpec（生成的內(nèi)容）生成。

打印結(jié)果

javaFile.writeTo(System.out)

生成的內(nèi)容會(huì)輸出到控制臺(tái)中

生成文件

javaFile.writeTo（File file）

生成的內(nèi)容會(huì)以java文件的方式，存放到你傳入File文件的位置

結(jié)束語(yǔ)

當(dāng)你讀完了本文，如果你產(chǎn)生下面的想法：

• JavaPoet原來(lái)還可以這樣

•  JavaPoet編寫(xiě)過(guò)程為什么那么流暢，原來(lái)Java文件也可以用編程的方式生成

• JavaPoet可不可以改進(jìn)我的編碼流程，提升效率

那么說(shuō)明你已經(jīng)對(duì)JavaPoet感興趣了，可以自己動(dòng)手嘗試一下，感受下JavaPoet的魅力。

最后貼一張,JavaPoet秘籍,有了它會(huì)很好的幫助你使用JavaPoet.

看完上述內(nèi)容，你們掌握如何正確的使用JavaPoet的方法了嗎？如果還想學(xué)到更多技能或想了解更多相關(guān)內(nèi)容，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！