Spring data jpa +springboot 入门

深碍√TFBOYSˉ_ 2023-01-15 03:44 174阅读 0赞

### jpa是通过hibernate来操作数据库的，可以通过jpa在数据库中进行增删改查的操作也就是crud。 ###

jpa的主要的就是crud springboot中主要通过相关注解对实体进行操作，主要就是**JpaRepository和JpaSpecificationExecutor**

主要使用步骤如下：

1.  创建一个springboot工程具体不再叙述，可以在SQL中选择jpa或者后面添加
    
        <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-data-jpa</artifactId>
                </dependency>
    
      
2.  **创建一个Dao层接口，并实现JpaRepository和JpaSpecificationExecutor，提供相应的泛型**![20210421150741419.png][]
3.  使用定义好的Dao层接口进行客户的基本CRUD操作，定义一个test调用继承自**JpaRepository的方法**![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhZ2VkZXNodQ_size_16_color_FFFFFF_t_70][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhZ2VkZXNodQ_size_16_color_FFFFFF_t_70 1][]
4.  @Query 注解的使用非常简单，只需在方法上面标注该注解，同时提供一个JPQL查询语句即可
5.  按照Spring Data JPA 定义的规则，查询方法以findBy开头，涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性首字母需大写。框架在进行方法名解析时，会先把方法名多余的前缀截取掉，然后对剩下部分进行解析。

## 下面部分为查找的相关注解以及用途和参数： ##

# Entity #

@Entity说明这个class是实体类，并且使用默认的orm规则，即class名对应数据库表中表名，class字段名即表中的字段名。   
（如果想改变这种默认的orm规则，就要使用@Table来改变class名与数据库中表名的映射规则，@Column来改变class中字段名与db中表的字段名的映射规则）

元数据属性说明：   
• name: 表名

下面的代码说明,Customer类对应数据库中的Customer表，其中name为可选，缺省类名即表名！

# Table #

Table用来定义entity主表的name，catalog，schema等属性。

元数据属性说明：   
• name: 表名   
• catalog: 对应关系数据库中的catalog   
• schema：对应关系数据库中的schema   
• UniqueConstraints:定义一个UniqueConstraint数组，指定需要建唯一约束的列

# SecondaryTable #

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

元数据属性说明：   
• name: 表名   
• catalog: 对应关系数据库中的catalog   
• schema：对应关系数据库中的schema   
• pkJoin: 定义一个PrimaryKeyJoinColumn数组，指定从表的主键列   
• UniqueConstraints: 定义一个UniqueConstraint数组，指定需要建唯一约束的列

下面的代码说明Customer类映射到两个表，主表名是CUSTOMER，从表名是CUST\_DETAIL，从表的主键列和主表的主键列类型相同，列名为CUST\_ID。

# SecondaryTables #

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

元数据属性说明：   
• value： 定义一个SecondaryTable数组，指定每个从表的属性。

# UniqueConstraint #

UniqueConstraint定义在Table或SecondaryTable元数据里，用来指定建表时需要建唯一约束的列。

元数据属性说明：   
• columnNames:定义一个字符串数组，指定要建唯一约束的列名。

# Column #

Column元数据定义了映射到数据库的列的所有属性：列名，是否唯一，是否允许为空，是否允许更新等。

元数据属性说明：   
• name:列名。   
• unique: 是否唯一   
• nullable: 是否允许为空   
• insertable: 是否允许插入   
• updatable: 是否允许更新   
• columnDefinition: 定义建表时创建此列的DDL   
• secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

# OneToOne #

@OneToOne描述一个 一对一的关联

元数据属性说明：   
• fetch：表示抓取策略，默认为FetchType.LAZY   
• cascade：表示级联操作策略

# ManyToOne #

@ManyToOne表示一个多对一的映射,该注解标注的属性通常是数据库表的外键.

元数据属性说明：   
• optional：是否允许该字段为null，该属性应该根据数据库表的外键约束来确定，默认为true   
• fetch：表示抓取策略，默认为FetchType.EAGER   
• cascade：表示默认的级联操作策略，可以指定为ALL，PERSIST，MERGE，REFRESH和REMOVE中的若干组合，默认为无级联操作   
• targetEntity：表示该属性关联的实体类型。该属性通常不必指定，ORM框架根据属性类型自动判断targetEntity。

# OneToMany #

@OneToMany描述一个 一对多的关联,该属性应该为集体类型,在数据库中并没有实际字段。

元数据属性说明：   
• fetch：表示抓取策略,默认为FetchType.LAZY,因为关联的多个对象通常不必从数据库预先读取到内存   
• cascade：表示级联操作策略,对于OneToMany类型的关联非常重要,通常该实体更新或删除时,其关联的实体也应当被更新或删除

例如：   
实体User和Order是OneToMany的关系，则实体User被删除时，其关联的实体Order也应该被全部删除

# ManyToMany #

@ManyToMany 描述一个多对多的关联.多对多关联上是两个一对多关联,但是在ManyToMany描述中,中间表是由ORM框架自动处理

元数据属性说明：   
• targetEntity:表示多对多关联的另一个实体类的全名,例如:package.Book.class   
• mappedBy:表示多对多关联的另一个实体类的对应集合属性名称

