前言

上一篇文章介绍了JavaPoet的原理和使用,这里在介绍一下AutoValue的原理,并模仿自定义实现一个AutoValue。

AutoValue的是Google为了实现ValueClass设计的自动编译框架,具体的介绍可以参考Google的官方说明

Dagger内部也大量使用了AutoValue的功能,来实现ValueClass

AutoValue

AutoValue嵌入到JavaClass的编译过程,读取被注解的类,来创建一个新的ValueClass。这里有一个完整使用的例子

这里主要介绍一下AutoValue的实现。

  1. 定义注解AutoValue
    @Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface AutoValue {
}
  1. 注册processor,AutoValue的jar包中的META-INF/services路径里面包含文件javax.annotation.processing.Processor,文件里包含了注册的processor,换行分割。这里面注册了AutoValueProcessor
  2. AutoValueProcessorprocess方法实现了主要的处理逻辑,读取注释的类的信息,构造新的类,并写入文件。processType方法是处理单个类的方法,主要的逻辑如下
	AutoValueTemplateVars vars = new AutoValueTemplateVars();
vars.pkg = TypeSimplifier.packageNameOf(type);
vars.origClass = TypeSimplifier.classNameOf(type);
vars.simpleClassName = TypeSimplifier.simpleNameOf(vars.origClass);
vars.subclass = TypeSimplifier.simpleNameOf(subclass);
vars.finalSubclass = TypeSimplifier.simpleNameOf(finalSubclass);
vars.isFinal = applicableExtensions.isEmpty();
vars.types = processingEnv.getTypeUtils();
determineObjectMethodsToGenerate(methods, vars);
defineVarsForType(type, vars, toBuilderMethods, propertyMethods, builder);
GwtCompatibility gwtCompatibility = new GwtCompatibility(type);
vars.gwtCompatibleAnnotation = gwtCompatibility.gwtCompatibleAnnotationString();
String text = vars.toText();
text = Reformatter.fixup(text);
writeSourceFile(subclass, text, type);

AutoValueTemplateVars保存了新的类的信息,并根据对应的模板生成源文件字符串.

    private void writeSourceFile(String className, String text, TypeElement originatingType) {
try {
JavaFileObject sourceFile =
processingEnv.getFiler().createSourceFile(className, originatingType);
Writer writer = sourceFile.openWriter();
try {
writer.write(text);
} finally {
writer.close();
}
} catch (IOException e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING,
"Could not write generated class " + className + ": " + e);
}
}

writeSourceFile则会根据原生api将源代码写入本地文件。

MyAutoValue

所以自定义AutoValue也是类似的原理。这里构造MyAutoValue来读取注解的类,生成新的带有get,set和toString方法类。

因为processor的注册只能在jar中使用,不能跟源文件放在一起,所以这里新建了一个工程来实现MyAutoValue,使用方法在这里

  1. 定义MyAutoValue
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface MyAutoValue {
}
  1. MyAutoValueProcessor。同样先在resources/META-INF/services下新建javax.annotation.processing.Processor,并注册MyAutoValueProcessor

    MyAutoValueProcessor继承了AbstractProcessor,并在process中实现了主要的逻辑。
    @Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(MyAutoValue.class);
if (elements == null || elements.isEmpty()) {
return true;
}
for (Element element : elements) {
if (!(element instanceof TypeElement)) {
continue;
}
try {
processType(element);
} catch (Exception e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage(), element);
}
}
return true;
}

这里去取了所有被MyAutoValue注释的类,并交给processType去处理。

    private void processType(Element element) {
TypeElement typeElement = (TypeElement) element;
String className = element.getSimpleName() + "_MyAutoValue";
TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder(className);
typeSpecBuilder.addAnnotation(makeAnnotationSpec());
typeSpecBuilder.addModifiers(Modifier.PUBLIC);
String packageName = getPackageName(typeElement);
try {
makeFieldAndMethod(typeElement, typeSpecBuilder);
} catch (ClassNotFoundException e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage());
}
JavaFile.Builder javaFileBuilder = JavaFile.builder(packageName, typeSpecBuilder.build());
String text = javaFileBuilder.build().toString();
try {
JavaFileObject sourceFile = processingEnv.getFiler().createSourceFile(className, element);
Writer writer = sourceFile.openWriter();
try {
writer.write(text);
} finally {
writer.close();
}
} catch (IOException e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage());
}
}

processType会读取类的字段生成一个新的*_MyAutoValue的类,并根据原有类的字段生成get,set和toString方法,然后将新类写入到本地文件中。

    private void makeFieldAndMethod(Element element, TypeSpec.Builder typeSpecBuilder) throws ClassNotFoundException {
List<VariableElement> elementList = ElementFilter.fieldsIn(element.getEnclosedElements());
if (elementList == null || elementList.isEmpty()) {
return;
}
List<String> fieldList = new ArrayList<>(elementList.size());
for (VariableElement variableElement : elementList) {
String fieldName = variableElement.getSimpleName().toString();
fieldList.add(fieldName);
TypeName typeName = TypeName.get(variableElement.asType());
typeSpecBuilder.addField(makeFieldSpec(fieldName, typeName));
typeSpecBuilder.addMethod(makeSetMethod(fieldName, typeName));
typeSpecBuilder.addMethod(makeGetMethod(fieldName, typeName));
}
typeSpecBuilder.addMethod(makeToStringMethod(fieldList));
}

makeFieldAndMethod就是具体的构造字段和方法的逻辑,内部使用JavaPoet实现的,可以参考完整代码和上一篇文章,这里就不列出了。

