关于java:Java中的屠龙之术二如何方便快捷地生成class文件

​

 在之前的“Java 中的屠龙之术：如何批改语法树”中，咱们具体介绍了如何应用 Javac 源码提供的工具类来批改语法树。

而在此基础上，有一款开源工具 javapoet 能够更加快捷地生成字节码，实现原理其实也就是对 JavaAPT 的封装，然而 Javapoet 有一个局限性，就是只能生成新的.class 文件，却无奈批改原有的类，这也是它的一大局限性所在。接下来就让咱们看看它的应用办法把。

0x00 概述

注解系列

• 注解根底
• JavaPoet
• 编译期注解解决之 APT

上一篇限于篇幅只介绍了 APT，这篇来持续介绍 javapoet，是 square 公司的开源库。正如其名，java 诗人，通过注解来生成 java 源文件，通常要应用 javapoet 这个库与 Filer 配合应用。次要和注解配合用来干掉那些反复的模板代码(如 butterknife 和 databinding 所做的事件)，当然你也能够应用这个技术让你的代码更加的炫酷。

0x01 简略应用

应用之前要先引入这个库

compile 'com.squareup:javapoet:1.7.0'
复制代码

javapoet 是用来生成代码的，须要借助

罕用类

应用 javapoet 前须要理解 8 个罕用类

除此之外 JavaPoet 提供了一套自定义的字符串格式化规定，罕用的有

0x02 应用进阶

上面由浅入深，循序渐进的阐明用法

办法 & 控制流：

• 增加办法 addcode 和 addstatement 对与无需类引入的极简代码能够间接应用addCode

MethodSpec main = MethodSpec.methodBuilder("main")
    .addCode(""+"int total = 0;\n"+"for (int i = 0; i < 10; i++) {\n"+"  total += i;\n"+"}\n")
    .build();
复制代码

生成的是

void main() {
  int total = 0;
  for (int i = 0; i < 10; i++) {total += i;}
}
复制代码

要是须要 import 的办法，如下面的 .addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!") 就须要应用.addStatement 来申明

• 更优雅的流控制

beginControlFlow 流开启 addStatement 解决语句 endControlFlow()流完结

如下面的用流改写就是

MethodSpec main = MethodSpec.methodBuilder("main")
    .addStatement("int total = 0")
    .beginControlFlow("for (int i = 0; i < 10; i++)")
    .addStatement("total += i")
    .endControlFlow()
    .build();
复制代码

占位符

javapoet 外面提供了占位符来帮忙咱们更好地生成代码

• $L 字面常量（Literals）

private MethodSpec computeRange(String name, int from, int to, String op) {return MethodSpec.methodBuilder(name)
      .returns(int.class)
      .addStatement("int result = 0")
      .beginControlFlow("for (int i = $L; i < $L; i++)", from, to)
      .addStatement("result = result $L i", op)
      .endControlFlow()
      .addStatement("return result")
      .build();}
复制代码

这个就是一个 for 循环，op 负责加减乘除等符号

• $S 字符串常量（String）
• $T 类型(Types)

最大的特点是主动导入包

MethodSpec today = MethodSpec.methodBuilder("today")
    .returns(Date.class)
    .addStatement("return new $T()", Date.class)
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
    .addMethod(today)
    .build();

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

javaFile.writeTo(System.out);

复制代码

生成的代码如下，而且会主动导包

package com.example.helloworld;

import java.util.Date;

public final class HelloWorld {Date today() {return new Date();
  }
}
复制代码

• $N 命名(Names), 通常指咱们本人生成的办法名或者变量名等等

比方这样的代码块

public String byteToHex(int b) {char[] result = new char[2];
  result[0] = hexDigit((b >>> 4) & 0xf);
  result[1] = hexDigit(b & 0xf);
  return new String(result);
}

public char hexDigit(int i) {return (char) (i < 10 ? i + '0' : i - 10 + 'a');
}
复制代码

