首页 > 资讯 > 后端开发 > Python >Spring Data JPA注解Entity使用示例详解

804

分享到

Spring Data JPA注解Entity使用示例详解

2024-04-02 19:04:59 804人浏览独家记忆

Python 官方文档：入门教程 => 点击学习

摘要

目录1、JPA协议中关于Entity的相关规定需要注意的是：2、常用注解2.1 JPA支持的注解2.2 常用注解3、联合主键3.1 @IdClass3.2 @Embeddable与@

1、JPA协议中关于Entity的相关规定

（1）实体是直接进行数据库持久化操作的领域对象（即一个简单的POJO），必须通过@Entity注解进行标示。

（2）实体必须有一个 public 或者 projected的无参数构造方法.

（3）持久化映射的注解可以标示在Entity的字段field上（比较适合使用Lombok的情况），如下所示

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(columnDefinition = "int(11) NOT NULL COMMENT '主键' ")
private Integer id;
@Column(columnDefinition = "varchar(30) DEFAULT '' COMMENT '书名'")
private String bookName;
@Column(columnDefinition = "int(11) DEFAULT 0  COMMENT '数量'")
private Integer amount;

除此之外，也可以将持久化注解运用在Entity里面的get/set方法上，通过我们放在get方法中，如下所示：
需要注意的是：在实体类get方法中加注解时，必须保证set方法的存在，否则会报错

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(columnDefinition = "int(11) NOT NULL COMMENT '主键' ")
public Integer getId() {
    return id;
}
@Column(columnDefinition = "varchar(30) DEFAULT '' COMMENT '宠物名'")
public String getName() {
    return name;
}
@Column(columnDefinition = "int(11) DEFAULT NULL COMMENT '年龄'")
public Integer getAge() {
    return age;
}

需要注意的是：

在同一个Entity里面只能有一种方式生效，也就是说注解要么全部写在field上面，要么就全部写在get/set方法上

只要是在@Entity的实体里面被注解标注的字段，都会被映射到数据库中，除了使用@Transient注解的字段之外。
实体里面必须有一个主键。主键表示的字段可以是单个字段，也可以是复合主键字段。

2、常用注解

2.1 JPA支持的注解

2.2 常用注解

@Entity必填项。用于定义对象将会成为被JPA管理的实体,将字段映射到指定的数据库表中,使用起来很简单,直接用在实体类上面即可。

 @Target(TYPE) // 表示此注解只能用在class上面
 @Retention(RUNTIME)
 public @interface Entity {
    // 默认是实体类的名字
    String name() default "";
 }

@Table非必填项。用于指定数据库的表名，表示此实体对应的数据库里面的表名。默认表名和entity名字一样

  @Target(TYPE)  // 表示此注解只能用在class上面
  @Retention(RUNTIME)
  public @interface Table {
      // 表的名字,默认表名和entity名字一样
      String name() default "";
      // 表的目录
      String catalog() default "";
      // 此表所在schema
      String schema() default "";
      // 唯一性约束，在创建表的时候有用，表创建好之后后面就不需要了
      UniqueConstraint[] uniqueConstraints() default {};
      // 索引,在创建表的时候使用,表创建之后后面就不需要了
      Index[] indexes() default {};
  }

  // 单一字段唯一性约束
  uniqueConstraints = {@UniqueConstraint(name = "unique_age",columnNames = "age")}
  // 联合约束
  uniqueConstraints = {@UniqueConstraint(name = "unique_name",columnNames = {"name","age"})}
  // 索引
  indexes = {@Index(name = "nameIndex",columnList = "name")})

@Access非必填项。用于指定entity里面的注解是写在字段上面，还是get/set方法上面生效。如果默认不填写的情况下，当实体里面的第一个注解出现在字段上或者 get/set方法上面，就以第一次出现的方式为准。

@Target( { TYPE, METHOD, FIELD }) // 表示此注解可以运用在类上（可以指定实体的默认注解生成策略），也可以用在方法上或字段上（表示可以独立设置某一个字段或者方法的生效策略）
@Retention(RUNTIME)
public @interface Access {
    AccessType value();
}
public enum AccessType {
    FIELD,
    PROPERTY
}
@Access(value = AccessType.FIELD)

@Id定义属性为数据库的主键,一个实体里面必须有一个主键，但不一定是这个注解。可以和@GeneratedValue配合使用或成对出现。

@GeneratedValue主键生成策略,如下所示：

