Modify Java 8 final behaviour with Annotations【翻译】

文章来源于博客《Modify Java 8 final behaviour with Annotations》,作者Johan Kragt,我觉得写的很好,所以尝试翻译。
本文主旨是使用Java的Annotation来动态修改AST


为什么我要写这个项目(How I started this project)

不久前我去参加了一场由JDriven的Ties van de Ven 举办的名为“致命的Null(Death To Null)”的会议。会议内容并没过多涉及到null检查和NullPointerExceptions异常,但是更关注于不变性(Immutability )以及如何让你的软件避免bug和NullPointerExceptions异常。有一句话让我深思(大致意思是):“Java选了错误的默认方式。Java中所有的东西应该被默认为final,除非开发者显式地注明它是可变的(mutable),而不是在只有当我们需要 不可变变量(immutable variable)的才显式标注为final”。

在对注解(Annotation)了解不多的时候,我以为利用注解就可以很轻松实现它。但是我遇到的第一个困难就是注解不能修改程序源代码,或者从源代码编译出的字节码文件;它们只能产生新的源文件或者验证代码。这使我迅速注意到了名为Lombok的库,该库却实现了这个功能。如果你使用过Lombok来生成gettersetter方法(这些方法并没有在你的源文件中写出),你可能会奇怪你的IDE是从哪里找到这些gettersetter方法的。

我们都知道Java的编译是一个递归过程。首先编译器会将你的源代码解析为一个AST,即抽象语法树。然后注解处理器(annotation processors)将会开始运行,它会基于你的注解来生成额外的代码文件或者做一些额外的验证。编译错误,比如不合法的类或者不合法的方法调用,会在编译的第三阶段进行。然而,如果一个注解处理器生成了新的源文件,那么编译器将会在进行第三步之前重复执行第一步和第二步。

Lombok库,以及我的验证性测试(proof of concept),将会用到一点hack技巧。在这里,并不需要利用注解处理器来生成新的文件,而是直接修改AST。这将可以让处理器在不接触源代码或者字节码的情况下改变代码。

一个更详细的解释在这里。虽然它有点过时,但还是能给你点帮助。

构建一个验证性测试(Building a PoC)

该验证性测试将会创建一个新的maven项目。它有两个子项目,其中一个包含自定义的注解以及注解处理器,另一个则包含一个测试类,它使用了这些注解。

我将创建两个注解,@FinalizeVars是一个类型注解,它告诉处理器,将被该注解标明的类中的所有变量都变为final@MutableVar则是一个字段和局部变量的注解,表示处理器在处理final时跳过这些量。

虽然可以给@MutableVar添加一些额外功能,比如注解了@MutableVar的变量将会被移除final限定,但是对于像@MutableVar final String t = “test”这样的语句这么做显然没有什么意义。

代码实现(The code)

注解(The annotations)

这些注解是非常简单且标准的。

package nl.johannisk.finalizer.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE})
public @interface FinalizeVars {
}

FinalizeVars是类型注解(Types)。

下面这个注解对于实现此功能(即将类中的字段都变为final)来说并不是完全必要的,但是我希望在程序员明确指出要将某些变量保留为可变时,注解处理器也能够处理(原句:“This Annotation is not entirely necessary for the functionality to work, but I didn’t want the annotation processor to change the functionality of the Java Compiler without the programmer explicitly telling it to do something strange.”):

package nl.johannisk.finalizer.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.LOCAL_VARIABLE, ElementType.FIELD})
public @interface MutableVar {
}

MutableVar是一个局部变量和字段的注解。如果局部变量和字段具有该注解,则注解处理器将会跳过这些字段。

注解处理器(The Processor)

在定义注解的那个项目里,按照如下路径建立一个文本文件:resources/META-INF/services/javax.annotation.processing.Processor就可以让编译器使用注解处理器工作。(译注:如果是在命令行中使用javac命令,则可以使用-processor参数后跟处理器的字节码文件来指定处理器,如果没有该参数命令,则有可能javac的版本过低。)

这个文本文件里必须写明带有完整限定的处理器类名,如nl.johannisk.finalizer.processor.FinalizerProcessor

实际的处理器具有两个类。一个是处理器本身,还有一个是“访问者”(或者称为”转换器”),用来遍历和转换AST中的每一个根元素。

处理器定义如下:

package nl.johannisk.finalizer.processor;
 
import com.sun.source.util.Trees;
import com.sun.tools.javac.processing.JavacProcessingEnvironment;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.TreeMaker;
 
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import java.util.Set;
 
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes({"nl.johannisk.finalizer.annotation.FinalizeVars",
        "nl.johannisk.finalizer.annotation.MutableVar"})
public class FinalizerProcessor extends AbstractProcessor {
    private Trees trees;
    private TreeMaker treeMaker;
 
    @Override
    public void init(final ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        final JavacProcessingEnvironment javacProcessingEnvironment =
                (JavacProcessingEnvironment) processingEnvironment;
        this.trees = Trees.instance(processingEnvironment);
        this.treeMaker =
                TreeMaker.instance(javacProcessingEnvironment.getContext());
    }
    @Override
    public boolean process(final Set<? extends TypeElement> annotations,
                           final RoundEnvironment roundEnvironment) {
        if (!roundEnvironment.processingOver()) {
            processRootElements(roundEnvironment.getRootElements());
        }
        return false;
    }
 