咱们能够传递 hexDigit() 来代替。

MethodSpec hexDigit = MethodSpec.methodBuilder("hexDigit")
    .addParameter(int.class, "i")
    .returns(char.class)
    .addStatement("return (char) (i < 10 ? i +'0': i - 10 +'a')")
    .build();

MethodSpec byteToHex = MethodSpec.methodBuilder("byteToHex")
    .addParameter(int.class, "b")
    .returns(String.class)
    .addStatement("char[] result = new char[2]")
    .addStatement("result[0] = $N((b >>> 4) & 0xf)", hexDigit)
    .addStatement("result[1] = $N(b & 0xf)", hexDigit)
    .addStatement("return new String(result)")
    .build();
复制代码

获取对应类

有两种形式:

• ClassName.bestGuess(“类全名称”) 返回 ClassName 对象，这里的类全名称示意的类必须要存在，会主动导入相应的包

• ClassName.get(“包名”，”类名”) 返回 ClassName 对象，不查看该类是否存在

  因而如果应用 JavaPoet 的话后续代码重构扭转类名往往须要分外留神一点

ClassName hoverboard = ClassName.get("com.mattel", "Hoverboard");
ClassName list = ClassName.get("java.util", "List");
ClassName arrayList = ClassName.get("java.util", "ArrayList");
TypeName listOfHoverboards = ParameterizedTypeName.get(list, hoverboard);

MethodSpec beyond = MethodSpec.methodBuilder("beyond")
    .returns(listOfHoverboards)
    .addStatement("$T result = new $T<>()", listOfHoverboards, arrayList)
    .addStatement("result.add(new $T())", hoverboard)
    .addStatement("result.add(new $T())", hoverboard)
    .addStatement("result.add(new $T())", hoverboard)
    .addStatement("return result")
    .build();
复制代码

而后生成

package com.example.helloworld;

import com.mattel.Hoverboard;
import java.util.ArrayList;
import java.util.List;

public final class HelloWorld {List<Hoverboard> beyond() {List<Hoverboard> result = new ArrayList<>();
    result.add(new Hoverboard());
    result.add(new Hoverboard());
    result.add(new Hoverboard());
    return result;
  }
}
复制代码

构建类的元素

• 办法

办法的润饰，如Modifiers.ABSTRACT

MethodSpec flux = MethodSpec.methodBuilder("flux")
    .addModifiers(Modifier.ABSTRACT, Modifier.PROTECTED)
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    .addMethod(flux)
    .build();
复制代码

这将会生成如下代码

public abstract class HelloWorld {protected abstract void flux();
}

复制代码

当然 Methods 须要和 MethodSpec.Builder 配置来减少办法参数、异样、javadoc、注解等。

• 结构器

这个其实也是个函数办法而已，因而能够应用 MethodSpec 来生成结构器办法。比方：

MethodSpec flux = MethodSpec.constructorBuilder()
    .addModifiers(Modifier.PUBLIC)
    .addParameter(String.class, "greeting")
    .addStatement("this.$N = $N", "greeting", "greeting")
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addModifiers(Modifier.PUBLIC)
    .addField(String.class, "greeting", Modifier.PRIVATE, Modifier.FINAL)
    .addMethod(flux)
    .build();
复制代码

将会生成

public class HelloWorld {
  private final String greeting;

  public HelloWorld(String greeting) {this.greeting = greeting;}
}
复制代码

• 参数(重要)

之前咱们是通过 addstatement 间接设置参数，其实参数也有本人的一个专用类 ParameterSpec，咱们能够应用ParameterSpec.builder() 来生成参数，而后 MethodSpec 的 addParameter 去应用，这样更加优雅。

ParameterSpec android = ParameterSpec.builder(String.class, "android")
    .addModifiers(Modifier.FINAL)
    .build();

MethodSpec welcomeOverlords = MethodSpec.methodBuilder("welcomeOverlords")
    .addParameter(android)
    .addParameter(String.class, "robot", Modifier.FINAL)
    .build();
