JPA实体中的枚举类型字段

Question

可以在自定义JPA实体中将枚举用作字段（列）的类型吗？ 这是一个例子：

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    private Integer statusId;

    public PaymentStatuses getStatus() {
        return PaymentStatuses.valueOf(statusId);
    }

    public PaymentEntity setStatus(PaymentStatuses status) {
        statusId = status == null ? null : status.getId();
        return this;
    }
}

public enum PaymentStatuses {
    CREATED(1),
    COMPLETED(2),
    CANCELED(3);


    private Integer id;

    private PaymentStatuses(Integer id) {
        this.id = id;
    }

    public Integer getId() {
         return id;
    }

    public static PaymentStatuses valueOf(Integer id) {
        for (PaymentStatuses value : values())
            if (value.getId().equals(id))
                return value;
        return null;
    }
}

上面的代码工作正常，但是使用statusId和getStatus setStatus看起来有点难看。

我想使用PaymentStatuses作为实体中的字段类型。 像这样：

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    private PaymentStatuses status;
}

请告诉我，有可能吗？

Answer 1

使用@Enumerated(EnumType.ORDINAL)将不起作用，因为ORDINAL模式开始为0 。
所以枚举的3个第一值将在DB与表示0 ， 1和2的值。
而枚举中表示它在数据库中的id字段从1变为3 ：

CREATED(1),
COMPLETED(2),
CANCELED(3);

此外，这种方式可以将枚举中定义的元素顺序与在数据库中表示元素的方式相关联。 将来可以添加/删除枚举值，这不是一件好事。

解决您的问题的更好方法是定义一个javax.persistence.AttributeConverter并将其与@Convert 。
因此，创建AttributeConverter实现以指示如何从DB转换为枚举，以及如何将枚举转换为DB。
然后在您的实体中声明PaymentStatuses status ，并通过指定AttributeConverter实现类用@Convert进行注释。

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {
  ...
  @Convert(converter = PaymentStatusesConverter.class)
  private PaymentStatuses status;
  ...    
}

public class PaymentStatusesConverter  implements AttributeConverter<PaymentStatuses, Integer> {

    @Override
    public Integer convertToDatabaseColumn(PaymentStatuses status) {
        return status.getId();
    }

    @Override
    public PaymentStatuses convertToEntityAttribute(Integer status) {
         return PaymentStatuses.valueOf(status); 
    }
}

Answer 2

是的，但是当您保存到数据库时，它将保留枚举值的当前索引（在您的情况下，对于CREATED为0，对于COMPLETED为1，等等），如果您更改枚举值，则会给您带来麻烦。 为了避免这种情况，您可以使用@Enumerated批注，例如：

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    @Enumerated(EnumType.ORDINAL) // There is also EnumType.STRING, or you can define a custom EnumType
    private PaymentStatuses status;
}

Answer 3

如果要将数据存储在数据库中，例如Java枚举名称的名称（ CREATED, COMPLETED, CANCELED ） CREATED, COMPLETED, CANCELED则可以使用@Enumerated(EnumType.STRING) ）。