使用固定值映射JPA中的枚举？

Question

我正在寻找使用JPA映射枚举的不同方法。我特别想设置每个枚举条目的整数值，并只保存整数值。

@Entity
@Table(name = "AUTHORITY_")
public class Authority implements Serializable {

  public enum Right {
      READ(100), WRITE(200), EDITOR (300);

      private int value;

      Right(int value) { this.value = value; }

      public int getValue() { return value; }
  };

  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  @Column(name = "AUTHORITY_ID")
  private Long id;

  // the enum to map : 
  private Right right;
}

一个简单的解决方案是使用枚举注释和EnumType.ORDINAL：

@Column(name = "RIGHT")
@Enumerated(EnumType.ORDINAL)
private Right right;

但是在这种情况下，JPA映射枚举索引（0,1,2）而不是我想要的值（100,200,300）。

我找到的两个解决方案似乎并不简单......

第一个解决方案

解决方案proposed here使用@PrePersist和@PostLoad将枚举转换为其他字段，并将枚举字段标记为瞬态：

@Basic
private int intValueForAnEnum;

@PrePersist
void populateDBFields() {
  intValueForAnEnum = right.getValue();
}

@PostLoad
void populateTransientFields() {
  right = Right.valueOf(intValueForAnEnum);
}

第二种解决方案

第二个解决方案proposed here提出了一个通用的转换对象，但仍然看起来很重，并且面向hibernate（Java EE中似乎不存在@Type）：

@Type(
    type = "org.appfuse.tutorial.commons.hibernate.GenericEnumUserType",
    parameters = {
            @Parameter(
                name  = "enumClass",                      
                value = "Authority$Right"),
            @Parameter(
                name  = "identifierMethod",
                value = "toInt"),
            @Parameter(
                name  = "valueOfMethod",
                value = "fromInt")
            }
)

还有其他解决方案吗？

我有几个想法，但我不知道它们是否存在于JPA中：

• 在加载和保存权限对象时使用权限类的权限成员的setter和getter方法
• 一个相同的想法是告诉JPA将enum转换为int和int转换为enum的Right enum的方法
• 因为我使用Spring，有没有办法告诉JPA使用特定的转换器（RightEditor）？

Answer 1

对于早于JPA 2.1的版本，JPA只提供两种方式来处理枚举，name或ordinal。标准JPA不支持自定义类型。所以：

• 如果要进行自定义类型转换，则必须使用提供程序扩展（使用Hibernate UserType，EclipseLink Converter等）。 （第二种解决方案）。 〜或〜
• 你必须使用@PrePersist和@PostLoad技巧（第一个解决方案）。 〜或〜
• 注释getter和setter获取并返回int值〜或〜
• 在实体级别使用整数属性，并在getter和setter中执行转换。

我将说明最新的选项（这是一个基本的实现，根据需要进行调整）：

@Entity
@Table(name = "AUTHORITY_")
public class Authority implements Serializable {

    public enum Right {
        READ(100), WRITE(200), EDITOR (300);

        private int value;

        Right(int value) { this.value = value; }    

        public int getValue() { return value; }

        public static Right parse(int id) {
            Right right = null; // Default
            for (Right item : Right.values()) {
                if (item.getValue()==id) {
                    right = item;
                    break;
                }
            }
            return right;
        }

    };

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "AUTHORITY_ID")
    private Long id;

    @Column(name = "RIGHT_ID")
    private int rightId;

    public Right getRight () {
        return Right.parse(this.rightId);
    }

    public void setRight(Right right) {
        this.rightId = right.getValue();
    }

}

Answer 2

现在可以使用JPA 2.1：

@Column(name = "RIGHT")
@Enumerated(EnumType.STRING)
private Right right;

进一步详情：

• http://java.dzone.com/articles/mapping-enums-done-right
• http://www.thoughts-on-java.org/jpa-21-how-to-implement-type-converter/

Answer 3

最好的方法是将唯一ID映射到每个枚举类型，从而避免ORDINAL和STRING的陷阱。请参阅此post，其中概述了映射枚举的5种方法。

取自上面的链接：

<强> 1和2。使用@Enumerated

目前有两种方法可以使用@Enumerated注释在JPA实体中映射枚举。不幸的是，EnumType.STRING和EnumType.ORDINAL都有其局限性。