复制代码

生成的代码

void welcomeOverlords(final String android, final String robot) {
}
复制代码

略微简单点的类型 比方泛型、Map 之类的，须要理解下 JavaPoet 定义的几种专门形容类型的类

​

常见的有

/*
 *Build input type, format as :
 *Map<String, Class<? extends IRouteGroup>>
 */
    ParameterizedTypeName inputMapTypeOfRoot = ParameterizedTypeName.get(ClassName.get(Map.class),
            ClassName.get(String.class),
            ParameterizedTypeName.get(ClassName.get(Class.class),
                    WildcardTypeName.subtypeOf(ClassName.get(type_IRouteGroup))
            )
    );

    /*
     *Map<String, RouteMeta>
     */
    ParameterizedTypeName inputMapTypeOfGroup = ParameterizedTypeName.get(ClassName.get(Map.class),
            ClassName.get(String.class),
            ClassName.get(RouteMeta.class)
    );        

    /*
     *Build input param name.
     */
    ParameterSpec rootParamSpec = ParameterSpec.builder(inputMapTypeOfRoot, "routes").build();
    ParameterSpec groupParamSpec = ParameterSpec.builder(inputMapTypeOfGroup, "atlas").build();
复制代码

生成参数类型

public class ARouter$Root$app implements IRouteRoot {
  @Override
  public void loadInto(Map<String, Class<? extends IRouteGroup>> routes) {routes.put("service", ARouter$Group$service.class);
    routes.put("test", ARouter$Group$test.class);
  }
}

public class ARouter$Group$service implements IRouteGroup {
  @Override
  public void loadInto(Map<String, RouteMeta> atlas) {atlas.put("/service/hello", RouteMeta.build(RouteType.PROVIDER, HelloServiceImpl.class, "/service/hello", "service", null, -1, -2147483648));
    atlas.put("/service/json", RouteMeta.build(RouteType.PROVIDER, JsonServiceImpl.class, "/service/json", "service", null, -1, -2147483648));
    atlas.put("/service/single", RouteMeta.build(RouteType.PROVIDER, SingleService.class, "/service/single", "service", null, -1, -2147483648));
  }
}

复制代码

• 字段

能够应用 FieldSpec 去申明字段，而后加到 Method 中解决

FieldSpec android = FieldSpec.builder(String.class, "android")
    .addModifiers(Modifier.PRIVATE, Modifier.FINAL)
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addModifiers(Modifier.PUBLIC)
    .addField(android)
    .addField(String.class, "robot", Modifier.PRIVATE, Modifier.FINAL)
    .build();
复制代码

而后生成代码

public class HelloWorld {
  private final String android;

  private final String robot;
}
复制代码

通常 Builder 能够更加具体的创立字段的内容，比方 javadoc、annotations 或者初始化字段参数等，如：

FieldSpec android = FieldSpec.builder(String.class, "android")
    .addModifiers(Modifier.PRIVATE, Modifier.FINAL)
    .initializer("$S + $L", "Lollipop v.", 5.0d)
    .build();
复制代码

对应生成的代码

private final String android = "Lollipop v." + 5.0;
复制代码

• 接口

接口办法必须是 PUBLIC ABSTRACT 并且接口字段必须是 PUBLIC STATIC FINAL，应用TypeSpec.interfaceBuilder

如下

TypeSpec helloWorld = TypeSpec.interfaceBuilder("HelloWorld")
    .addModifiers(Modifier.PUBLIC)
    .addField(FieldSpec.builder(String.class, "ONLY_THING_THAT_IS_CONSTANT")
        .addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
        .initializer("$S", "change")
        .build())
    .addMethod(MethodSpec.methodBuilder("beep")
        .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
        .build())
    .build();
复制代码

生成的代码如下

public interface HelloWorld {
  String ONLY_THING_THAT_IS_CONSTANT = "change";

  void beep();}
