八.SpringBoot集成实例系列-持久化jpa

蔚落 2022-06-04 04:23 245阅读 0赞

文章列表

本系列将通过实例分别实现Springboot集成mybatis(mysql),mail,mongodb,cassandra,scheduler,redis,kafka,shiro,websocket。

具体文章系列如下：

一.SpringBoot集成实例系列-xml型单数据源mybatis

二.SpringBoot集成实例系列-xml型多数据源mybatis

三.SpringBoot集成实例系列-注解型单数据源mybatis

四.SpringBoot集成实例系列-注解型多数据源mybatis

五.SpringBoot集成实例系列-邮件email

六.SpringBoot集成实例系列-单数据源mongodb

七.SpringBoot集成实例系列-多数据源mongodb(一)

七.SpringBoot集成实例系列-多数据源mongodb(二)

八.SpringBoot集成实例系列-持久化jpa

九.SpringBoot集成实例系列-缓存redis

十.SpringBoot集成实例系列-数据库cassandra

十一.SpringBoot集成实例系列-定时任务scheduler

十二.SpringBoot集成实例系列-消息队列kafka

十三.SpringBoot集成实例系列-消息推送websocket

# 1.JPA、ORM、SPRING DATA JPA简介 #

# JPA是Java Persistence API的简称(Java持久层API)，是JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体[对象持久化][Link 1]到数据库中。ORACLE公司为了简化现有JavaEE和JavaSE应用的对象持久化的开发工作，整合ORM技术，结束现在Hibernate、Mybatis、TopLink等ORM框架各自为营的局面，提出了新的JPA ORM规范。注意JPA本质是一种ORM规范，而不是ORM框架，因为它未提供ORM实现，它只是制订了一些规范，统一了各种ORM框架的接口，顾我们可以理解为JPA是接口，是规范，是工具。 #

1)       JPA为POJO提供持久化标准规范。

2)       JPA的使用：

Hibernate与TopLink以及OpenJpa都提供了JPA的实现。

3)       JPA主要技术：

JPA的总体思想和现有Hibernate、TopLink、等ORM框架大体一致。总的来说，JPA包括以下三方面的技术：

A． ORM映射元数据：JPA通过注解或XML描述映射关系，并将运行中的实体对象持久化到数据库中。

B． JPA持久化API：使用面向对象的思想，操作实体对象，进行增删改查的操作。至于怎么操作，由框架思考这件事。这必将大大的节省了开发时间，提高了开发效率。

C．  查询语言：使用面向对象的思想避免了同程序的SQL语句产生交集。

ORM框架都实现了JPA规范，但是在不同ORM框架之间切换是需要编写的代码有一些差异，而通过使用Spring Data Jpa能够方便大家在不同的ORM框架中间进行切换而不要更改代码。并且Spring Data Jpa对Repository层封装的很好，可以省去不少的麻烦。

![Center][]

![Image 1][]

spring data jpa、jpa以及ORM框架之间的关系

# 2.Spring data jpa使用 #

SpringData中最核心的概念就是Repository，Repository是一个抽象的接口，用户通过该接口来实现数据的访问。这次的内容基于Spring Data JPA进行介绍，Spring Data JPA提供了关系型数据库访问的一致性，在该组件中，Repository包括JpaRepository, PagingAndSortingRepository和CrudRepository。

![Center 1][]

![Image 1][]

各Repository接口继承关系

由上图可以看出，JPARepository、PagingAndSortingRepository和CrudRepository接口存在继承关系。本文将通过JPARepository接口来实现数据持久化。

### 2.1 JPARepository通用接口 ###

![Center 2][]

![Image 1][]

JPARepository通用接口

具体见官方API

[https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa/repository/JpaRepository.html][https_docs.spring.io_spring-data_jpa_docs_current_api_org_springframework_data_jpa_repository_JpaRepository.html]

### 2.2 JPARepository扩展接口 ###

如果觉得JPARepository提供的查询不符合要求，可以继承该接口进行扩展，Spring Data JPA为此提供了一些表达条件查询的关键字，大致如下：

**And**\--- 等价于SQL中的and 关键字，比如**findByUsernameAndPassword**(String userName, Striang pwd)；

**Or**\--- 等价于SQL中的or 关键字，比如**findByUsernameOrAddress**(String userName, String addr)；

**Between**\--- 等价于SQL中的between 关键字，比如 **findBySalaryBetween**(int max,int min)；

**LessThan**\--- 等价于SQL中的"<"，比如 **findBySalaryLessThan**(int max)；

**GreaterThan**\--- 等价于SQL中的">"，比如 **findBySalaryGreaterThan**(intmin)；

**IsNull**\--- 等价于SQL中的"is null"，比如 **findByUsernameIsNull**()；

**IsNotNull**\--- 等价于SQL中的"is not null"，比如 **findByUsernameIsNotNull**()；

**NotNull**\--- 与IsNotNull等价；

**Like**\--- 等价于SQL中的"like"，比如 **findByUsernameLike**(String userName)；

**NotLike**\--- 等价于SQL中的"not like"，比如 **findByUsernameNotLike**(String userName)；

**OrderBy**\--- 等价于SQL中的"order by"，比如**findByUsernameOrderBySalaryAsc**(String userName)；

**Not**\--- 等价于SQL中的"！ ="，比如 **findByUsernameNot**(String userName)；

