深入Dagger:自定义AutoValue

前言

上一篇文章介绍了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实现的,可以参考完整代码和上一篇文章,这里就不列出了。

  1. 打包编译,需要注意的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>

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

  1. 使用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的内容。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容