6

我正在研究一个注释，它的目的是强制一个类是不可变的。这里是处理器的代码：

@SupportedAnnotationTypes("archipel.immutability.IsImmutable")
@SupportedSourceVersion(SourceVersion.RELEASE_6)
public class IsImmutableProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations,
            RoundEnvironment roundEnv) {
        for (TypeElement type : annotations) {
            processMustBeImmutable(roundEnv, type);
        }
        return true;
    }

    private void processMustBeImmutable(RoundEnvironment env, TypeElement type) {
        for (Element element : env.getElementsAnnotatedWith(type)) {
            processClass(element);
        }
    }

    private void processClass(Element element) {
        boolean isFinal=false;

        for(Modifier modifier : element.getModifiers()) {
            if (modifier.equals(Modifier.FINAL)) {
                isFinal=true;
                break;
            }
        }

        if (!isFinal) {
            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Class "+element+" is not immutable because it is not final");
        } else {
            for (Element subElement : element.getEnclosedElements()) {
                if (subElement.getKind()==ElementKind.FIELD) {
                    isFinal=false;

                    for(Modifier modifier : subElement.getModifiers()) {
                        if (modifier.equals(Modifier.FINAL)) {
                            isFinal=true;
                            break;
                        }
                    }
                    if (!isFinal) {
                        processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Field "+element+" is not immutable because it is not final");
                    } else {
                        Element superElement = subElement.getEnclosingElement();
                        // TODO
                    }
                }
            }
        }
    }

}

注释本身是微不足道的，当然：

@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface IsImmutable {
}

我用 Ant 脚本编译它：

<project name="immutability" basedir="." default="main">

    <property name="lib.dir" value="lib"/>

    <property name="src.dir" value="src"/>

    <property name="build.dir" value="build"/>
    <property name="classes.dir" value="${build.dir}/classes"/>
    <property name="meta.dir" value="${build.dir}/META-INF"/>
    <property name="jar.dir" value="${build.dir}/jar"/>

    <property name="processor-package"
        value="archipel.immutability" />

    <property name="processor" value="${processor-package}.IsImmutableProcessor"/>

    <path id="classpath">
        <fileset dir="${lib.dir}" includes="**/*.jar"/>
        <fileset dir="${classes.dir}"/>
    </path>

    <target name="clean">
    <delete dir="${build.dir}"/>
    </target>

    <target name="compile" description="Compiles the code.">
        <mkdir dir="${classes.dir}"/>
        <javac srcdir="${src.dir}" destdir="${classes.dir}" classpathref="classpath" />
    </target>

    <target name="jar" depends="compile">
        <mkdir dir="${jar.dir}"/>
        <jar destfile="${jar.dir}/${ant.project.name}.jar">
            <fileset dir="${classes.dir}"/>
            <service type="javax.annotation.processing.Processor" provider="archipel.immutability.IsImmutableProcessor"/>
        </jar>
    </target>

    <target name="main" depends="clean,jar"/>

</project>

问题是，必须缺少一些东西，因为当我尝试使用结果 jar 文件提供的结果注释时，如下所示，没有任何反应：

@IsImmutable
public class Immut {

    private int toto;

    public int getToto() {
        return toto;
    }

    public void setToto(int toto) {
        this.toto = toto;
    }

    public final static void main(String args[]) {
        Immut truc = new Immut();
        truc.setToto(5);
        truc.setToto(6);
    }

}

很明显，这个类不是最终的，并且该类应该在 Eclipse 中发出错误信号。但事实并非如此。

任何想法？

编辑：我用 build.xml 构建的 jar 文件似乎是正确的：它包含类文件，还有一个META-INF/services/javax.annotation.processing.Processor文件，其中包含archipel.immutability.IsImmutableProcessor. 我在我的测试项目中导入了这个 jar 文件，当我在 Immut 类中使用注解时（这只是一个粗略的测试），什么也没有发生。

4

2 回答 2

11

默认情况下，注释处理在 Eclipse 中是禁用的。为了启用它，您需要打开项目属性，然后 1. Java 编译器 -> 注释处理：启用注释处理 2. Java 编译器 -> 注释处理 -> 工厂路径：添加带有工厂的 jar

如果您需要更多信息，请查看：eclipse 中的 AP 入门

编辑：

看看这个教程。它详细解释了如何设置 eclipse 以使用自定义注释处理器。

重要提示：打印错误时使用此方法： javax.annotation.processing.Messager.printMessage(Kind, CharSequence, Element) 而不是：
javax.annotation.processing.Messager.printMessage(Kind, CharSequence).

第一个消息在 Problems 视图和大多数与源相关的视图中可见，而来自第二个的消息仅在 ErrorLog 视图中可见。

于 2012-07-21T19:24:40.160 回答
0

可能值得使用cglib使您的对象不可变。因为假设您的类中有一个集合，并且集合字段是最终的。你也有这个集合的吸气剂。这是否意味着不能在课堂之外修改集合？不完全是。仅当此集合使用Collections.unmodifiedCollection方法包装时。或者，如果您使用的是 guava 不可变集合http://code.google.com/p/guava-libraries/wiki/ImmutableCollectionsExplained

关键是 - 不要试图处理这只是检查字段是否是最终的 - 它不会处理所有情况。使用cglib代理，而不是像spring 和 hibernate那样

于 2012-07-27T13:13:10.977 回答