**In**\--- 等价于SQL中的"in"，比如**findByUsernameIn**(Collection<String> userNameList)，方法的参数可以是 Collection类型，也可以是数组或者不定长参数；

**NotIn**\--- 等价于SQL中的"not in"，比如**findByUsernameNotIn**(Collection<String> userNameList)，方法的参数可以是 Collection类型，也可以是数组或者不定长参数；

### 2.3 JPA 基本注解 ###

JPA 基本注解:@Entity, @Table, @Id, @GeneratedValue, @Column, @Basic，@Transient, @Temporal, 用 table 来生成主键详解

#### 2.3.1@Entity ####

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

#### 2.3.2@Table ####

当实体类与其映射的数据库表名不同名时需要使用 @Table 标注说明，该标注与 @Entity 标注并列使用，置于实体类声明语句之前，可写于单独语句行，也可与声明语句同行。

@Table 标注的常用选项是 name，用于指明数据库的表名

@Table标注还有一个两个选项 catalog 和 schema 用于设置表所属的数据库目录或模式，通常为数据库名。uniqueConstraints 选项用于设置约束条件，通常不须设置。

#### 2.3.3@Id ####

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

@Id标注也可置于属性的getter方法之前。

#### 2.3.4@GeneratedValue ####

@GeneratedValue  用于标注主键的生成策略，通过 strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。

在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

- IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；

- AUTO： JPA自动选择合适的策略，是默认选项；

- SEQUENCE：通过序列产生主键，通过 @SequenceGenerator 注解指定序列名，MySql 不支持这种方式

- TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

#### 2.3.5@Basic ####

@Basic 表示一个简单的属性到数据库表的字段的映射,对于没有任何标注的 getXxxx() 方法,默认即为@Basic

fetch: 表示该属性的读取策略,有 EAGER 和 LAZY 两种,分别表示主支抓取和延迟加载,默认为 EAGER.

optional:表示该属性是否允许为null, 默认为true

#### 2.3.6@Column ####

当实体的属性与其映射的数据库表的列不同名时需要使用@Column 标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。

@Column 标注的常用属性是 name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：**unique 、nullable、length**等。

@Column 标注的 columnDefinition 属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型.

@Column标注也可置于属性的getter方法之前

#### 2.3.7@Transient ####

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.

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

#### 2.3.8@Temporal ####

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision).  而在数据库中,表示 Date 类型的数据有 DATE, TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者 兼备).在进行属性映射时可使用@Temporal注解来调整精度.

详情见：[https://docs.oracle.com/javaee/7/api/javax/persistence/package-summary.html][https_docs.oracle.com_javaee_7_api_javax_persistence_package-summary.html]

# 3.实例 #

### 3.1 项目结构 ###

![Center 3][]

![Image 1][]

### 3.2 配置文件 ###

![Center 4][]

![Image 1][]

更多配置见本人博客：[http://blog.csdn.net/a123demi/article/details/73917802][http_blog.csdn.net_a123demi_article_details_73917802]

### 3.3 对象实体 ###

![Center 5][]

![Image 1][]

实体用到lombok注解、JPA注解和fastjson注解。

### 3.4 数据层 ###

![Center 6][]

![Image 1][]

继承JAPRepository接口，以及实现自定义扩展接口

### 3.5 业务层 ###

![Center 7][]

![Image 1][]

### 3.6 控制层 ###

![Center 8][]

![Image 1][]

### 3.7 单元测试 ###

![Center 9][]

![Image 1][]

# 4.代码地址 #

Github:[https://github.com/a123demi/spring-boot-integration][https_github.com_a123demi_spring-boot-integration]

[Link 1]: https://baike.baidu.com/item/%E5%AF%B9%E8%B1%A1%E6%8C%81%E4%B9%85%E5%8C%96
[Center]: /images/20220604/bdbe622e28b74af2b6f6a7fccee23fab.png
[Image 1]: 
[Center 1]: /images/20220604/86a9c732bc72444f9b2eb5f9ab3eca41.png
[Center 2]: /images/20220604/0a5d61f24c2d4477b0f9cf402abbc84e.png
[https_docs.spring.io_spring-data_jpa_docs_current_api_org_springframework_data_jpa_repository_JpaRepository.html]: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa/repository/JpaRepository.html
[https_docs.oracle.com_javaee_7_api_javax_persistence_package-summary.html]: https://docs.oracle.com/javaee/7/api/javax/persistence/package-summary.html
[Center 3]: /images/20220604/61017290d8f94f39806ba4101af8c5b3.png
[Center 4]: /images/20220604/8e7e730b4bac497180c717f380625b28.png
[http_blog.csdn.net_a123demi_article_details_73917802]: http://blog.csdn.net/a123demi/article/details/73917802
[Center 5]: /images/20220604/66a3c4ec102e4eaf9f12d138e5e64963.png
[Center 6]: /images/20220604/602150ca59d94dbeb2a9b502081e6ceb.png
[Center 7]: /images/20220604/ccfc6753cc1b48af8c8e8bf6cdfcc8e4.png
[Center 8]: /images/20220604/90c2af2a4aea45b9a4be61c149b475d7.png
[Center 9]: /images/20220604/7576471f93f6477f99127ffb5db79a99.png
[https_github.com_a123demi_spring-boot-integration]: https://github.com/a123demi/spring-boot-integration