JPA 中使用枚举作为 ID 的正确方法

本文旨在指导开发者如何在 JPA 实体中使用枚举类型作为主键，并解决可能遇到的数据转换错误。通过详细的代码示例和解释，阐述了使用枚举 `id` 属性作为主键的限制，并提供了使用 `@Enumerated(EnumType.STRING)` 注解的正确配置方法，确保枚举值能正确映射到数据库中的字符串类型字段。

在 JPA (Java Persistence API) 中，将枚举类型作为实体的主键 (ID) 是一种常见的需求，但需要正确配置才能避免潜在的错误。本文将深入探讨如何实现这一目标，并解决可能遇到的 DataIntegrityViolationException 和 NumberFormatException 等问题。

问题分析

直接使用枚举的内部属性（例如 EntityId#id）作为主键通常是不可行的。JPA 期望主键是可持久化的简单类型，而直接使用枚举的属性可能会导致类型转换错误。

解决方案

正确的做法是使用 @Enumerated 注解，并指定 EnumType.STRING，这样 JPA 就会将枚举的字符串值映射到数据库中的相应字段。

示例代码

动态WEB网站中的PHP和MySQL：直观的QuickPro指南第2版

动态WEB网站中的PHP和MySQL详细反映实际程序的需求，仔细地探讨外部数据的验证(例如信用卡卡号的格式)、用户登录以及如何使用模板建立网页的标准外观。动态WEB网站中的PHP和MySQL的内容不仅仅是这些。书中还提到如何串联JavaScript与PHP让用户操作时更快、更方便。还有正确处理用户输入错误的方法，让网站看起来更专业。另外还引入大量来自PEAR外挂函数库的强大功能，对常用的、强大的包

下载

假设我们有以下实体类 Entity 和枚举类 EntityId：

import lombok.Getter;
import lombok.RequiredArgsConstructor;

import javax.persistence.*;

@Entity
public class Entity {

    @Id
    @Enumerated(EnumType.STRING)
    @Column(name = "id")
    private EntityId id;

    // 其他属性

    public EntityId getId() {
        return id;
    }

    public void setId(EntityId id) {
        this.id = id;
    }

    @RequiredArgsConstructor
    public enum EntityId {

        A("a"),
        B("b"),
        C("c"),
        D("d");

        @Getter
        private final String id;

        @Override
        public String toString() {
            return id; // 确保 toString 方法返回的是字符串值
        }
    }
}

import lombok.Getter;
import lombok.RequiredArgsConstructor;

public enum EntityId {

    A("a"),
    B("b"),
    C("c"),
    D("d");

    @Getter
    private final String id;

    EntityId(String id) {
        this.id = id;
    }

    @Override
    public String toString() {
        return id; // 确保 toString 方法返回的是字符串值
    }
}

代码解释

• @Id: 声明 id 字段为主键。
• @Enumerated(EnumType.STRING): 指示 JPA 将 EntityId 枚举以字符串的形式存储在数据库中。 EnumType.STRING 确保使用枚举的名称（这里我们重写了toString方法，使其返回id属性的值）进行持久化，而不是枚举的序号。
• @Column(name = "id"): 指定数据库表中对应的列名为 id。

Repository 定义

import org.springframework.data.jpa.repository.JpaRepository;

public interface EntityRepository extends JpaRepository {
}

注意事项

• toString() 方法: 确保枚举类中的 toString() 方法返回的是枚举的字符串值。如果没有重写 toString() 方法，默认情况下会返回枚举常量的名称（例如 "A", "B", "C", "D"）。如果数据库中存储的是 "a", "b", "c", "d"，则需要重写 toString() 方法。
• 数据库字段类型: 确保数据库中 id 列的类型是字符串类型（例如 VARCHAR）。
• 枚举的不可变性: 枚举是单例且不可变的值。为了使示例工作，必须有一个setter方法来设置枚举值。

总结

在 JPA 中使用枚举作为 ID 时，应该使用 @Enumerated(EnumType.STRING) 注解，并确保枚举的字符串值与数据库中的相应字段匹配。避免直接使用枚举的内部属性作为主键，以防止类型转换错误。同时，确保数据库字段类型与枚举的字符串值类型一致。通过以上步骤，可以成功地将枚举类型作为 JPA 实体的主键，并避免潜在的错误。