如果使用EnumType.String，则重命名其中一个枚举类型将导致枚举值与数据库中保存的值不同步。如果使用EnumType.ORDINAL，则删除或重新排序枚举中的类型将导致数据库中保存的值映射到错误的枚举类型。

这两个选项都很脆弱。如果在不执行数据库迁移的情况下修改枚举，则可能会破坏数据的完整性。

第3。生命周期回调

可能的解决方案是使用JPA生命周期回调注释，@ PrePersist和@PostLoad。这感觉非常难看，因为您现在在实体中有两个变量。一个映射存储在数据库中的值，另一个映射实际的枚举。

<强> 4。将唯一ID映射到每个枚举类型

首选解决方案是将枚举映射到枚举中定义的固定值或ID。映射到预定义的固定值使您的代码更加健壮。对枚举类型顺序的任何修改或名称的重构都不会造成任何不利影响。

<强> 5。使用Java EE7 @Convert

如果您使用的是JPA 2.1，则可以选择使用新的@Convert注释。这需要创建一个使用@Converter注释的转换器类，您可以在其中定义为每个枚举类型保存到数据库中的值。在您的实体中，您将使用@Convert注释您的枚举。

我的偏好:(第4名）

我更喜欢在enum中定义我的ID以反对使用转换器，这是一个很好的封装。只有枚举类型应该知道它的ID，并且只有实体应该知道它如何将枚举映射到数据库。

请参阅原始post以获取代码示例。

Answer 4

从JPA 2.1开始，您可以使用AttributeConverter。

创建一个枚举类，如下所示：

public enum NodeType {

    ROOT("root-node"),
    BRANCH("branch-node"),
    LEAF("leaf-node");

    private final String code;

    private NodeType(String code) {
        this.code = code;
    }

    public String getCode() {
        return code;
    }
}

并创建一个这样的转换器：

import javax.persistence.AttributeConverter;
import javax.persistence.Converter;

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

    @Override
    public String convertToDatabaseColumn(NodeType nodeType) {
        return nodeType.getCode();
    }

    @Override
    public NodeType convertToEntityAttribute(String dbData) {
        for (NodeType nodeType : values()) {
            if (nodeType.getCode().equals(dbData)) {
                return nodeType;
            }
        }

        throw new IllegalArgumentException("Unknown database value:" + dbData);
    }
}

在您需要的实体上：

@Column(name = "node_type_code")

@Converter(autoApply = true)的运气可能因容器而异，但经过测试可用于Wildfly 8.1.0。如果它不起作用，您可以在实体类列上添加@Convert(converter = NodeTypeConverter.class)。

Answer 5

我认为问题在于，JPA从未接受过这样的想法，即我们可能已经有一个复杂的预先存在的Schema。

我认为这有两个主要缺点，特别是Enum：

1. 使用name（）和ordinal（）的限制。为什么不用@Id标记一个getter，就像我们用@Entity做的那样？
2. Enum通常在数据库中表示允许与各种元数据相关联，包括正确的名称，描述性名称，可能具有本地化的东西等。我们需要易于使用Enum并结合实体的灵活性

帮助我的事业并在JPA_SPEC-47

上投票

这不比使用@Converter解决问题更优雅吗？

// Note: this code won't work!!
// it is just a sample of how I *would* want it to work!
@Enumerated
public enum Language {
  ENGLISH_US("en-US"),
  ENGLISH_BRITISH("en-BR"),
  FRENCH("fr"),
  FRENCH_CANADIAN("fr-CA");
  @ID
  private String code;
  @Column(name="DESCRIPTION")
  private String description;

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

  public String getCode() {
    return code;
  }

  public String getDescription() {
    return description;
  }
}

Answer 6

可能关闭Pascal的相关代码

@Entity
@Table(name = "AUTHORITY_")
public class Authority implements Serializable {

    public enum Right {
        READ(100), WRITE(200), EDITOR(300);

        private Integer value;

        private Right(Integer value) {
            this.value = value;
        }

        // Reverse lookup Right for getting a Key from it's values
        private static final Map<Integer, Right> lookup = new HashMap<Integer, Right>();
        static {
            for (Right item : Right.values())
                lookup.put(item.getValue(), item);
        }

        public Integer getValue() {
            return value;
        }

