SpringDataJPA笔记(1)-基础概念和注解

清疚 2022-02-05 04:49 380阅读 0赞

SpringDataJPA的基础概念和注解

#### 一 JPA的介绍 ####

JPA是Java Persistence API的简称，中文名Java持久层API，是JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体对象持久化到数据库中。

Sun引入新的JPA ORM(Object Relational Mapping)规范出于两个原因：其一，简化现有Java EE和Java SE应用开发工作；其二，Sun希望整合ORM技术，实现天下归一。

所以JPA仅仅是一种规范，通过定义通用的接口屏蔽实现层的差异

spirng data jpa是spring提供的一套简化JPA开发的框架，可以理解为 JPA 规范的再次封装抽象

#### 二 Spring Data JPA注解 ####

##### 查询相关注解 #####

**@NoRepositoryBean**

添加了该注解的 repository 接口不会在运行时被创建实例,只会作为其他接口的父接口而被使用

**@Modifying**

（1）可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作。 注意： JPQL 不支持使用 INSERT； 
    （2）在 @Query 注解中编写 JPQL 语句， 但必须使用 @Modifying 进行修饰. 以通知 SpringData， 这是一个 UPDATE 或 DELETE 操作 
    （3）UPDATE 或 DELETE 操作需要使用事务，此时需要定义 Service 层，在 Service 层的方法上添加事务操作； 
    （4）默认情况下， SpringData 的每个方法上有事务， 但都是一个只读事务。 他们不能完成修改操作。

***@query***

*@NamedQuery*

在实体类上使用@NamedQuery

@NamedEntityGraph

解决联表查询是发出的sql语句过多的问题

##### 审计相关注解 #####

@CreatedDate,@CreatedBy,@LastModifiedDate,@LastModifiedBy

表示该字段为创建时间时间字段，在这个实体被insert的时候，会设置值，但是需要设置@EntityListeners(AuditingEntityListener.class)，需要实现AuditorAware接口来返回你需要插入的值

**@CreationTimestamp**

表示该字段为创建时间时间字段

**@UpdateTimestamp**

表示该字段为修改时间时间字段

##### 实体类相关注解 #####

**@Entity**

标注用于实体类声明语句之前，指出该Java 类为实体类，将映射到指定的数据库表。如声明一个实体类 Customer，它将映射到数据库中的 customer 表上

**@Table**

当实体类与其映射的数据库表名不同名时需要使用 @Table 标注说明，该标注与 @Entity 标注并列使用，置于实体类声明语句之前，可写于单独语句行，也可与声明语句同行。
    
    @Table 标注的常用选项是 name，用于指明数据库的表名 @Table标注还有一个两个选项 catalog 和 schema 用于设置表所属的数据库目录或模式，通常为数据库名。
    
    uniqueConstraints 选项用于设置约束条件，通常不须设置

**@MappedSuperclass**

标注为@MappedSuperclass的类将不是一个完整的实体类，他将不会映射到数据库表，但是他的属性都将映射到其子类的数据库字段中
    
    标注为@MappedSuperclass的类不能再标注@Entity或@Table注解，也无需实现序列化接口
    
    但是如果一个标注为@MappedSuperclass的类继承了另外一个实体类或者另外一个同样标注了@MappedSuperclass的类的话，他将可以使用@AttributeOverride或@AttributeOverrides注解重定义其父类(无论是否是实体类)的属性映射到数据库表中的字段。
    
    比如可以重定义字段名或长度等属性，使用@AttributeOverride中的子属性@Column进行具体的定义
    
    注意：对于其父类中标注@Lob注解的属性将不能重载，并且@AttributeOverride里的@Column设置都将不起作用
    
    JPA规范中对@Lob注解并没有说明不能同时标注@Column注解，但是在实际使用中Hibernate JPA不支持这中标注方式

**@Id**

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。 @Id标注也可置于属性的getter方法之前。

**@GeneratedValue**

@GeneratedValue 用于标注主键的生成策略，通过 strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。 在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：
    
    IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；
    
    AUTO： JPA自动选择合适的策略，是默认选项；
    
    SEQUENCE：通过序列产生主键，通过 @SequenceGenerator 注解指定序列名，MySql 不支持这种方式
    
    TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

@TableGenerator

TableGenerator定义一个主键值生成器，在Id这个元数据的generate＝TABLE时，generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义
    
    生成器是为多个实体类提供连续的ID值的表，每一行为一个类提供ID值，ID值通常是整数
    
    元数据属性说明：
    
     name:生成器的唯一名字，可以被Id元数据使用。 
     table:生成器用来存储id值的Table定义。 
     pkColumnName:生成器表的主键名称。 
     valueColumnName:生成器表的ID值的列名称。 
     pkColumnValue:生成器表中的一行数据的主键值。 
     initialValue:id值的初始值。 
     allocationSize:id值的增量。

