Spring Boot2 系列教程(二十三)理解 Spring Data Jpa

最新推荐文章于 2024-05-06 21:25:18 发布

2301_78399389

最新推荐文章于 2024-05-06 21:25:18 发布

阅读量883

点赞数 13

本文链接：https://blog.csdn.net/2301_78399389/article/details/137633710

版权

程序员专栏收录该内容

29 篇文章 0 订阅

订阅专栏

org.springframework

spring-orm

5.0.2.RELEASE

org.springframework

spring-oxm

5.0.2.RELEASE

org.springframework

spring-aop

5.0.2.RELEASE

org.springframework

spring-aspects

5.0.2.RELEASE

mysql

mysql-connector-java

5.1.27

org.springframework

spring-context-support

5.0.2.RELEASE

org.springframework

spring-expression

5.0.2.RELEASE

org.hibernate

hibernate-core

5.2.12.Final

org.hibernate

hibernate-jpamodelgen

5.2.12.Final

com.alibaba

druid

1.0.29

org.springframework.data

spring-data-jpa

1.11.3.RELEASE

这里除了 Jpa 的依赖之外，就是 Spring Data Jpa 的依赖了。

接下来创建一个 User 实体类，创建方式参考 Jpa 中实体类的创建方式，这里不再赘述。

接下来在 resources 目录下创建一个 applicationContext.xml 文件，并配置Spring 和 Jpa，如下：

<context:property-placeholder location=“classpath:db.properties”/>

<context:component-scan base-package=“org.javaboy”/>

true

update

org.hibernate.dialect.MySQL57Dialect

<tx:annotation-driven transaction-manager=“transactionManager”/>

<jpa:repositories base-package=“org.javaboy.dao”

entity-manager-factory-ref=“entityManagerFactory”/>

这里和 Jpa 相关的配置主要是三个:

一个是 entityManagerFactory
一个是 Jpa 的事务
一个是配置 dao 的位置

配置完成后，就可以在 org.javaboy.dao 包下创建相应的 Repository 了，如下：

public interface UserDao extends Repository<User, Long> {

User getUserById(Long id);

}

getUserById 表示根据 id 去查询 User 对象，只要我们的方法名称符合类似的规范，就不需要写 SQL，具体的规范一会来说。好了，接下来，创建 Service 和 Controller 来调用这个方法，如下：

@Service

@Transactional

public class UserService {

@Resource

UserDao userDao;

public User getUserById(Long id) {

return userDao.getUserById(id);

}

public void test1() {

ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext(“applicationContext.xml”);

UserService userService = ctx.getBean(UserService.class);

User user = userService.getUserById(1L);

System.out.println(user);

}

这样，就可以查询到 id 为 1 的用户了。

2.2.2 Repository

上文我们自定义的 UserDao 实现了 Repository 接口，这个 Repository 接口是什么来头呢？

首先来看 Repository 的一个继承关系图：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EzlS5c7i-1574048056954)(https://img2018.cnblogs.com/blog/747810/201911/747810-20191118113229247-773546531.png)]

可以看到，实现类不少。那么到底如何理解 Repository 呢？

Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法 public interface Repository<T, ID extends Serializable> { }
若我们定义的接口继承了 Repository, 则该接口会被 IOC 容器识别为一个 Repository Bean，进而纳入到 IOC 容器中，进而可以在该接口中定义满足一定规范的方法。
Spring Data可以让我们只定义接口，只要遵循 Spring Data 的规范，就无需写实现类。
与继承 Repository 等价的一种方式，就是在持久层接口上使用 @RepositoryDefinition 注解，并为其指定 domainClass 和 idClass 属性。像下面这样：

@RepositoryDefinition(domainClass = User.class, idClass = Long.class)

public interface UserDao

{

User findById(Long id);

List findAll();

}

基础的 Repository 提供了最基本的数据访问功能，其几个子接口则扩展了一些功能，它的几个常用的实现类如下：

CrudRepository：继承 Repository，实现了一组 CRUD 相关的方法
PagingAndSortingRepository：继承 CrudRepository，实现了一组分页排序相关的方法
JpaRepository：继承 PagingAndSortingRepository，实现一组 JPA 规范相关的方法
自定义的 XxxxRepository 需要继承 JpaRepository，这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。
JpaSpecificationExecutor：不属于Repository 体系，实现一组 JPA Criteria 查询相关的方法

2.2.3 方法定义规范

2.2.3.1 简单条件查询

按照 Spring Data 的规范，查询方法以 find | read | get 开头
涉及条件查询时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写

例如：定义一个 Entity 实体类：

class User｛

private String firstName;

private String lastName;

｝

使用 And 条件连接时，条件的属性名称与个数要与参数的位置与个数一一对应，如下：

findByLastNameAndFirstName(String lastName,String firstName);

支持属性的级联查询. 若当前类有符合条件的属性, 则优先使用, 而不使用级联属性. 若需要使用级联属性, 则属性之间使用 _ 进行连接.

查询举例：

按照 id 查询

User getUserById(Long id);

User getById(Long id);

查询所有年龄小于 90 岁的人

List findByAgeLessThan(Long age);

查询所有姓赵的人

List findByUsernameStartingWith(String u);

查询所有姓赵的、并且 id 大于 50 的人

List findByUsernameStartingWithAndIdGreaterThan(String name, Long id);

查询所有姓名中包含"上"字的人

List findByUsernameContaining(String name);

查询所有姓赵的或者年龄大于 90 岁的

List findByUsernameStartingWithOrAgeGreaterThan(String name, Long age);

查询所有角色为 1 的用户

List findByRole_Id(Long id);

2.2.3.2 支持的关键字

支持的查询关键字如下图：

2.2.3.3 查询方法流程解析

为什么写上方法名，JPA就知道你想干嘛了呢？假如创建如下的查询：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);