两个实体间相互关联的属性必须标记为@ManyToMany,并相互指定targetEntity属性,   
需要注意的是,有且只有一个实体的@ManyToMany注解需要指定mappedBy属性,指向targetEntity的集合属性名称   
利用ORM工具自动生成的表除了User和Book表外,还自动生成了一个User\_Book表,用于实现多对多关联

# JoinColumn #

如果在entity class的field上定义了关系（one2one或one2many等），我们通过JoinColumn来定义关系的属性。JoinColumn的大部分属性和Column类似。

元数据属性说明：   
• name:列名。   
• referencedColumnName:该列指向列的列名（建表时该列作为外键列指向关系另一端的指定列）   
• unique: 是否唯一   
• nullable: 是否允许为空   
• insertable: 是否允许插入   
• updatable: 是否允许更新   
• columnDefinition: 定义建表时创建此列的DDL   
•

# JoinColumns #

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

元数据属性说明：   
• value: 定义JoinColumn数组，指定每个JoinColumn的属性。  
声明当前field为映射表中的主键列。   
id值的获取方式有五种：TABLE, SEQUENCE, IDENTITY, AUTO, NONE。   
Oracle和DB2支持SEQUENCE，SQL Server和Sybase支持IDENTITY,MySQL支持AUTO。   
所有的数据库都可以指定为AUTO，我们会根据不同数据库做转换。   
NONE (默认)需要用户自己指定Id的值。

元数据属性说明：   
• generate():主键值的获取类型   
• generator():TableGenerator的名字（当generate=GeneratorType.TABLE才需要指定该属性）

# IdClass #

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

# MapKey #

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

元数据属性说明：   
• name: 用来做key的field名字

# OrderBy #

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

元数据属性说明：   
• value: 字符串类型，指定排序方式。   
格式为”fieldName1 \[ASC|DESC\],fieldName2 \[ASC|DESC\],……”,排序类型可以不指定，默认是ASC。

# PrimaryKeyJoinColumn #

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

元数据属性说明：   
• name:列名。   
• referencedColumnName:该列引用列的列名   
• columnDefinition: 定义建表时创建此列的DDL

# PrimaryKeyJoinColumns #

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

元数据属性说明：   
• value: 一个PrimaryKeyJoinColumn数组，包含所有PrimaryKeyJoinColumn。

##    Transient ##

# #

@Transient表示该属性并不是一个到数据库表的字段的映射，指定的这些属性不会被持久化，ORM框架将忽略该属性。   
如果一个属性并非数据库表的字段映射。就务必将其标示为@Transient。否则，ORM框架默认其注解为@Basic

Version

Version指定实体类在乐观事务中的version属性。在实体类重新由EntityManager管理并且加入到乐观事务中时，保证完整性。每一个类只能有一个属性被指定为version，version属性应该映射到实体类的主表上。

Lob

Lob指定一个属性作为数据库支持的大对象类型在数据库中存储。使用LobType这个枚举来定义Lob是二进制类型还是字符类型。

LobType枚举类型说明：   
• BLOB 二进制大对象，Byte\[\]或者Serializable的类型可以指定为BLOB。   
• CLOB 字符型大对象，char\[\]、Character\[\]或String类型可以指定为CLOB。

元数据属性说明：   
• fetch： 定义这个字段是lazy loaded还是eagerly fetched。数据类型是FetchType枚举，默认为LAZY,即lazy loaded.   
• type： 定义这个字段在数据库中的JDBC数据类型。数据类型是LobType枚举，默认为BLOB。

# JoinTable #

JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable，使用JoinTable的默认值。

元数据属性说明：   
• table:这个join table的Table定义。   
• joinColumns:定义指向所有者主表的外键列，数据类型是JoinColumn数组。   
• inverseJoinColumns:定义指向非所有者主表的外键列，数据类型是JoinColumn数组。

# TableGenerator #

TableGenerator定义一个主键值生成器，在Id这个元数据的generate＝TABLE时，generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义。   
生成器是为多个实体类提供连续的ID值的表，每一行为一个类提供ID值，ID值通常是整数。

元数据属性说明：   
• name:生成器的唯一名字，可以被Id元数据使用。   
• table:生成器用来存储id值的Table定义。   
• pkColumnName:生成器表的主键名称。   
• valueColumnName:生成器表的ID值的列名称。   
• pkColumnValue:生成器表中的一行数据的主键值。   
• initialValue:id值的初始值。   
• allocationSize:id值的增量。

SequenceGenerator

SequenceGenerator定义一个主键值生成器，在Id这个元数据的generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义。生成器是数据库支持的sequence对象。

元数据属性说明：   
• name:生成器的唯一名字，可以被Id元数据使用。   
• sequenceName:数据库中，sequence对象的名称。如果不指定，会使用提供商指定的默认名称。   
• initialValue:id值的初始值。   
• allocationSize:id值的增量。

# DiscriminatorColumn #

DiscriminatorColumn定义在使用SINGLE\_TABLE或JOINED继承策略的表中区别不继承层次的列。

元数据属性说明：   
• name:column的名字。默认值为TYPE。   
• columnDefinition:生成DDL的sql片断。   
• length:String类型的column的长度，其他类型使用默认值10。

[20210421150741419.png]: /images/20221022/43f2c63f161c4db193164a1e3dd12785.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhZ2VkZXNodQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210421151001132.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhZ2VkZXNodQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhZ2VkZXNodQ_size_16_color_FFFFFF_t_70 1]: /images/20221022/64debdcbd3cf448ba4a6d0e1e1a81f36.png