        public static Right getKey(Integer value) {
            return lookup.get(value);
        }

    };

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "AUTHORITY_ID")
    private Long id;

    @Column(name = "RIGHT_ID")
    private Integer rightId;

    public Right getRight() {
        return Right.getKey(this.rightId);
    }

    public void setRight(Right right) {
        this.rightId = right.getValue();
    }

}

Answer 7

我会做下面的事情：

在自己的文件中声明枚举：

public enum RightEnum {
      READ(100), WRITE(200), EDITOR (300);

      private int value;

      private RightEnum (int value) { this.value = value; }


      @Override
      public static Etapa valueOf(Integer value){
           for( RightEnum r : RightEnum .values() ){
              if ( r.getValue().equals(value))
                 return r;
           }
           return null;//or throw exception
     }

      public int getValue() { return value; }


}

声明一个名为Right

的新JPA实体

@Entity
public class Right{
    @Id
    private Integer id;
    //FIElDS

    // constructor
    public Right(RightEnum rightEnum){
          this.id = rightEnum.getValue();
    }

    public Right getInstance(RightEnum rightEnum){
          return new Right(rightEnum);
    }


}

你还需要一个转换器来接收这个值（JPA 2.1只有一个问题我不会在这里讨论，这些枚举是直接使用转换器持久化的，所以它只是一个单向的道路）

import mypackage.RightEnum;
import javax.persistence.AttributeConverter;
import javax.persistence.Converter;

/**
 * 
 * 
 */
@Converter(autoApply = true)
public class RightEnumConverter implements AttributeConverter<RightEnum, Integer>{

    @Override //this method shoudn´t be used, but I implemented anyway, just in case
    public Integer convertToDatabaseColumn(RightEnum attribute) {
        return attribute.getValue();
    }

    @Override
    public RightEnum convertToEntityAttribute(Integer dbData) {
        return RightEnum.valueOf(dbData);
    }

}

管理局实体：

@Entity
@Table(name = "AUTHORITY_")
public class Authority implements Serializable {


  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  @Column(name = "AUTHORITY_ID")
  private Long id;

  // the **Entity** to map : 
  private Right right;

  // the **Enum** to map (not to be persisted or updated) : 
  @Column(name="COLUMN1", insertable = false, updatable = false)
  @Convert(converter = RightEnumConverter.class)
  private RightEnum rightEnum;

}

通过这种方式，您无法直接设置枚举字段。但是，您可以使用

在权限中设置“正确”字段

autorithy.setRight( Right.getInstance( RightEnum.READ ) );//for example

如果你需要比较，你可以使用：

authority.getRight().equals( RightEnum.READ ); //for example

我觉得这很酷。这不完全正确，因为转换器不打算与枚举一起使用。实际上，文档说从不将它用于此目的，您应该使用@Enumerated注释。问题是只有两种枚举类型：ORDINAL或STRING，但ORDINAL很棘手且不安全。

---

然而，如果它不能满足你，你可以做一些更简单（或更简单）的事情。

我们来看看。

RightEnum：

public enum RightEnum {
      READ(100), WRITE(200), EDITOR (300);

      private int value;

      private RightEnum (int value) { 
            try {
                  this.value= value;
                  final Field field = this.getClass().getSuperclass().getDeclaredField("ordinal");
                  field.setAccessible(true);
                  field.set(this, value);
             } catch (Exception e) {//or use more multicatch if you use JDK 1.7+
                  throw new RuntimeException(e);
            }
      }


      @Override
      public static Etapa valueOf(Integer value){
           for( RightEnum r : RightEnum .values() ){
              if ( r.getValue().equals(value))
                 return r;
           }
           return null;//or throw exception
     }

      public int getValue() { return value; }


}

和管理局实体

@Entity
@Table(name = "AUTHORITY_")
public class Authority implements Serializable {


  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  @Column(name = "AUTHORITY_ID")
  private Long id;


  // the **Enum** to map (to be persisted or updated) : 
  @Column(name="COLUMN1")
  @Enumerated(EnumType.ORDINAL)
  private RightEnum rightEnum;

}

在第二个想法中，它不是一个完美的情况，因为我们破解了序数属性，但它的编码要小得多。

我认为JPA规范应该包含EnumType.ID，其中枚举值字段应该使用某种@EnumId注释进行注释。

Answer 8

public enum Gender{ 
    MALE, FEMALE 
}



