如何在Java注释处理器中从局部变量中去除注释?

问题描述

由于特定的原因,我想使用Checker Framework及其子类型检查器。 要使此检查器起作用,我必须使用ElementType.TYPE_ParaMETERElementType.TYPE_USE。 但是,我想在编译为类文件之前将它们从局部变量中删除

例如,假设我有以下带有自定义@FirstName@LastName代码(这两个代码都必须保留在RetentionPolicy.CLASS的类级别):

@FirstName String firstName = ...;
@LastName String lastName = ...;
...
firstName = lastName; // illegal,the error is generated by Checker Framework because the first name cannot be assigned to the last name

但是由于另一个原因,我想从本地变量“ at” 字节码级别删除注释,就像代码只是:

String firstName = ...;
String lastName = ...;
...
firstName = lastName; // totally fine and legal in Java

如果我了解可以实现的方式,则注释处理是一种可行的方法。 因此,如果做对了,那我就必须按以下顺序链接一些注释处理器:

  • org.checkerframework.common.subtyping.SubtypingChecker
  • 我的自定义删除局部变量注释”注释处理器;

好吧,深入研究javac的工作方式对我来说是一个极大的挑战。 到目前为止,我已经实现了:

@SupportedOptions(RemoveLocalVariableAnnotationsprocessor.ANNOTATIONS_OPTION)
@SupportedAnnotationTypes("*")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public final class RemoveLocalVariableAnnotationsprocessor
        extends AbstractProcessor {

    private static final Pattern commaPattern = Pattern.compile(",");

    static final String ANNOTATIONS_OPTION = "RemoveLocalVariableAnnotationsprocessor.annotations";

    @Nonnull
    private Predicate<? super Class<? extends Annotation>> annotationClasses = clazz -> false;

    @Override
    public void init(@Nonnull final ProcessingEnvironment environment) {
        super.init(environment);
        final Messager messager = environment.getMessager();
        final Map<String,String> options = environment.getoptions();
        @Nullable
        final String annotationsOption = options.get(ANNOTATIONS_OPTION);
        if ( annotationsOption != null ) {
            annotationClasses = commaPattern.splitAsstream(annotationsOption)
                    .<Class<? extends Annotation>>flatMap(className -> {
                        try {
                            @SuppressWarnings("unchecked")
                            final Class<? extends Annotation> clazz = (Class<? extends Annotation>) Class.forName(className);
                            if ( !clazz.isAnnotation() ) {
                                messager.printMessage(Diagnostic.Kind.WARNING,"Not an annotation: " + className);
                                return Stream.empty();
                            }
                            return Stream.of(clazz);
                        } catch ( final ClassNotFoundException ex ) {
                            messager.printMessage(Diagnostic.Kind.WARNING,"Cannot find " + className);
                            return Stream.empty();
                        }
                    })
                    .collect(Collectors.collectingAndThen(Collectors.toSet(),Collections::unmodifiableSet))
                    ::contains;
        }
        final Trees trees = Trees.instance(environment);
        final JavacTask javacTask = JavacTask.instance(environment);
        javacTask.addTaskListener(new RemoverTaskListener(trees,messager));
    }

    @Override
    public boolean process(final Set<? extends TypeElement> annotations,final RoundEnvironment environment) {
        // do nothing: ElementType.TYPE_USE and ElementType.TYPE_ParaMETER seem to be unable to be analyzed here
        return false;
    }

    private static final class RemoverTaskListener
            implements TaskListener {

        private final Trees trees;
        private final Messager messager;

        private RemoverTaskListener(final Trees trees,final Messager messager) {
            this.trees = trees;
            this.messager = messager;
        }

        @Override
        public void started(final TaskEvent taskEvent) {
            if ( taskEvent.getKind() == TaskEvent.Kind.ANALYZE ) {
                final TreeScanner<?,?> remover = new Remover(trees,messager);
                remover.scan(taskEvent.getcompilationunit(),null);
            }
        }

        @Override
        public void finished(final TaskEvent taskEvent) {
            // do nothing
        }

        private static final class Remover
                extends TreePathScanner<Void,Void> {

            private final Trees trees;
            private final Messager messager;

            private Remover(final Trees trees,final Messager messager) {
                this.trees = trees;
                this.messager = messager;
            }

            @Override
            public Void visitvariable(final VariableTree variableTree,final Void nothing) {
                super.visitvariable(variableTree,nothing);
                final Symbol symbol = (Symbol) trees.getElement(trees.getPath(getCurrentPath().getcompilationunit(),variableTree));
                if ( !symbol.hasTypeAnnotations() || symbol.getKind() != ElementKind.LOCAL_VARIABLE ) {
                    return nothing;
                }
                final List<? extends AnnotationTree> annotationTrees = variableTree.getModifiers().getAnnotations();
                if ( annotationTrees.isEmpty() ) {
                    return nothing;
                }
                messager.printMessage(Diagnostic.Kind.WARNING,"Todo: " + symbol);
                for ( final AnnotationTree annotationTree : annotationTrees ) {
                    // Todo how to align AnnotationTree and java.lang.annotation.Annotation?
                    // Todo how to remove the annotation from the local variable?
                }
                return nothing;
            }

        }

    }

}

如您所见,它无法正常运行。

从局部变量中删除注释的正确方法是什么? 我的意思是,我该如何完成? 如果可能的话,由于Maven构建集成方面的细节,我想坚持使用javac注释处理器。

解决方法

据我所知,您不能通过这种方式做到这一点:

  • javac注释处理器(JSR-269)无法修改代码。他们只能观察并生成新代码,这些新代码将与手写代码一起编译。因此,注释处理需要多轮完成,以允许编译器和其他注释处理器看到新生成的代码。当回合结束时没有新代码生成时,处理基本上停止。
  • 这样就不会定义注释处理器调用的顺序 ,而且还可以,因为多轮编译-它有助于解决循环依赖性。

您需要的是一个字节码重写器(ASM库会做的很好)。编译完成后,此类工具将对生成的.class文件进行操作。再次,AFAIK,注释处理被嵌入到编译本身中,因此您将无法在Checker注释处理器看到字节码之前重写字节代码。

因此,可悲的是,我没有找到任何解决方案,但是尝试分叉Checker Framework,并使其忽略您想要的注释,如果它当然还没有关闭某些验证的选项。