    private void processRootElements(final Set<? extends Element> rootElements) {
        rootElements.forEach(this::processRootElement);
    }
 
    private void processRootElement(final Element element) {
        JCTree tree = (JCTree) trees.getTree(element);
        tree.accept(new FinalizerTranslator(treeMaker));
    }
}

处理器需要继承AbstractProcessor类,并且起码要重写process方法。

因为还需要用到AST树,所以我还重写了init方法。该方法先调用父类的init方法,然后将treeMaker初始化为访问器。同时还将AST树保存在tree字段中,以便process使用。(译注:com.sun.tools.javac.processingJavacProcessingEnvironmentcom.sun.tools.javac.treeTreeMaker是在%JAVA_HOME%/lib/tools.jar中定义的,请导入该包。com.sun.source.util.Trees则在标准库中定义。Trees用于解析Java AST树,而TreeMaker: 用于生成Java AST节点。)

process方法首先检查是否已经处理完毕,如果没有(即第一次运行)则获得所有根元素并且用访问者(visitor)访问。访问者会判断当前访问的根元素是否需要被处理,然后一个新的访问者(FinalizerTranslator) 将会被创建。

package nl.johannisk.finalizer.processor;
 
import com.sun.tools.javac.code.Flags;
import com.sun.tools.javac.tree.TreeMaker;
import com.sun.tools.javac.tree.TreeTranslator;
import com.sun.tools.javac.tree.JCTree;
 
public class FinalizerTranslator extends TreeTranslator {
 
    private final TreeMaker treeMaker;
    private boolean shouldVisitVarDefinitions = false;
 
    public FinalizerTranslator(final TreeMaker treeMaker) {
        this.treeMaker = treeMaker;
    }
 
    @Override
    public void visitClassDef(final JCTree.JCClassDecl classDeclaration) {
        if (isFinalizeVarsAnnotation(classDeclaration.getModifiers())) {
            shouldVisitVarDefinitions = true;
        }
        super.visitClassDef(classDeclaration);
    }
 
    @Override
    public void visitVarDef(final JCTree.JCVariableDecl variableDeclaration) {
        super.visitVarDef(variableDeclaration);
        JCTree.JCModifiers modifiers = variableDeclaration.getModifiers();
        if (shouldBeMadeFinal(variableDeclaration, modifiers)) {
            variableDeclaration.mods = treeMaker.Modifiers(variableDeclaration.mods.flags | Flags.FINAL);
        }
        this.result = variableDeclaration;
    }
 
    private boolean shouldBeMadeFinal(final JCTree.JCVariableDecl variableDeclaration, final JCTree.JCModifiers modifiers) {
        return  !isMutableVarAnnotation(modifiers) &&
                !isVolatile(variableDeclaration.getModifiers()) &&
                shouldVisitVarDefinitions;
    }
 
    private boolean isMutableVarAnnotation(final JCTree.JCModifiers modifiers) {
        return modifiers.toString().contains("@MutableVar()");
    }
 
    private boolean isFinalizeVarsAnnotation(final JCTree.JCModifiers modifiers) {
        return modifiers.toString().contains("@FinalizeVars()");
    }
 
    private boolean isVolatile(final JCTree.JCModifiers modifiers) {
        return (modifiers.flags & Flags.VOLATILE) > 0;
    }
}

FinalizerTranslator即为访问者。因为注解将会被用于类和变量声明,所以对于这些元素的visit方法将被重写。

首先,visitClassDef将会访问类的定义内容,因为这些注解被用于类。如果一个类被FinalizeVars注解,那么visitVarDefinition将会被设为true。否则,(如果一个类没有注解FinalizeVars)该类中的变量声明将不会被后续处理。

接下来,visitVarDef会访问所有变量定义。注意这将会访问到类中所有的变量定义,而不仅仅是被注解的那些。

如果(变量)被注解(@MutableVar)、且没有被volatile修饰(因为它与final不兼容),同时(这些变量所在的)类被@FinalizeVars注解,那么treeMaker将基于原来(变量的)修饰符创建一个新的修饰符,将final修饰符加入。

调试(Debugging)

原文及翻译略:-)


外部参考

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 29,120评论 15 116
  • JDK各个版本的新特性 对于很多刚接触java语言的学者来说,要了解一门语言,最好的方式是从基础的版本进行理解,升...
    小庄bb阅读 1,082评论 0 1
  • 销售前不准备就准备失败,失败的准备也意味着失败,我们在拜访客户前就要为前期引起客户共鸣做准备, 1公司资源,销售政...
    自在独行121阅读 421评论 0 0
  • “天要亮了 我将要去拈花 你会微笑吗” 岁月枯槁 在梦里 我仿佛拥抱着 你清瘦的灵魂 可是 我正囚禁于 你的眼眸 ...
    与愁予阅读 459评论 2 6