前言

在前面的Android6.0权限处理不再复杂文章中，介绍过一个开源框架PermissionsDispatcher(权限调度者)框架，基于该框架的条件下，有了介绍注解以及注解APT的两篇文章，分别是：

Android进阶之Annotation(注解)的使用

Android编译时，怎么自动生成代码？

在【Android编译时，怎么自动生成代码？】这篇文章的结尾中，提到过可以使用JavaPoet来优雅的生成代码。那今天我们的主要内容就是来介绍一下【JavaPoet】该开源框架。

环境的搭建

1，新建项目名为【myJavaPoet】的Android项目；
2，在其中新建Module名为【poet】的模块，选择【Java Library】，如下：

Java Library

PS：

JavaPoet必须在Java Library中使用，例如在rt.jar包中的javax包属于Android核心库中没有，所以不能直接在app Module和Android Library中使用，必须要创建一个Java Library，然后由Java Library导出jar包使用，如下图：

rt.jar

3，在【poet.build.gradle】中，添加如下信息：

dependencies {    compile 'com.squareup:javapoet:1.8.0'}

完成后的项目目录结构如下：

项目目录结构

下面开始讲例子，希望看例子的时候，注释切记一定要多注意看~~~

例子1，PoetHello

主要讲的是类、方法的生成，在其中添加修饰、返回类型、抽象方法，以及如何写入文件系统等等。。。

PoetHello的代码如下：

package com.example;import com.squareup.javapoet.JavaFile;import com.squareup.javapoet.MethodSpec;import com.squareup.javapoet.TypeSpec;import java.io.File;import javax.lang.model.element.Modifier;/** * 使用JavaPoet写一个Hello 2017/4/24 11:01 */public class PoetHello {    /**     * 生成器 2017/4/24 14:49     */    public static void product() {        try {            // 创建方法 2017/4/24 14:26            MethodSpec method = MethodSpec.methodBuilder("hello")                    .addModifiers(Modifier.PUBLIC) // 修饰符                    .returns(String.class) // 返回类型                    .addParameter(String.class, "name", Modifier.FINAL) // 添加final参数 2017/4/25 09:03                    .addStatement("String say") // 负责分号、换行 2017/4/24 14:52                    .addStatement("say = $S + name", "Hello ")                    .addStatement("return say")                    .build();            // 抽象方法 2017/4/24 17:03            MethodSpec abstractMethod = MethodSpec.methodBuilder("abstractHello")                    .addModifiers(Modifier.ABSTRACT, Modifier.PROTECTED)                    .build();            // 创建类            TypeSpec hello = TypeSpec.classBuilder("Hello")                    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)                    .addMethod(method) // 添加方法                    .addMethod(abstractMethod)                    .build();            // 写入文件系统 2017/4/24 14:27            JavaFile javaFile = JavaFile.builder("com.example.all_product", hello)                    .build();            javaFile.writeTo(new File("poet/src/main/java")); // 指定文件路径        } catch (Exception e) {            e.printStackTrace();        }    }    public static void main(String[] args) {        PoetHello.product();    }}

生成的Hello.java类，代码如下：

package com.example.all_product;import java.lang.String;public abstract class Hello {  public String hello(String name) {    String say;    say = "Hello " + name;    return say;  }  protected abstract void abstractHello();}

例子2，PoetFor

主要讲的就是beginControlFlow() 、endControlFlow()的配合使用，提供换行符与缩进。以for循环为例子，其它使用方法类似，如if、while、switch等等。。。

其中还有$S、$T、$N、$L的使用，意思分别如下：

$S for Strings

顾名思义，$S代表的是String，将其看成是一个字符创即可。

$T for Types

这里的Type/类型，其实可以简单的理解成我们的Class类即可。

$N for Names

可以理解成引用另一个变量名即可。

$L for Literals

这个刚开始其实是比较不好理解，但场景使用多了就应该慢慢能理解了，在这里其实就可以简单的理解成【Formatter】即可。

PoetFor代码如下(切记看注释)：

package com.example;import com.squareup.javapoet.FieldSpec;import com.squareup.javapoet.JavaFile;import com.squareup.javapoet.MethodSpec;import com.squareup.javapoet.TypeSpec;import java.io.File;import javax.lang.model.element.Modifier;/** * 生成for代码 2017/4/24 14:57 */public class PoetFor {    /**     * for循环生成器 2017/4/24 14:57     */    public static void product(int from, int to) {        try {            // 创建全局字段，并初始化 2017/4/25 09:15            FieldSpec fieldSpec = FieldSpec.builder(String.class, "DESC")                    .addModifiers(Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)                    .initializer("$S", "Sum is ")                    .build();            // 生成方法 2017/4/24 15:09            MethodSpec methodSpec = MethodSpec.methodBuilder("forInteger")                    .addModifiers(Modifier.PUBLIC, Modifier.STATIC)                    .returns(void.class) // 无返回值                    .addStatement("int sum = 0")                    // beginControlFlow() + endControlFlow() 需要一起使用，提供换行符和缩进。 2017/4/24 15:09                    // $L 占位符，类似于Formatter，替换int类型 2017/4/24 15:25                    .beginControlFlow("for (int i = $L; i <= $L; i++)", from, to)                    .addStatement("sum += i")                    .endControlFlow()                    // $T 替换类名   $S 替换字符串 2017/4/24 15:31                    // 使用System会自动import使用 2017/4/24 15:34                    .addStatement("$T.out.println($N + sum)", System.class, "DESC")                    .build();            // 类生成 2017/4/24 15:10            TypeSpec typeSpec = TypeSpec.classBuilder("ForInteger")                    .addModifiers(Modifier.PUBLIC)                    .addMethod(methodSpec)                    .addField(fieldSpec)                    .build();            // 文件生成 2017/4/24 15:10            JavaFile javaFile = JavaFile.builder("com.example.all_product", typeSpec)                    .addFileComment("JavaPoet生成For循环代码 2017/4/24 15:07")                    .build();            javaFile.writeTo(new File("poet/src/main/java"));        } catch (Exception e) {            e.printStackTrace();        }    }    public static void main(String[] args) {        PoetFor.product(0, 10);    }}

生成的ForInteger.java类如下：

// JavaPoet生成For循环代码 2017/4/24 15:07package com.example.all_product;import java.lang.String;import java.lang.System;public class ForInteger {  private static final String DESC = "Sum is ";  public static void forInteger() {    int sum = 0;    for (int i = 0; i <= 10; i++) {      sum += i;    }    System.out.println(DESC + sum);  }}

例子3，PoetList

主要讲的是ClassName的硬指定，以及引用指定；然后再讲了使用ParameterizedTypeName.get(ClassName, ClassName)创建List