复制代码

• 继承父类 实现接口

接口代码

package com.test.javapoet;
public interface TestInterface<T> {void test(T testPara);
}
复制代码

父类代码

public class TestExtendesClass {

}
复制代码

应用 javapoet 实现接口并且继承父类

final ClassName  InterfaceName = ClassName.get("com.test.javapoet","TestInterface");

    ClassName superinterface = ClassName.bestGuess("com.test.javapoet.TestClass");
    //ClassName superinterface = ClassName.get("com.test.javapoet","aa");

    TypeSpec.Builder spec = TypeSpec.classBuilder("TestImpl")
            .addModifiers(Modifier.PUBLIC)
            // 增加接口，ParameterizedTypeName 的参数 1 是接口，参数 2 是接口的泛型
            .addSuperinterface(ParameterizedTypeName.get(InterfaceName, superinterface)) 
            // 应用 ClassName.bestGuess 会主动导入包
            .superclass(ClassName.bestGuess("com.zs.javapoet.test.TestExtendesClass"));

    MethodSpec.Builder methodSpec = MethodSpec.methodBuilder("test")
            .addAnnotation(Override.class)
            .returns(TypeName.VOID)
            .addParameter(superinterface, "testPara")
            .addStatement("System.out.println(hello)" );

        TypeSpec typeSpec = spec.addMethod(methodSpec.build()).build();

    JavaFile file = JavaFile.builder("com.zs.javapoet", typeSpec).build();
    file.writeTo(System.out);

复制代码

生成代码

package com.test.javapoet;

    import com.zs.javapoet.test.TestExtendesClass;
    import java.lang.Override;

    public class TestImpl extends TestExtendesClass implements TestInterface<TestClass> {
      @Override
      void test(TestClass testPara) {System.out.println(hello);
      }
    }
复制代码

• 枚举类型

应用 TypeSpec.enumBuilder 来创立，应用 addEnumConstant 来增加

TypeSpec helloWorld = TypeSpec.enumBuilder("Roshambo")
    .addModifiers(Modifier.PUBLIC)
    .addEnumConstant("ROCK")
    .addEnumConstant("SCISSORS")
    .addEnumConstant("PAPER")
    .build();
复制代码

生成的代码

public enum Roshambo {
  ROCK,

  SCISSORS,

  PAPER
}
复制代码

更简单的类型也能够反对，如重写、注解等

TypeSpec helloWorld = TypeSpec.enumBuilder("Roshambo")
    .addModifiers(Modifier.PUBLIC)
    .addEnumConstant("ROCK", TypeSpec.anonymousClassBuilder("$S", "fist")
        .addMethod(MethodSpec.methodBuilder("toString")
            .addAnnotation(Override.class)
            .addModifiers(Modifier.PUBLIC)
            .addStatement("return $S", "avalanche!")
            .build())
        .build())
    .addEnumConstant("SCISSORS", TypeSpec.anonymousClassBuilder("$S", "peace")
        .build())
    .addEnumConstant("PAPER", TypeSpec.anonymousClassBuilder("$S", "flat")
        .build())
    .addField(String.class, "handsign", Modifier.PRIVATE, Modifier.FINAL)
    .addMethod(MethodSpec.constructorBuilder()
        .addParameter(String.class, "handsign")
        .addStatement("this.$N = $N", "handsign", "handsign")
        .build())
    .build();
复制代码

生成代码

public enum Roshambo {ROCK("fist") {
    @Override
    public void toString() {return "avalanche!";}
  },

  SCISSORS("peace"),

  PAPER("flat");

  private final String handsign;

  Roshambo(String handsign) {this.handsign = handsign;}
}
复制代码

• 匿名外部类

须要应用Type.anonymousInnerClass(""), 通常能够应用 $L 占位符来指代

