如何在 JPA 中使用枚举

Question

我有一个电影租赁系统的现有数据库。 每部电影都有一个评级属性。 在 SQL 中，他们使用约束来限制该属性的允许值。

CONSTRAINT film_rating_check CHECK 
    ((((((((rating)::text = ''::text) OR 
          ((rating)::text = 'G'::text)) OR 
          ((rating)::text = 'PG'::text)) OR 
          ((rating)::text = 'PG-13'::text)) OR 
          ((rating)::text = 'R'::text)) OR 
          ((rating)::text = 'NC-17'::text)))

我认为使用 Java 枚举将约束映射到对象世界会很好。 但由于“PG-13”和“NC-17”中的特殊字符，不可能简单地取允许的值。 所以我实现了以下枚举：

public enum Rating {

    UNRATED ( "" ),
    G ( "G" ), 
    PG ( "PG" ),
    PG13 ( "PG-13" ),
    R ( "R" ),
    NC17 ( "NC-17" );

    private String rating;

    private Rating(String rating) {
        this.rating = rating;
    }

    @Override
    public String toString() {
        return rating;
    }
}

@Entity
public class Film {
    ..
    @Enumerated(EnumType.STRING)
    private Rating rating;
    ..

使用 toString() 方法，方向枚举 -> 字符串工作正常，但字符串 -> 枚举不起作用。 我得到以下异常：

[TopLink警告]：2008.12.09 01:30:57.434--ServerSession(4729123)--异常 [TOPLINK-116]（Oracle TopLink Essentials - 2.0.1（构建 b09d-fcs (12/06/2007)）： oracle.toplink.essentials.exceptions.DescriptorException 异常 说明：没有为 [NC-17] 中的值提供转换值。 字段[电影评级]。 映射： oracle.toplink.essentials.mappings.DirectToFieldMapping[评级-->FILM.RATING] 描述符：RelationalDescriptor(de.fhw.nsdb.entities.Film --> [数据库表（FILM）]）

欢呼

蒂莫

Answer 1

您是否尝试过存储序数值？ 如果您没有与该值关联的字符串，则存储字符串值可以正常工作：

@Enumerated(EnumType.ORDINAL)

Answer 2

这里有一个问题，那就是 JPA 在处理枚举时的能力有限。 对于枚举，您有两种选择：

1. 将它们存储为等于 Enum.ordinal() 的数字，这是一个糟糕的主意（恕我直言）； 或
2. 将它们存储为等于 Enum.name() 的字符串。 注意： 不是您所期望的 toString()，特别是因为 Enum.toString() 的默认行为是返回 name( ）。

我个人认为最好的选择是（2）。

现在您遇到的问题是您定义的值不代表 Java 中的有效实例名称（即使用连字符）。 所以你的选择是：

• 更改你的数据；
• 保留字符串字段并隐式地将它们与对象中的枚举进行转换； 或
• 使用非标准扩展，例如 TypeConverters。

我会按照优先顺序（从第一个到最后一个）执行它们。

有人建议使用 Oracle TopLink 转换器，但您可能正在使用 Toplink Essentials，它是参考 JPA 1.0 实现，它是商业 Oracle Toplink 产品的子集。

作为另一个建议，我强烈建议切换到 EclipseLink。 它是一个比 Toplink Essentials 更完整的实现，Eclipselink 将成为 JPA 2.0 发布时的参考实现（JavaOne 预计将于明年年中发布）。

Answer 3

听起来您需要添加对自定义类型的支持：

Extending OracleAS TopLink to支持自定义类型转换

Answer 4

public enum Rating {

    UNRATED ( "" ),
    G ( "G" ), 
    PG ( "PG" ),
    PG13 ( "PG-13" ),
    R ( "R" ),
    NC17 ( "NC-17" );

    private String rating;

    private static Map<String, Rating> ratings = new HashMap<String, Rating>();
    static {
        for (Rating r : EnumSet.allOf(Rating.class)) {
            ratings.put(r.toString(), r);
        }
    }

    private static Rating getRating(String rating) {
        return ratings.get(rating);
    }

    private Rating(String rating) {
        this.rating = rating;
    }

    @Override
    public String toString() {
        return rating;
    }
}

然而，我不知道如何在带注释的 TopLink 方面进行映射。

Answer 5

我不知道 toplink 的内部结构，但我有根据的猜测如下：它使用 Rating.valueOf(String s) 方法在另一个方向进行映射。 不可能重写 valueOf()，因此您必须遵守 java 的命名约定，以允许正确的 valueOf 方法。

public enum Rating {

    UNRATED,
    G, 
    PG,
    PG_13 ,
    R ,
    NC_17 ;

    public String getRating() {
        return name().replace("_","-");;
    }
}

getRating 产生“人类可读”的评级。 请注意，枚举标识符中不允许使用“-”字符。

当然，您必须将这些值存储在 DB 中作为 NC_17。

Answer 6

我认为，问题在于，JPA 从未考虑过我们可以拥有一个复杂的预先存在的架构。

我认为，对于 Enum 来说，有两个主要缺点：

1. 使用 name() 和 ordinal() 的限制。 为什么不直接用 @Id 标记 getter，就像我们用 @Entity 做的那样？
2. 枚举通常在数据库中具有表示形式，以允许与各种元数据关联，包括专有名称、描述性名称，可能还有本地化的名称等。我们需要枚举的易用性与实体的灵活性相结合。

帮助我的事业并对 JPA_SPEC-47 进行投票

Answer 7

使用您现有的枚举评级。 您可以使用AttributeCoverter。

@Converter(autoApply = true)
public class RatingConverter implements AttributeConverter<Rating, String> {

    @Override
    public String convertToDatabaseColumn(Rating rating) {
        if (rating == null) {
            return null;
        }
        return rating.toString();
    }

    @Override
    public Rating convertToEntityAttribute(String code) {
        if (code == null) {
            return null;
        }

        return Stream.of(Rating.values())
          .filter(c -> c.toString().equals(code))
          .findFirst()
          .orElseThrow(IllegalArgumentException::new);
    }
}

Answer 8

在 JPA 2.0 中，既不使用 name() 也不使用 ordinal() 来持久化 enum 的方法可以通过包装 Embeddable 类中的 enum。

假设我们有以下 enum，其中 code 值要存储在数据库中：

  public enum ECourseType {
    PACS004("pacs.004"), PACS008("pacs.008");

    private String code;

    ECourseType(String code) {
        this.code = code;
    }

    public String getCode() {
        return code;
    }
}

请注意，无法使用 code 值作为enum的名称，因为它们包含点。 这句话证明了我们提供的解决方法是正确的。

我们可以构建一个不可变类（作为值对象），使用静态方法 from() 包装枚举的 code 值，以从 enum< 构建它/code>，如下所示：

@Embeddable
public class CourseType {

private static Map<String, ECourseType> codeToEnumCache = 
Arrays.stream(ECourseType.values())
            .collect(Collectors.toMap( e -> e.getCode(), e -> e));

    private String value;

    private CourseType() {};

    public static CourseType from(ECourseType en) {
        CourseType toReturn = new CourseType();
        toReturn.value = en.getCode();
        return toReturn;
    }

    public ECourseType getEnum() {
        return codeToEnumCache.get(value);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass() ) return false;

        CourseType that = (CourseType) o;
        return Objects.equals(value, that.value);
    }

    @Override
    public int hashCode() {
        return Objects.hash(value);
    }
}

编写正确的 equals() 和 hashcode() 对于确保此类的“值对象”目标非常重要。

如果需要，可以添加 CourseType 和 ECourseType 之间的等价方法（但不能与 equals() 混合）：

public boolean isEquiv(ECourseType eCourseType) {
    return Objects.equals(eCourseType, getEnum());
}

该类现在可以嵌入到实体类中：

    public class Course {
    
    @Id
    @GeneratedValue
    @Column(name = "COU_ID")
    private Long pk;

    @Basic
    @Column(name = "COURSE_NAME")
    private String name;

    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "value", column = @Column(name = "COURSE_TYPE")),
    })
    private CourseType type;

    public void setType(CourseType type) {
        this.type = type;
    }

    public void setType(ECourseType type) {
        this.type = CourseType.from(type);
    }

}

