java - 我想为具有给定值的 JPA 注释生成编译警告

我刚刚读完 AspectJ in Action 并且正在尝试编写一些简单的方面来开始。我想编写一个方面，为使用 EnumType.ORDINAL 持久化到数据库的字段生成编译时警告，但不会为使用 EnumType.STRING 的字段生成警告。我写过类似的方面，但这是我尝试在切入点中使用注释的第一个方面，但我做错了。

我有一个 JPA2.1 实体，如下所示，并且希望附加到 @Enumerated(EnumType.ORDINAL) 的 myEnumFieldB 注释生成编译器警告...

import javax.persistence.Entity;
import javax.persistence.Enumerated;
import javax.persistence.EnumType;

@Entity
public class myEntity {
    @Enumerated(EnumType.STRING) // I want this to compile ok
    protected MyEnumType myEnumFieldA;

    @Enumerated(EnumType.ORDINAL) // I want this to throw a warning
    protected MyEnumType myEnumFieldB;

    // primary key, other fields, getters & setters, etc. omitted
}

...这是我尝试几个不同切入点(注释掉)的代码的副本，错误消息包含在它们旁边。命名切入点仅由最后注释掉的行使用。

import javax.persistence.Enumerated;
import javax.persistence.EnumType;

public aspect DetectEnumPersistencePolicy {
    pointcut ordinalEnumPersistence(Enumerated enumerated)
        : @annotation(enumerated) && if(enumerated.value() == EnumType.ORDINAL);
        // used below in a commented-out pointcut

    declare warning
        : @Enumerated(EnumType.ORDINAL)
        //ERROR: Syntax error on token "Enumerated", "pointcut name" expected

        //: @javax.persistence.Enumerated(javax.persistence.EnumType.ORDINAL)
        //ERROR: Syntax error on token "javax", "pointcut name" expected

        //: @Enumerated(EnumType.ORDINAL) * *.*
        //ERROR: Syntax error on token "Enumerated", "pointcut name" expected

        //: execution(@Enumerated(EnumType.ORDINAL) * *.*)
        //ERROR: Syntax error on token ")", "(" expected

        //: ordinalEnumPersistence(enumerated)
        // ERROR: if() pointcut designator cannot be used in declare statement

        : "Please consider using string persistence of enumerated types instead.";
}

到目前为止，我的想法是:

当我尝试包含 if(enumerated.value() == EnumType.ORDINAL) 时，错误消息是 if() pointcut designator cannot be used in declare statement 。这让我觉得我不能使用带有 if() 的切入点，因为它会在运行时进行评估，但 warning 需要在编译时生成(即使数据在编译时都在那里，因为注释的值没有随运行时状态而变化)？

与 execution(@Enumerated(EnumType.ORDINAL) * *.*) 相同，因为执行发生在运行时。错误消息 Syntax error on token ")", "(" expected 对我来说意义不大(它指的是第二个 ) )。

如果我只使用 @annotation(enumerated) 它应该在编译时工作，但是我不知道如何在抛出警告之前执行检查 enumerated.value() == EnumType.ORDINAL？

我尝试在切入点 @javax.persistence.Enumerated(javax.persistence.EnumType.ORDINAL) 中使用完全限定名称，但仍然收到错误消息 Syntax error on token "javax", "pointcut name" expected 。

我尝试在切入点的注释中附加一些星号以指定我指的是一个字段 @Enumerated(EnumType.ORDINAL) * *.* 但仍然收到错误消息 Syntax error on token "Enumerated", "pointcut name" expected 。

为了完整起见，我在 Spring Tool Suite 3.7.2 和 Java 1.8 中工作，并使用 Maven 管理以下 AspectJ 依赖项:

<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjlib</artifactId>
  <version>1.6.2</version>
</dependency>
<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjrt</artifactId>
  <version>1.8.7</version>
</dependency>
<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjtools</artifactId>
  <version>1.8.7</version>
</dependency>
<dependency>
  <groupId>org.aspectj</groupId>
  <artifactId>aspectjweaver</artifactId>
  <version>1.8.7</version>
</dependency>

任何帮助将不胜感激 - 我不明白为什么 @Enumerated(EnumType.ORDINAL) 不起作用？

最佳答案

实际上您有一个基本问题:没有切入点捕获成员声明，仅用于成员的读/写访问。我分别在谈论 get() 和 set() 。因此，您要拦截的是那些。试试这个:

使示例代码编译的虚拟助手类:

package de.scrum_master.app;

public class MyEnumType {}

带有注释成员的 Java 类以及演示方面的主要方法:

package de.scrum_master.app;

import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;

@Entity
public class MyEntity {
    @Enumerated(EnumType.STRING) // I want this to compile ok
    protected MyEnumType myEnumFieldA;

    @Enumerated(EnumType.ORDINAL) // I want this to throw a warning
    protected MyEnumType myEnumFieldB;

    public static void main(String[] args) {
        MyEntity myEntity = new MyEntity();
        myEntity.myEnumFieldA = new MyEnumType();
        System.out.println(myEntity.myEnumFieldB);
    }
}

如您所见，myEnumFieldB 在最后一行被访问了一次。这应该会引发编译器警告。

方面:

package de.scrum_master.aspect;

import javax.persistence.Enumerated;
import javax.persistence.EnumType;

public aspect DetectEnumPersistencePolicy {
    pointcut ordinalEnumPersistence() :
        set(@Enumerated(value=EnumType.ORDINAL) * *) ||
        get(@Enumerated(value=EnumType.ORDINAL) * *);

    declare warning : ordinalEnumPersistence() :
        "Please consider using string persistence of enumerated types instead.";
}

这是您将在 Eclipse 中看到的内容: