PostgreSQL enum 和 Java enum 之间的 Hibernate 映射

您可以使用 Hibernate Types 依赖项通过 Maven Central 获取这些类型：

<dependency>
    <groupId>com.vladmihalcea</groupId>
    <artifactId>hibernate-types-52</artifactId>
    <version>${hibernate-types.version}</version>
</dependency>

如果您使用以下自定义类型轻松地将 Java Enum 映射到 PostgreSQL Enum 列类型：

public class PostgreSQLEnumType extends org.hibernate.type.EnumType {
     
    public void nullSafeSet(
            PreparedStatement st, 
            Object value, 
            int index, 
            SharedSessionContractImplementor session) 
        throws HibernateException, SQLException {
        if(value == null) {
            st.setNull( index, Types.OTHER );
        }
        else {
            st.setObject( 
                index, 
                value.toString(), 
                Types.OTHER 
            );
        }
    }
}

要使用它，您需要使用Hibernate注释来注释字段，如以下示例所示：@Type

@Entity(name = "Post")
@Table(name = "post")
@TypeDef(
    name = "pgsql_enum",
    typeClass = PostgreSQLEnumType.class
)
public static class Post {
 
    @Id
    private Long id;
 
    private String title;
 
    @Enumerated(EnumType.STRING)
    @Column(columnDefinition = "post_status_info")
    @Type( type = "pgsql_enum" )
    private PostStatus status;
 
    //Getters and setters omitted for brevity
}

此映射假设您在 PostgreSQL 中具有枚举类型：post_status_info

CREATE TYPE post_status_info AS ENUM (
    'PENDING', 
    'APPROVED', 
    'SPAM'
)

就是这样，它就像一个魅力。这是GitHub上的一个测试，可以证明这一点。

总部

正确别名并使用限定的属性名称是解决方案的第一部分。

<query name="getAllMoves">
    <![CDATA[
        from Move as move
        where move.directionToMove = :direction
    ]]>
</query>

休眠映射

@Enumerated(EnumType.STRING)仍然不起作用，所以需要一个习惯。关键是要正确覆盖这个答案中 https://stackoverflow.com/a/7614642/1090474 和来自Web的类似实现。UserTypenullSafeSet

@Override
public void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException {
    if (value == null) {
        st.setNull(index, Types.VARCHAR);
    }
    else {
        st.setObject(index, ((Enum) value).name(), Types.OTHER);
    }
}

弯路

implements ParameterizedType不合作：

org.hibernate.MappingException: type is not parameterized: full.path.to.PGEnumUserType

所以我无法像这样注释枚举属性：

@Type(type = "full.path.to.PGEnumUserType",
        parameters = {
                @Parameter(name = "enumClass", value = "full.path.to.Move$Direction")
        }
)

相反，我这样声明了类：

public class PGEnumUserType<E extends Enum<E>> implements UserType

使用构造函数：

public PGEnumUserType(Class<E> enumClass) {
    this.enumClass = enumClass;
}

不幸的是，这意味着任何其他类似映射的枚举属性都需要这样的类：

public class HibernateDirectionUserType extends PGEnumUserType<Direction> {
    public HibernateDirectionUserType() {
        super(Direction.class);
    }
}

注解

注释属性，您就完成了。

@Column(name = "directiontomove", nullable = false)
@Type(type = "full.path.to.HibernateDirectionUserType")
private Direction directionToMove;

其他注意事项

• EnhancedUserType以及它想要实现的三种方法

  public String objectToSQLString(Object value)
  public String toXMLString(Object value)
  public String objectToSQLString(Object value)
  

  我看不出任何区别，所以我坚持了下来。implements UserType

• 根据您使用类的方式，可能没有必要通过以两个链接解决方案的方式重写来使其特定于后gres。nullSafeGet
• 如果你愿意放弃postgres枚举，你可以制作列，原始代码将工作，而无需额外的工作。text