请注意 setter setType(ECourseType type)。 可以添加类似的 getter 来获取 type 作为 ECourseType。

使用此建模，hibernate 生成（对于 H2 db）以下 SQL 表：

CREATE TABLE "PUBLIC"."COU_COURSE"
(
   COU_ID bigint PRIMARY KEY NOT NULL,
   COURSE_NAME varchar(255),
   COURSE_TYPE varchar(255)
)
;

枚举的“code”值将存储在 COURSE_TYPE 中。

可以使用像这样简单的查询来搜索Course实体：

    public List<Course> findByType(CourseType type) {
    manager.clear();
    Query query = manager.createQuery("from Course c where c.type = :type");
    query.setParameter("type", type);
    return (List<Course>) query.getResultList();
}

结论：

这展示了如何既不使用name也不使用name来持久化枚举ordinal 但确保依赖它的实体的干净建模。
当 db 中存储的值不符合枚举名称和序号的 java 语法时，这对于遗留系统特别有用。
它还允许重构枚举名称，而无需更改数据库中的值。

Answer 9

对此，

public String getRating{  
   return rating.toString();
}

pubic void setRating(String rating){  
   //parse rating string to rating enum
   //JPA will use this getter to set the values when getting data from DB   
}  

@Transient  
public Rating getRatingValue(){  
   return rating;
}

@Transient  
public Rating setRatingValue(Rating rating){  
   this.rating = rating;
}

您在数据库和实体上都将评级用作字符串，但对其他所有内容都使用枚举。

Answer 10

使用这个注释

@Column(columnDefinition="ENUM('User', 'Admin')")

Answer 11

枚举
公共枚举 ParentalControlLevelsEnum {
U（“U”），PG（“PG”），_12（“12”），_15（“15”），_18（“18”）；

private final String value;

ParentalControlLevelsEnum(final String value) {
    this.value = value;
}

public String getValue() {
    return value;
}

public static ParentalControlLevelsEnum fromString(final String value) {
    for (ParentalControlLevelsEnum level : ParentalControlLevelsEnum.values()) {
        if (level.getValue().equalsIgnoreCase(value)) {
            return level;
        }
    }
    return null;
}

}

比较 -> 枚举

公共类RatingComparator 实现Comparator {

public int compare(final ParentalControlLevelsEnum o1, final ParentalControlLevelsEnum o2) {
    if (o1.ordinal() < o2.ordinal()) {
        return -1;
    } else {
        return 1;
    }
}

}

Answer 12

解决！！！
我在哪里找到了答案： http://programming.itags.org/development-tools/65254/

简而言之，转换查找枚举的名称，而不是属性“评级”的值。
在您的情况下：如果您的数据库值中有“NC-17”，则您的枚举中需要有：

enum Rating {
(...)
NC-17（“NC-17”）；
(...)