强制对枚举使用JPA AttributeConverter

Question

我们正试图找到一种使用JPA来持久化枚举的可靠方法。使用@枚举的常见方法是不可取的，因为在重构时破坏映射太容易了。每个枚举都应该有一个单独的数据库值，它可以不同于枚举名称/顺序，这样您就可以安全地更改枚举的名称或内部顺序（例如序数值），而不会破坏任何东西。例如，这篇博客文章有一个如何实现这一目标的示例，但是我们觉得建议的解决方案给代码增加了太多的混乱。我们希望通过使用JPA 2.1中引入的新的属性转换器机制来实现类似的结果。我们有一个接口，每个枚举都应该实现，它定义了一个方法来获取用于在数据库中存储枚举的值。示例：

public interface PersistableEnum {
    String getDatabaseValue();
}

...

public enum SomeEnum implements PersistableEnum {
    FOO("foo"), BAR("bar");

    private String databaseValue;

    private SomeEnum(String databaseValue) {
        this.databaseValue = databaseValue;
    }

    public void getDatabaseValue() {
        return databaseValue;
    }
}

我们还有一个基本转换器，它具有将枚举转换为字符串的逻辑，反之亦然，并为每种枚举类型提供单独的具体转换器类（AFAIK，一个完全通用的枚举转换器是不可能实现的，这一点在本SO答案中也有所说明）。然后，具体的转换器只需调用进行转换的基类，如下所示：

public abstract class EnumConverter<E extends PersistableEnum> {

    protected String toDatabaseValue(E value) {
        // Do the conversion...
    }

    protected E toEntityAttribute(Class<E> enumClass, String value) {
        // Do the conversion...
    }
}

...

@Converter(autoApply = true)
public class SomeEnumConverter extends EnumConverter<SomeEnum> 
            implements AttributeConverter<SomeEnum, String> {

    public String convertToDatabaseColumn(SomeEnum attribute) {
        return toDatabaseValue(attribute);
    }

    public SomeEnum convertToEntityAttribute(String dbData) {
        return toEntityAttribute(SomeEnum.class, dbData);
    }
}

然而，虽然这种方法在技术上非常有效，但仍然存在一个相当严重的陷阱：每当有人创建一个新的枚举类，其值需要存储到数据库中时，该人还需要记住让新的枚举实现PersistableEnum接口，并为其编写一个转换器类。如果没有这一点，枚举将得到持久化，而不会出现问题，但是转换将默认使用@Enumerated（EnumType.ORDINAL），这正是我们想要避免的。我们怎样才能防止这种情况？有没有办法使JPA（在我们的例子中是Hibernate）不默认为任何映射，但如果字段上没有定义@Enumerated，并且找不到该类型的转换器，则抛出异常？或者我们可以创建一个“catch all”转换器，它为所有没有自己特定转换器类的枚举调用，并且总是从那里抛出异常？还是说我们每次都要吸取教训，试着记住额外的步骤？

Answer 1

您需要设置一个默认实体监听器（一个实体监听器，它的回调应用于持久性单元中的所有实体）。在默认实体监听器类中实现@PrePerig方法，并确保所有的ENums都是PeristableEnum的实例。