@Entity
@Table( name="clienti" )
public class Cliente implements Serializable {
...

// **1 case** - If database column type is number (integer) 
// (some time for better search performance)  -> we should use 
// EnumType.ORDINAL as @O.Badr noticed. e.g. inserted number will
// index of constant starting from 0... in our example for MALE - 0, FEMALE - 1.
// **Possible issue (advice)**: you have to add the new values at the end of
// your enum, in order to keep the ordinal correct for future values.

@Enumerated(EnumType.ORDINAL)
    private Gender gender;


// **2 case** - If database column type is character (varchar) 
// and you want to save it as String constant then ->

@Enumerated(EnumType.STRING)
    private Gender gender;

...
}

// in all case on code level you will interact with defined 
// type of Enum constant but in Database level

第一种情况（EnumType.ORDINAL）

╔════╦══════════════╦════════╗
║ ID ║    NAME      ║ GENDER ║
╠════╬══════════════╬════════╣
║  1 ║ Jeff Atwood  ║    0   ║
║  2 ║ Geoff Dalgas ║    0   ║
║  3 ║Jarrod Jesica ║    1   ║
║  4 ║ Joel Lucy    ║    1   ║
╚════╩══════════════╩════════╝

第二种情况（EnumType.STRING）

╔════╦══════════════╦════════╗
║ ID ║    NAME      ║ GENDER ║
╠════╬══════════════╬════════╣
║  1 ║ Jeff Atwood  ║  MALE  ║
║  2 ║ Geoff Dalgas ║  MALE  ║
║  3 ║Jarrod Jesica ║ FEMALE ║
║  4 ║ Joel Lucy    ║ FEMALE ║
╚════╩══════════════╩════════╝

Answer 9

下面是我自己解决这种Enum JPA映射的解决方案。

第1步-编写以下接口，以用于要映射到db列的所有枚举：

public interface IDbValue<T extends java.io.Serializable> {

    T getDbVal();

}

第2步-实施自定义通用JPA转换器，如下所示：

import javax.persistence.AttributeConverter;

public abstract class EnumDbValueConverter<T extends java.io.Serializable, E extends Enum<E> & IDbValue<T>>
        implements AttributeConverter<E, T> {

    private final Class<E> clazz;

    public EnumDbValueConverter(Class<E> clazz){
        this.clazz = clazz;
    }

    @Override
    public T convertToDatabaseColumn(E attribute) {
        if (attribute == null) {
            return null;
        }
        return attribute.getDbVal();
    }

    @Override
    public E convertToEntityAttribute(T dbData) {
        if (dbData == null) {
            return null;
        }
        for (E e : clazz.getEnumConstants()) {
            if (dbData.equals(e.getDbVal())) {
                return e;
            }
        }
        // handle error as you prefer, for example, using slf4j:
        // log.error("Unable to convert {} to enum {}.", dbData, clazz.getCanonicalName());
        return null;
    }

}

此类通过使用枚举E上的T将枚举值String转换为类型getDbVal()（例如E）的数据库字段，反之亦然。

步骤3 -让原始枚举实现我们在步骤1中定义的接口：

public enum Right implements IDbValue<Integer> {
    READ(100), WRITE(200), EDITOR (300);

    private final Integer dbVal;

    private Right(Integer dbVal) {
        this.dbVal = dbVal;
    }

    @Override
    public Integer getDbVal() {
        return dbVal;
    }
}

步骤4 -将步骤2的转换器扩展为步骤3的Right枚举。

public class RightConverter extends EnumDbValueConverter<Integer, Right> {
    public RightConverter() {
        super(Right.class);
    }
}

步骤5 -最后一步是对实体中的字段进行注释，如下所示：

@Column(name = "RIGHT")
@Convert(converter = RightConverter.class)
private Right right;

结论

恕我直言，如果您有许多枚举要映射，并且您想使用枚举本身的特定字段作为映射值，这是最干净，最优雅的解决方案。

对于项目中需要类似映射逻辑的所有其他枚举，只需重复步骤3至5，即：

• 在您的枚举上实现接口IDbValue；
• 仅用3行代码扩展EnumDbValueConverter（您也可以在实体内执行此操作，以避免创建单独的类）；
• 使用@Convert包中的javax.persistence注释枚举属性。

希望这会有所帮助。