JPA向PostgreSQL保存枚举时类型不匹配的原因及解决建议

问题描述 #

我定义了如下JPA User实体类：

@Entity
@Table(name = "user_account")
public class User {
    public enum Role {
        CLIENT,
        ADMIN
    }

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

    @Column(name = "username",nullable = false)
    private String username;

    @Column(name = "password", nullable = false)
    private String password;

    @Column(name = "role", nullable = false)
    private Role role;
    //setters and getters
}

通过PostgreSQL语句创建了自定义枚举类型并关联到user_account表的role列：

CREATE TYPE role AS ENUM('CLIENT', 'ADMIN');

我的POST请求体格式如下：

{
  "username": "a",
  "password": "your_strong_password",
  "role": "CLIENT"
}

调用保存方法时触发错误：

org.postgresql.util.PSQLException: ERROR: column "role" is of type role but expression is of type smallint Hint: You will need to rewrite or cast the expression.

错误发生在createUser方法的return语句处：

public User createUser(User user) {
    user.setRole(User.Role.CLIENT.toString()); // 此处存在代码错误
    return userRepository.save(user); // 报错位置
}

我没有使用smallint类型，为什么会出现这个错误？当前实现方式有误的话，请提供替代方案。

错误原因分析 #

1. 代码逻辑错误：createUser方法中，user.setRole(User.Role.CLIENT.toString())是错误的——实体类的role字段类型是User.Role枚举，而非String，这行代码会直接导致编译错误（推测是笔误）。
2. JPA默认枚举映射策略导致类型不匹配：JPA默认使用EnumType.ORDINAL作为枚举映射策略，它会将Java枚举的序号值（比如CLIENT对应0，ADMIN对应1）以smallint类型传递给数据库。但你的数据库role列是自定义枚举类型，不是整数类型，因此数据库抛出类型不匹配的错误。

解决方案 #

1. 修正代码中的错误 #

首先将createUser方法中的错误赋值语句改为枚举实例赋值：

public User createUser(User user) {
    user.setRole(User.Role.CLIENT); // 直接赋值枚举实例
    return userRepository.save(user);
}

2. 配置JPA枚举映射策略 #

根据需求选择以下两种方式之一，确保JPA将枚举正确映射到PostgreSQL的自定义枚举类型：

方式一：使用@Enumerated(EnumType.STRING)

该注解会将Java枚举的名称字符串（如"CLIENT"、"ADMIN"）传递给数据库，PostgreSQL会自动将匹配的字符串转换为对应的自定义枚举值。只需修改实体类的role字段：

@Column(name = "role", nullable = false)
@Enumerated(EnumType.STRING)
private Role role;

注意：确保Java枚举的名称与PostgreSQL枚举的取值完全一致（大小写敏感）。

方式二：使用Hibernate的@Type注解（精准匹配PostgreSQL枚举）

如果需要直接映射PostgreSQL的自定义枚举类型，可以使用Hibernate提供的PostgresEnumType，需确保项目依赖了Hibernate相关包。修改实体类的role字段：

import org.hibernate.annotations.Type;
import org.hibernate.type.PostgresEnumType;

// ...

@Column(name = "role", nullable = false)
@Type(type = "org.hibernate.type.PostgresEnumType")
private Role role;

内容的提问来源于stack exchange，提问作者benwl