Spring Data JPA 中如何定义一个简单的实体类？

题目

Spring Data JPA 中如何定义一个简单的实体类？

信息

• 类型：问答
• 难度：⭐

考点

实体类注解, 基本字段映射, 主键生成策略

快速回答

在 Spring Data JPA 中定义实体类需要：

• 使用 @Entity 注解标记类
• 使用 @Id 和 @GeneratedValue 定义主键
• 为每个字段添加映射注解（如 @Column）
• 提供无参构造函数和 getter/setter 方法

1. 核心原理说明

Spring Data JPA 基于 JPA (Java Persistence API) 规范，实体类是与数据库表映射的 Java 对象。JPA 提供注解将 Java 类映射到数据库表，字段映射到列。

2. 代码示例

import javax.persistence.*;

@Entity
@Table(name = "users")  // 指定表名（可选）
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)  // 主键自增
    private Long id;

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

    @Column(nullable = false)
    private String email;

    // 必须有无参构造函数
    public User() {}

    // Getter 和 Setter 方法
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }

    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }

    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

3. 关键注解说明

• @Entity：标记类为 JPA 实体
• @Table：可选，指定表名（默认类名即表名）
• @Id：标记主键字段
• @GeneratedValue：主键生成策略
  • GenerationType.IDENTITY：数据库自增（MySQL AUTO_INCREMENT）
  • GenerationType.SEQUENCE：使用数据库序列（Oracle）
• @Column：字段映射配置
  • name：列名（默认字段名）
  • nullable：是否允许 NULL
  • length：字符串长度限制

4. 最佳实践

• 始终提供无参构造函数（JPA 规范要求）
• 使用包装类型（如 Long, Integer）而非基本类型，以支持 NULL
• 为字符串字段明确指定 length 避免默认值过小
• 推荐使用 @GeneratedValue(strategy = GenerationType.IDENTITY) 简化主键管理

5. 常见错误

• ❌ 缺少无参构造函数导致 Hibernate 初始化失败
• ❌ 忘记 @Id 注解引发 Missing identifier 错误
• ❌ 未配置 @GeneratedValue 导致插入数据时需手动设置主键
• ❌ 在非 String 字段使用 length 属性（仅对 String 有效）

6. 扩展知识

• 审计字段：通过 @CreatedDate、@LastModifiedDate 自动记录时间
• 关联映射：@OneToMany、@ManyToOne 处理表关系
• DTO 投影：使用接口或类投影部分字段，避免查询全部列
• Lombok 简化：结合 @Data、@NoArgsConstructor 减少样板代码（需确保理解原理）