@Basic

@Basic 表示一个简单的属性到数据库表的字段的映射,对于没有任何标注的 getXxxx() 方法,默认即为
    
    @Basic fetch: 表示该属性的读取策略,有 EAGER 和 LAZY 两种,分别表示主支抓取和延迟加载,默认为 EAGER.
    
    optional:表示该属性是否允许为null, 默认为true

**@Column**

当实体的属性与其映射的数据库表的列不同名时需要使用@Column 标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。
    
    @Column 标注的常用属性是 name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique 、nullable、length 等。
    
    @Column 标注的 columnDefinition 属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型.
    
    @Column标注也可置于属性的getter方法之前

@Transient

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.
    如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic

**@Temporal**

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision). 而在数据库中,表示 Date 类型的数据有 DATE, TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者 兼备).

**@Where**

在互联网项目中，通常删除都不是物理删除，而是逻辑删除。那么在展示数据的时候需要过滤掉已删除的数据。而@Where 注解可以说就是为此而设计的。

@SecondaryTable

一个entity class可以映射到多表，SecondaryTable用来定义单个从表的名字，主键名字等属性。

@SecondaryTables

当一个entity class映射到一个主表和多个从表时，用SecondaryTables来定义各个从表的属性。

@PrimaryKeyJoinColumn

在三种情况下会用到PrimaryKeyJoinColumn。 
     继承。 
     entity class映射到一个或多个从表。从表根据主表的主键列（列名为referencedColumnName值的列），建立一个类型一样的主键列，列名由name属性定义。 
    
     one2one关系，关系维护端的主键作为外键指向关系被维护端的主键，不再新建一个外键列
    
    元数据属性说明： 
     name:列名。 
     referencedColumnName:该列引用列的列名 
     columnDefinition: 定义建表时创建此列的DDL

@PrimaryKeyJoinColumns

如果entity class使用了复合主键，指定单个PrimaryKeyJoinColumn不能满足要求时，可以用PrimaryKeyJoinColumns来定义多个PrimaryKeyJoinColumn

##### 多表关联的注解 #####

@OneToOne,@ManyToOne,@OneToMany,@ManyToMany

一对一的关联,多对一的关联,一对多的关联,多对多的关联

@JoinTable

JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable，使用JoinTable的默认值
    
    元数据属性说明:
    
     table:这个join table的Table定义。 
     joinColumns:定义指向所有者主表的外键列，数据类型是JoinColumn数组。 
     inverseJoinColumns:定义指向非所有者主表的外键列，数据类型是JoinColumn数组

@JoinColumn

如果在entity class的field上定义了关系（one2one或one2many等），我们通过JoinColumn来定义关系的属性。JoinColumn的大部分属性和Column类似
    
    元数据属性说明： 
     name:列名。 
     referencedColumnName:该列指向列的列名（建表时该列作为外键列指向关系另一端的指定列） 
     unique: 是否唯一 
     nullable: 是否允许为空 
     insertable: 是否允许插入 
     updatable: 是否允许更新 
     columnDefinition: 定义建表时创建此列的DDL 
     secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字

@JoinColumns

如果在entity class的field上定义了关系（one2one或one2many等），并且关系存在多个JoinColumn，用JoinColumns定义多个JoinColumn的属性

@IdClass

当entity class使用复合主键时，需要定义一个类作为id class。 
    id class必须符合以下要求: 
    类必须声明为public，并提供一个声明为public的空构造函数。 
    必须实现Serializable接口，覆写 equals() 和 hashCode()方法。
    
    entity class的所有id field在id class都要定义，且类型一样。

@MapKey

在一对多，多对多关系中，我们可以用Map来保存集合对象。默认用主键值做key，如果使用复合主键，则用id class的实例做key，如果指定了name属性，就用指定的field的值做key

@OrderBy

在一对多，多对多关系中，有时我们希望从数据库加载出来的集合对象是按一定方式排序的，这可以通过OrderBy来实现，默认是按对象的主键升序排列

##### JSON相关注解 #####

@JsonIgnoreProperties

此注解是类注解，作用是json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响

@JsonIgnore

此注解用于属性或者方法上（最好是属性上），作用和上面的@JsonIgnoreProperties一样

**@JsonFormat**

此注解用于属性或者方法上（最好是属性上），可以方便的把Date类型直接转化为我们想要的模式，比如@JsonFormat(pattern = "yyyy-MM-dd HH-mm-ss")

@JsonSerialize