public @interface GeneratedValue {
    // Id的生成策略
    GenerationType strategy() default AUTO;
    // 通过Sequences生成Id,常见的是oracle数据库ID生成规则,这个时候需要配合@SequenceGenerator使用
    String generator() default "";
}
// 生成策略
public enum GenerationType { 
    // 通过表产生主键,框架借由表模拟序列产生主键,使用该策略可以使应用更易于数据库移植
    TABLE, 
    // 通过序列产生主键,通过@SequenceGenerator 注解指定序列名,Mysql不支持这种方式
    SEQUENCE, 
    // 采用数据库Id自增长,一般用于mysql数据库
    IDENTITY, 
    // 自动选择合适的策略,是默认选项；
    AUTO
}

@Enumerated对Enum枚举类映射到数据库提供下标和name两种方式,用法就是直接映射在enum枚举类型的字段上。

@Target({METHOD, FIELD}) 
@Retention(RUNTIME)
public @interface Enumerated {
    EnumType value() default ORDINAL;
}
public enum EnumType {
    // 映射枚举字段的下标
    ORDINAL,
    // 映射枚举的Name
    STRING
}

@Basic表示属性是到数据表字段的映射。如果实体的字段上没有任何注解，默认即为@Basic。也就是说默认所有的字段肯定是和数据库进行映射的，并且默认为Eager类型。

public @interface Basic {
    // EAGER 立即记载;LAZY 延迟加载;
    FetchType fetch() default EAGER;
    // 这个字段是否可以为null,默认是true
    boolean optional() default true;
}

@Transient表示非持久化属性。 JPA映射数据库的时候忽略它,与@Basic有相反的作用。

@Column 定义该属性对应数据库中的

public @interface Column {
    // 定义了被标注字段在数据库表中所对应字段的名称；
    String name() default "";
    // 表示该字段是否为唯一标识
    boolean unique() default false;
    // 数据字段是否允许为空,默认为空
    boolean nullable() default true;
    // 表示在使用“INSERT”脚本插入数据时，是否需要插入该字段的值。
    boolean insertable() default true;
    // 表示在使用“UPDATE”脚本插入数据时，是否需要更新该字段的值
    boolean updatable() default true;
    // 表示创建表时，该字段创建的sql语句,一般用于通过Entity生成表定义时使用
    String columnDefinition() default "";
    // 表示当映射多个表时，指定表的表中的字段。默认值为主表的表名。
    String table() default "";
    // 表示字段的长度，当字段的类型为varchar时，该属性才有效，默认为255个字符。
    int length() default 255;
    // 表示数值的总长度
    int precision() default 0;
    // 表示小数点所占的位数，必须和precision搭配使用
    int scale() default 0;
}

3、联合主键

3.1 @IdClass

第一步：新建一个UserInfo类里面的属性是联合主键

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserInfoID implements Serializable {
    private String name;
    private String telephone;
}

第二步：再新建一个UserInfo的实体,采用@IdClass引用联合主键类

@Entity
@Data
@Builder
@IdClass(UserInfoID.class)
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo {
    private Integer ages;
    @Id
    private String name;
    @Id
    private String telephone;
}

第三步：新增一个UserInfoRepo类来做持久化操作

public interface UserInfoRepo extends JpaRepository<UserInfo, UserInfoID> {
}

第四步：测试用例

@Test
public void queryIndex2(){
    userInfoRepo.save(UserInfo.builder()
    .ages(1)
    .name("jack")
    .telephone("123456789").build());
    userInfoRepo.findById(UserInfoID.builder()
            .name("jack")
            .telephone("123456789").build());
}

通过上面例子我们可以发现,我们的表的主键是primary key(name,telephone),而Entity里面不再是一个@Id字段。

执行的SQL如下：

3.2 @Embeddable与@EmbeddedId注解使用

第一步：在上面例子中的UserInfoID里面添加@Embeddable注解

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@Embeddable
public class UserInfoID implements Serializable {
    private String name;
    private String telephone;
}

第二步：在UserInfo类中,删除@IdClass,添加@EmbeddeId注解,如下：

@Entity
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserInfo {
    private Integer ages;
    @EmbeddedId
    private UserInfoID userInfoID;
    @Column(unique = true)
    private String uniqueNumber;
}

第三步：UserInfoRepo保持不变第四步：测试用例

@Test
public void queryIndex(){
    userInfoRepo.save(UserInfo.builder()
            .ages(1)
            .userInfoID(UserInfoID.builder()
                    .name("jack")
                    .telephone("123456789").build()).build());
    userInfoRepo.findById(UserInfoID.builder()
            .name("jack")
            .telephone("123456789").build());
}

执行的SQL如下所示：