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

Question

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

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

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) 不起作用？

Answer 1

实际上你有一个基本问题：没有捕获成员声明的切入点，仅用于 read/write 对成员的访问。我说的分别是 get() 和 set()。因此，您要拦截的是那些。试试这个：

虚拟助手 class 使示例代码编译：

package de.scrum_master.app;

public class MyEnumType {}

Java class 带注释的成员加上演示方面的主要方法：

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 中看到的内容：

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

I want to generate a compile warning for JPA annotations with a given value

java

jpa

aspectj