3. 打包编译,需要注意的META-INF/servicesjavax.annotation.processing.Processor会阻止javac的编译,打完包会发现里面没有class文件,所以需要加上特殊的参数。

    <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<encoding>UTF-8</encoding>
<compilerArgument>-proc:none</compilerArgument>
</configuration>
</plugin>
</plugins>
</build>

加上-proc:none就可以实现完整的打包了。

4. 使用MyAutoValue。在MyAutoValueClassTest类上注解MyAutoValue

    @MyAutoValue
public class MyAutoValueClassTest {
private String a;
private String b;
private int c;
}

编译完后就会生成以下的新类,会发现自定带上了get,set和toString的方法。

public class MyAutoValueClassTest_MyAutoValue {
private String a;
private String b;
private int c;
public MyAutoValueClassTest_MyAutoValue() {
}
public void setA(String a) {
this.a = a;
}
public String getA() {
return this.a;
}
public void setB(String b) {
this.b = b;
}
public String getB() {
return this.b;
}
public void setC(int c) {
this.c = c;
}
public int getC() {
return this.c;
}
public String toString() {
return "{\"a\":\"" + this.a + "\",\"b\":\"" + this.b + "\",\"c\":\"" + this.c + "\"}";
}
}

结语

dagger的实现跟AutoValue类似,也是根据注解嵌入编译实现新的类,只是AutoValue的逻辑比较简单,只是实现ValueClass的构造,dagger会涉及到更多依赖注入的功能。后面会介绍更多dagger的内容。

深入Dagger:自定义AutoValue的更多相关文章

  1. Dagger2的基本概念与实际应用。

    本文系原创博客,文中不妥烦请指出,如需转载摘要请注明出处! Dagger2的基本概念与实际应用 Alpha Dog 2016-11-30  10:00:00 本文Demo的github地址:https ...

  2. [Android]使用Dagger 2依赖注入 - 自定义Scope(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5095426.html 使用Dagger 2依赖注入 - 自定义 ...

  3. [Android]使用Dagger 2来构建UserScope(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/6237731.html 使用Dagger 2来构建UserSco ...

  4. [Android]使用Dagger 2进行依赖注入 - Producers(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/6234811.html 使用Dagger 2进行依赖注入 - P ...

  5. [Android]在Dagger 2中使用RxJava来进行异步注入(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客: # 在Dagger 2中使用RxJava来进行异步注入 > 原文: 几星期前我写了一篇关于在Dagger 2中使用*Producers*进行 ...

  6. [Android]使用Dagger 2依赖注入 - DI介绍(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5092083.html 使用Dagger 2依赖注入 - DI介 ...

  7. [Android]使用Dagger 2依赖注入 - API(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5092525.html 使用Dagger 2依赖注入 - API ...

  8. [Android]使用Dagger 2依赖注入 - 图表创建的性能(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5098943.html 使用Dagger 2依赖注入 - 图表创 ...

  9. [Android]使用自定义JUnit Rules、annotations和Resources进行单元测试(翻译)

    以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5795091.html 使用自定义JUnit Rules.ann ...

随机推荐

  1. Php 十六进制短浮点数转十进制,带符号位

    /** * 十六进制浮点型转为十进制 * @param String $strHex 十六进制浮点数 * @return 十进制 */ public static function hexToDecF ...

  2. Ubuntu18.04安装Tensorflow1.14GPU

    软件要求 必须在系统中安装以下 NVIDIA® 软件: https://www.pytorials.com/how-to-install-tensorflow-gpu-with-cuda-10-0-f ...

  3. mysql数据库的水平分表与垂直分表实例讲解

    mysql语句的优化有局限性,mysql语句的优化都是围绕着索引去优化的,那么如果mysql中的索引也解决不了海量数据查询慢的状况,那么有了水平分表与垂直分表的出现(我就是记录一下自己的理解) 水平分 ...

  4. HashMap源码浅析

    HashMap源码主要一些属性 //默认的初始化容量(2的n次方) static final int default_inital_capacity = 16; //最大指定容量为2的30次方 sta ...

  5. ivew 修改排序号的逻辑

    排序号修改的逻辑 1.构建修改排序号传递的参数 formInline2:{ recommendType:4, //产品类型 merchantCodes:[], //产品code discountRec ...

  6. 本地MongoDB服务开启与连接本地以及远程服务器MongoDB服务

    转载:https://blog.csdn.net/sunshinegyan/article/details/80017012 前提:本地已经安装好了MongoDB服务 1启动MongoDB: 方法1: ...

  7. Kaggle数据集下载

    Kaggle数据集下载步骤: 安装Kaggle库: 注册Kaggle账户: 找到数据集,接受rules: 在My Account>>API中,点击Create New API Token, ...

  8. Qt pro使用sql之类的需要添加的模块

    举个栗子,当要使用QSqlQuery 的时候需要在pro中添加Qt +=sql 然后在.h里面#include<QSqlQuery>即可使用sql. 同理要使用media或者net的时候只 ...

  9. JavaSE---多线程---集合类

    1.概述 1.1 Java提供的ArrayList.LinkedList.HashMap等都是线程不安全的类,如何解决: 1.1 使用Collections类提供的方法将  其  包装成线程安全类: ...

  10. GA来源分析

    网页中广告素材分为:文字,图片和FLASH三种.针对这三种素材,2种有无参数的情况,新旧版GA收集到的结果为: 提醒:FLASH素材如果不加参数收集不到来源: 具体GA参数如下: 可参考:https: ...