Spring Data :Spring 的一个子项目。用于简化数据库访问,支持NoSQL 和 关系数据存储。其主要目标是使数据库的访问变得方便快捷。
SpringData 项目所支持 NoSQL 存储:
- MongoDB (文档数据库)
- Neo4j(图形数据库)
- Redis(键/值存储)
- Hbase(列族数据库)
SpringData 项目所支持的关系数据存储技术:
- JDBC
- JPA
- JPA Spring Data 概述
- JPA Spring Data : 致力于减少数据访问层 (DAO) 的开发量. 开发者唯一要做的,就只是声明持久层的接口,其他都交给 Spring Data JPA 来帮你完成!
框架怎么可能代替开发者实现业务逻辑呢?
比如:当有一个 UserDao.findUserById() 这样一个方法声明,我们大致应该能判断出这是根据给定条件的 ID 查询出满足条件的 User 对象,框架根据方法名也知道要做什么,Spring Data JPA 做的便是规范方法的名字,根据符合规范的名字来确定方法需要实现什么样的逻辑。
SpringData JPA HelloWorld
使用 Spring Data JPA 进行持久层开发需要的四个步骤:
配置 Spring 整合 JPA
笔记使用的是SpringBoot配置,配置不重要,重要的是核心内容。
如果使用SpringBoot配置如下:只需要导入依赖并且填写application.yaml文件即可
依赖:
<!--SpringDataJPA的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!--MySQL驱动的依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
配置文件:
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/springdatajpa?serverTimezone=Asia/Shanghai
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.hibernate.ddl-auto=update
spring.jpa.generate-ddl=true
spring.jpa.show-sql=true
spring.jpa.database-platform=org.hibernate.dialect.MySQL8Dialect
注意,如果配置文件中不添加:
spring.jpa.database-platform=org.hibernate.dialect.MySQL8Dialect
则会造成下面的情况,注意下面的SQL语句创建的是MyISAM引擎的数据表
Hibernate: create table cst_customer (cust_id bigint not null auto_increment, cust_address varchar(255), cust_industry varchar(255), cust_level varchar(255), cust_name varchar(255), cust_phone varchar(255), cust_source varchar(255), primary key (cust_id)) engine=MyISAM
添加spring.jpa.database-platform=org.hibernate.dialect.MySQL8Dialect后,就变成了InnoDB引擎:
Hibernate: create table cst_customer (cust_id bigint not null auto_increment, cust_address varchar(255), cust_industry varchar(255), cust_level varchar(255), cust_name varchar(255), cust_phone varchar(255), cust_source varchar(255), primary key (cust_id)) engine=InnoDB
spring.jpa.database-platform配置的是数据库的方言
以下是原生方式搭建SpringDataJPA,可以跳到开始开发
如果使用默认的Spring配置文件的方式,需要先掌握一些JPA的配置规范,百度上到处都有教程,大致步骤如下:
搭建环境:
同时下载 Spring Data Commons 和 Spring Data JPA 两个发布包:
Commons 是 Spring Data 的基础包
并把相关的依赖 JAR 文件加入到 CLASSPATH 中
在Spring 配置文件中配置 Spring Data,让 Spring为声明的接口创建代理对象。配置了jpa:repositories后,Spring 初始化容器时将会扫描 base-package 指定的包目录及其子目录,为继承 Repository 或其子接口的接口创建代理对象,并将代理对象注册为 Spring Bean,业务层便可以通过 Spring自动封装的特性来直接使用该对象。
声明持久层的接口,该接口继承 Repository,Repository是一个标记型接口,它不包含任何方法,如必要,Spring Data 可实现 Repository 其他子接口(通常我们也是实现其他接口),其中定义了一些常用的增删改查,以及分页相关的方法。
在接口中声明需要的方法。Spring Data 将根据给定的策略(具体策略稍后讲解)来为其生成实现代码。
开始开发
写一个实体类
package com.example.application.model;
import lombok.Data;
import javax.persistence.*;
@Entity
@Table(name = "cst_customer")
@Data
public class Customer {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "cust_id")
private Long custId;
@Column(name = "cust_address")
private String custAddress;
@Column(name = "cust_industry")
private String custIndustry;
@Column(name = "cust_level")
private String custLevel;
@Column(name = "cust_name")
private String custName;
@Column(name = "cust_phone")
private String custPhone;
@Column(name = "cust_source")
private String custSource;
}
这个实体类使用了Lombok
类上面的注解解释
@Entity: 标识该实体类是一个JPA实体类
@Table: 用来规定该实体类在数据库中所对应的的表的一些特性
@Data:Lombok注解用来生成getter,setter,toString,hashCode,equals等方法
@Id:标识该字段为数据表记录中的Id字段
@GeneratedValue:主见的生成策略,上面的strategy = GenerationType.IDENTITY意思是使用主键自增的方式来控制主键
@Column:用来映射该属性和数据表中字段名
写一个Repository接口
package com.example.application.repository;
import com.example.application.model.Customer;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
public interface CustomerRepository extends JpaRepository<Customer, Long>, JpaSpecificationExecutor<Customer> {
}
上面的Repository接口继承了两个接口JpaRepository和JpaSpecificationExecutor
这两个接口中都定义了很多的方法,接口上要规定泛型
T:表示该Repository要操作的实体类的类型
ID:表示该Repository控制的实体类的ID是什么类型
Repository接口的解释
Repository 接口是 Spring Data 的一个核心接口,它不提供任何方法,开发者需要在自己定义的接口中声明需要的方法
package org.springframework.data.repository;
import org.springframework.stereotype.Indexed;
@Indexed
public interface Repository<T, ID> {
}
Spring Data可以让我们只定义接口,只要遵循 Spring Data的规范,就无需写实现类。
与继承Repository等价的一种方式,就是在持久层接口上使用@RepositoryDefinition 注解,并为其指定 domainClass 和 idClass 属性。
Repository的子接口
基础的 Repository 提供了最基本的数据访问功能,其几个子接口则扩展了一些功能。
它们的继承关系如下: Repository: 仅仅是一个标识,表明任何继承它的均为仓库接口类 CrudRepository: 继承 Repository,实现了一组 CRUD 相关的方法 PagingAndSortingRepository: 继承 CrudRepository,实现了一组分页排序相关的方法 JpaRepository: 继承 PagingAndSortingRepository,实现一组 JPA 规范相关的方法 自定义的 XxxxRepository 需要继承 JpaRepository,这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。 JpaSpecificationExecutor: 不属于Repository体系,实现一组 JPA Criteria 查询相关的方法
SpringDataJPA的方法定义规范
简单条件查询: 查询某一个实体类或者集合
按照 Spring Data 的规范,查询方法以 find | read | get开头, 涉及条件查询时,条件的属性用条件关键字连接,要注意的是:条件属性以首字母大写。
例如:定义一个 Entity 实体类
class User {
private String firstName;
private String lastName;
}
使用And条件连接时,应这样写:
findByLastNameAndFirstName(String lastName,String firstName);
条件的属性名称与个数要与参数的位置与个数一一对应
直接在接口中定义查询方法,如果是符合规范的,可以不用写实现,目前支持的关键字写法如下:
支持的查询关键字
Logical keyword Keyword expressions
AND And
OR Or
AFTER After, IsAfter
BEFORE Before, IsBefore
CONTAINING Containing, IsContaining, Contains
BETWEEN Between, IsBetween
ENDING_WITH EndingWith, IsEndingWith, EndsWith
EXISTS Exists
FALSE False, IsFalse
GREATER_THAN GreaterThan, IsGreaterThan
GREATER_THAN_EQUALS GreaterThanEqual, IsGreaterThanEqual
IN In, IsIn
IS Is, Equals, (or no keyword)
IS_EMPTY IsEmpty, Empty
IS_NOT_EMPTY IsNotEmpty, NotEmpty
IS_NOT_NULL NotNull, IsNotNull
IS_NULL Null, IsNull
LESS_THAN LessThan, IsLessThan
LESS_THAN_EQUAL LessThanEqual, IsLessThanEqual
LIKE Like, IsLike
NEAR Near, IsNear
NOT Not, IsNot
NOT_IN NotIn, IsNotIn
NOT_LIKE NotLike, IsNotLike
REGEX Regex, MatchesRegex, Matches
STARTING_WITH StartingWith, IsStartingWith, StartsWith
TRUE True, IsTrue
WITHIN Within, IsWithin
SpringDataJPA对查询关键字的解析步骤
假如创建如下的查询:
findByUserDepUuid();
框架在解析该方法时,首先剔除 findBy,然后对剩下的属性进行解析,假设查询实体为Doc 先判断 userDepUuid (根据 POJO 规范,首字母变为小写)是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,继续第二步;
从右往左截取第一个大写字母开头的字符串(此处为Uuid),然后检查剩下的字符串是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,则重复第二步,继续从右往左截取;最后假设 user 为查询实体的一个属性;
接着处理剩下部分(DepUuid),先判断 user 所对应的类型是否有depUuid属性,如果有,则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询;否则继续按照步骤 2 的规则从右往左截取,最终表示根据 “Doc.user.dep.uuid” 的值进行查询。
可能会存在一种特殊情况,比如 Doc包含一个 user 的属性,也有一个 userDep 属性,此时会存在混淆。可以明确在属性之间加上 “_” 以显式表达意图,比如 “findByUser_DepUuid()” 或者 “findByUserDep_uuid()” 特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如:
Page findByName(String name, Pageable pageable);
List findByName(String name, Sort sort);
使用 @Query 注解
这种查询可以声明在 Repository 方法中,摆脱像命名查询那样的约束,将查询直接在相应的接口方法中声明,结构更为清晰,这是 Spring data 的特有实现。
上面的代码使用的是JPQL语法,下面会说。
上面的?1是一个参数占位符,对于参数占位符来说,有索引参数和命名参数
索引参数如上所示,索引值从1开始,查询中 ”?X” 个数需要与方法定义的参数个数相一致,并且顺序也要一致
命名参数(推荐使用这种方式):可以定义好参数名,赋值时采用@Param(“参数名”),而不用管顺序。
如果是@Query 中有 LIKE 关键字,后面的参数需要前面或者后面加 %,这样在传递参数值的时候就可以不加 %:
@Query("select o from UserModel o where o.name like ?1%")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1%")
public List<UserModel> findByUuidOrAge(String name);
重点:还可以使用@Query来指定本地查询,只要设置nativeQuery为true,比如:
@Query(value=“select * from tbl_user where name like %?1” ,nativeQuery=true)
public List findByUuidOrAge(String name);
@Modifying 注解和事务
@Query 与 @Modifying 这两个 annotation一起声明,可定义个性化更新操作,例如只涉及某些字段更新时最为常用,示例如下:
注意: 方法的返回值应该是 int,表示更新语句所影响的行数 在调用的地方必须加事务,没有事务不能正常执行
事务
Spring Data提供了默认的事务处理方式,即所有的查询均声明为只读事务。
对于自定义的方法,如需改变 Spring Data 提供的事务默认方式,可以在方法上注解 @Transactional 声明
进行多个 Repository 操作时,也应该使它们在同一个事务中处理,按照分层架构的思想,这部分属于业务逻辑层,因此,需要在 Service 层实现对多个 Repository 的调用,并在相应的方法上声明事务。
对于Repository接口的具体说明
CrudRepository 接口提供了最基本的对实体类的添删改查操作
T save(T entity);//保存单个实体
Iterable save(Iterable<? extends T> entities);//保存集合
T findOne(ID id);//根据id查找实体
boolean exists(ID id);//根据id判断实体是否存在
Iterable findAll();//查询所有实体,不用或慎用!
long count();//查询实体数量
void delete(ID id);//根据Id删除实体
void delete(T entity);//删除一个实体
void delete(Iterable<? extends T> entities);//删除一个实体的集合
void deleteAll();//删除所有实体,不用或慎用!
PagingAndSortingRepository接口提供了分页与排序功能
Iterable findAll(Sort sort); //排序
Page findAll(Pageable pageable); //分页查询(含排序功能)
JpaRepository接口提供了JPA的相关功能
List findAll(); //查找所有实体
List findAll(Sort sort); //排序、查找所有实体
List save(Iterable<? extends T> entities);//保存集合
void flush();//执行缓存与数据库同步
T saveAndFlush(T entity);//强制执行持久化
void deleteInBatch(Iterable entities);//删除一个实体集合
JpaSpecificationExecutor接口
不属于Repository体系,实现一组 JPA Criteria 查询相关的方法
public interface JpaSpecificationExecutor<T> {
Optional<T> findOne(@Nullable Specification<T> spec);
List<T> findAll(@Nullable Specification<T> spec);
Page<T> findAll(@Nullable Specification<T> spec, Pageable pageable);
List<T> findAll(@Nullable Specification<T> spec, Sort sort);
long count(@Nullable Specification<T> spec);
}
Specification:封装 JPA Criteria 查询条件。通常使用匿名内部类的方式来创建该接口的对象,Specification接口中有一个方法
@Nullable
Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder);
其中的root是用来进行属性导航的,比如说实体类中有一个属性是username,用root来导航到这个username,需要像下面这样写:
root.get("username").as(String.class);
JPQL查询语法
假设有一个实体类User,实体类中有两个属性username和password
查询全部:
from User;
查询结果按照username倒序:
from User order by username desc;
统计查询:
select count(username) from User;
分页和条件查询:
@Query("SELECT DISTINCT u FROM User u where u.username = ?1")
public List<User> findByUsername(String username, Pageable pageable);