2.2.3.4 @Query 注解

有的时候，这里提供的查询关键字并不能满足我们的查询需求，这个时候就可以使用 @Query 关键字，来自定义查询 SQL，例如查询 Id 最大的 User：

@Query(“select u from t_user u where id=(select max(id) from t_user)”)

User getMaxIdUser();

如果查询有参数的话，参数有两种不同的传递方式，

利用下标索引传参，索引参数如下所示，索引值从1开始，查询中 ”?X” 个数需要与方法定义的参数个数相一致，并且顺序也要一致：

@Query(“select u from t_user u where id>?1 and username like ?2”)

List selectUserByParam(Long id, String name);

命名参数（推荐）：这种方式可以定义好参数名，赋值时采用@Param(“参数名”)，而不用管顺序：

@Query(“select u from t_user u where id>:id and username like :name”)

List selectUserByParam2(@Param(“name”) String name, @Param(“id”) Long id);

查询时候，也可以是使用原生的 SQL 查询，如下：

@Query(value = “select * from t_user”,nativeQuery = true)

List selectAll();

2.2.3.5 @Modifying 注解

涉及到数据修改操作，可以使用 @Modifying 注解，@Query 与 @Modifying 这两个 annotation 一起声明，可定义个性化更新操作，例如涉及某些字段更新时最为常用，示例如下：

@Modifying

@Query(“update t_user set age=:age where id>:id”)

int updateUserById(@Param(“age”) Long age, @Param(“id”) Long id);

注意：

可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作. 注意: JPQL 不支持使用 INSERT
方法的返回值应该是 int，表示更新语句所影响的行数
在调用的地方必须加事务，没有事务不能正常执行
默认情况下, Spring Data 的每个方法上有事务, 但都是一个只读事务. 他们不能完成修改操作

说到这里，再来顺便说说 Spring Data 中的事务问题：

Spring Data 提供了默认的事务处理方式，即所有的查询均声明为只读事务。
对于自定义的方法，如需改变 Spring Data 提供的事务默认方式，可以在方法上添加 @Transactional 注解。
进行多个 Repository 操作时，也应该使它们在同一个事务中处理，按照分层架构的思想，这部分属于业务逻辑层，因此，需要在Service 层实现对多个 Repository 的调用，并在相应的方法上声明事务。

好了，关于Spring Data Jpa 本文就先说这么多。
关注公众号【江南一点雨】，专注于 Spring Boot+微服务以及前后端分离等全栈技术，定期视频教程分享，关注后回复 Java ，领取松哥为你精心准备的 Java 干货！

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。