TypeSpec comparator = TypeSpec.anonymousClassBuilder("")
    .addSuperinterface(ParameterizedTypeName.get(Comparator.class, String.class))
    .addMethod(MethodSpec.methodBuilder("compare")
        .addAnnotation(Override.class)
        .addModifiers(Modifier.PUBLIC)
        .addParameter(String.class, "a")
        .addParameter(String.class, "b")
        .returns(int.class)
        .addStatement("return $N.length() - $N.length()", "a", "b")
        .build())
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addMethod(MethodSpec.methodBuilder("sortByLength")
        .addParameter(ParameterizedTypeName.get(List.class, String.class), "strings")
        .addStatement("$T.sort($N, $L)", Collections.class, "strings", comparator)
        .build())
    .build();
复制代码

生成代码

void sortByLength(List<String> strings) {Collections.sort(strings, new Comparator<String>() {
    @Override
    public int compare(String a, String b) {return a.length() - b.length();}
  });
}
复制代码

定义匿名外部类的一个特地辣手的问题是参数的结构。在下面的代码中咱们传递了不带参数的空字符串。TypeSpec.anonymousClassBuilder(“”)。

• 注解

注解应用起来比较简单

MethodSpec toString = MethodSpec.methodBuilder("toString")
    .addAnnotation(Override.class)
    .returns(String.class)
    .addModifiers(Modifier.PUBLIC)
    .addStatement("return $S", "Hoverboard")
    .build();
复制代码

生成代码

  @Override
  public String toString() {return "Hoverboard";}
复制代码

通过AnnotationSpec.builder() 能够对注解设置属性：

MethodSpec logRecord = MethodSpec.methodBuilder("recordEvent")
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    .addAnnotation(AnnotationSpec.builder(Headers.class)
        .addMember("accept", "$S", "application/json; charset=utf-8")
        .addMember("userAgent", "$S", "Square Cash")
        .build())
    .addParameter(LogRecord.class, "logRecord")
    .returns(LogReceipt.class)
    .build();
复制代码

代码生成如下

@Headers(
    accept = "application/json; charset=utf-8",
    userAgent = "Square Cash"
)
LogReceipt recordEvent(LogRecord logRecord);
复制代码

注解同样能够注解其余注解，通过 $L 援用如

MethodSpec logRecord = MethodSpec.methodBuilder("recordEvent")
    .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
    .addAnnotation(AnnotationSpec.builder(HeaderList.class)
        .addMember("value", "$L", AnnotationSpec.builder(Header.class)
            .addMember("name", "$S", "Accept")
            .addMember("value", "$S", "application/json; charset=utf-8")
            .build())
        .addMember("value", "$L", AnnotationSpec.builder(Header.class)
            .addMember("name", "$S", "User-Agent")
            .addMember("value", "$S", "Square Cash")
            .build())
        .build())
    .addParameter(LogRecord.class, "logRecord")
    .returns(LogReceipt.class)
    .build();
复制代码

生成代码

@HeaderList({@Header(name = "Accept", value = "application/json; charset=utf-8"),
    @Header(name = "User-Agent", value = "Square Cash")
})
LogReceipt recordEvent(LogRecord logRecord);
复制代码

正文

• javadoc

0x03 后续

在 javapoet 之前有 javawriter，但 javapoet 有着更弱小的代码模型，并且对类的了解更加到位，因而举荐应用 javapoet

参考文章

• juejin.cn/post/684490…
• cloud.tencent.com/developer/a…
• blog.csdn.net/qq_26376637…

作者：渡口一艘船
链接：https://juejin.cn/post/684490…
起源：稀土掘金
著作权归作者所有。商业转载请分割作者取得受权，非商业转载请注明出处。

​
微信公众号【程序员黄小斜】作者是前蚂蚁金服 Java 工程师，专一分享 Java 技术干货和求职成长心得，不限于 BAT 面试，算法、计算机根底、数据库、分布式、spring 全家桶、微服务、高并发、JVM、Docker 容器，ELK、大数据等。关注后回复【book】支付精选 20 本 Java 面试必备精品电子书。

​