点击上方蓝色“程序猿DD”,选择“设为星标”
回复“资源”获取独家整理的学习资料!
作者 | 翟永超
来源 |/spring-boot-learning-21-3-4/
在数据访问这章的第一篇文章《Spring中使用JdbcTemplate访问数据库》中,我们已经介绍了如何使用Spring Boot中最基本的jdbc模块来实现关系型数据库的数据读写操作。那么结合Web开发一章的内容,我们就可以利用JDBC模块与Web模块的功能,综合着使用来完成一个适用于很多简单应用场景的后端应用了。
然而当我们有一定的开发经验之后,不难发现,在实际开发过程中,对数据库的操作大多可以归结为:“增删改查”。就最为普遍的单表操作而言,除了表和字段不同外,语句几乎都是类似的,开发人员需要写大量类似而枯燥的语句来完成业务逻辑。
为了解决这些大量枯燥的数据操作语句,诞生了非常多的优秀框架,比如:Hibernate。通过整合Hibernate,我们能够以操作Java实体的方式来完成对数据的操作,通过框架的帮助,对Java实体的变更最终将自动地映射到数据库表中。
在Hibernate的帮助下,Java实体映射到数据库表数据完成之后,再进一步解决抽象各个Java实体基本的“增删改查”操作,我们通常会以泛型的方式封装一个模板Dao来进行抽象简化,但是这样依然不是很方便,我们需要针对每个实体编写一个继承自泛型模板Dao的接口,再编写该接口的实现。虽然一些基础的数据访问已经可以得到很好的复用,但是在代码结构上针对每个实体都会有一堆Dao的接口和实现。
由于模板Dao的实现,使得这些具体实体的Dao层已经变的非常“薄”,有一些具体实体的Dao实现可能完全就是对模板Dao的简单代理,并且往往这样的实现类可能会出现在很多实体上。Spring Data JPA的出现正可以让这样一个已经很“薄”的数据访问层变成只是一层接口的编写方式。比如,下面的例子:
public interface UserRepository extends JpaRepository<User, Long> {User findByName(String name);@Query("from User u where u.name=:name")User findUser(@Param("name") String name);}
我们只需要通过编写一个继承自JpaRepository
的接口就能完成数据访问,下面以一个具体实例来体验Spring Data JPA给我们带来的强大功能。
使用步骤
由于Spring Data JPA依赖于Hibernate。如果您对Hibernate有一定了解,下面内容可以毫不费力的看懂并上手使用它。如果您还是Hibernate新手,您可以先按如下方式入门,再建议回头学习一下Hibernate以帮助这部分的理解和进一步使用。
工程配置
在pom.xml
中添加相关依赖,加入以下内容:
<dependency<groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId></dependency>
在application.xml
中配置:数据库连接信息(如使用嵌入式数据库则不需要)、自动创建表结构的设置,例如使用mysql的情况如下:
spring.datasource.url=jdbc:mysql://localhost:3306/testspring.datasource.username=rootspring.datasource.password=spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driverspring.jpa.properties.hibernate.hbm2ddl.auto=create-drop
spring.jpa.properties.hibernate.hbm2ddl.auto
是hibernate的配置属性,其主要作用是:自动创建、更新、验证数据库表结构。该参数的几种配置如下:
create
:每次加载hibernate时都会删除上一次的生成的表,然后根据你的model类再重新来生成新表,哪怕两次没有任何改变也要这样执行,这就是导致数据库表数据丢失的一个重要原因。
create-drop
:每次加载hibernate时根据model类生成表,但是sessionFactory一关闭,表就自动删除。
update
:最常用的属性,第一次加载hibernate时根据model类会自动建立起表的结构(前提是先建立好数据库),以后加载hibernate时根据model类自动更新表结构,即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后,表结构是不会被马上建立起来的,是要等应用第一次运行起来后才会。
validate
:每次加载hibernate时,验证创建数据库表结构,只会和数据库中的表进行比较,不会创建新表,但是会插入新值。
至此已经完成基础配置,如果您有在Spring下整合使用过它的话,相信你已经感受到Spring Boot的便利之处:JPA的传统配置在persistence.xml
文件中,但是这里我们不需要。当然,最好在构建项目时候按照之前提过的最佳实践的工程结构来组织,这样以确保各种配置都能被框架扫描到。
创建实体
创建一个User实体,包含id(主键)、name(姓名)、age(年龄)属性,通过ORM框架其会被映射到数据库表中,由于配置了hibernate.hbm2ddl.auto
,在应用启动的时候框架会自动去数据库中创建对应的表。
@Entity@Data@NoArgsConstructorpublic class User {@Id@GeneratedValueprivate Long id;private String name;private Integer age;public User(String name, Integer age) {this.name = name;this.age = age;}}
@Entity
注解标识了User类是一个持久化的实体
@Data
和@NoArgsConstructor
是Lombok中的注解。用来自动生成各参数的Set、Get函数以及不带参数的构造函数。如果您对Lombok还不了解,可以看看这篇文章:Java开发神器Lombok的使用与原理
@Id
和@GeneratedValue
用来标识User对应对应数据库表中的主键
注意:除了这些注解之外,还有很多用来精细化配置映射关系的注解,这里不做具体介绍。后续会出专门一篇来介绍常用注解。读者也可以自行阅读Hibernate的文档来学习这些注解的详细使用方法。
创建数据访问接口
下面针对User实体创建对应的Repository
接口实现对该实体的数据访问,如下代码:
public interface UserRepository extends JpaRepository<User, Long> {User findByName(String name);User findByNameAndAge(String name, Integer age);@Query("from User u where u.name=:name")User findUser(@Param("name") String name);}
在Spring Data JPA中,只需要编写类似上面这样的接口就可实现数据访问。不再像我们以往编写了接口时候还需要自己编写接口实现类,直接减少了我们的文件清单。
下面对上面的UserRepository
做一些解释,该接口继承自JpaRepository
,通过查看JpaRepository
接口的API文档,可以看到该接口本身已经实现了创建(save)、更新(save)、删除(delete)、查询(findAll、findOne)等基本操作的函数,因此对于这些基础操作的数据访问就不需要开发者再自己定义。
在我们实际开发中,JpaRepository
接口定义的接口往往还不够或者性能不够优化,我们需要进一步实现更复杂一些的查询或操作。由于本文重点在Spring Boot中整合spring-data-jpa,在这里先抛砖引玉简单介绍一下spring-data-jpa中让我们兴奋的功能,后续再单独开篇讲一下spring-data-jpa中的常见使用。
在上例中,我们可以看到下面两个函数:
User findByName(String name)
User findByNameAndAge(String name, Integer age)
它们分别实现了按name查询User实体和按name和age查询User实体,可以看到我们这里没有任何类SQL语句就完成了两个条件查询方法。这就是Spring-data-jpa的一大特性:通过解析方法名创建查询。
除了通过解析方法名来创建查询外,它也提供通过使用@Query 注解来创建查询,您只需要编写JPQL语句,并通过类似“:name”来映射@Param指定的参数,就像例子中的第三个findUser函数一样。
Spring Data JPA的能力远不止本文提到的这些,由于本文主要以整合介绍为主,对于Spring Data JPA的使用只是介绍了常见的使用方式。诸如@Modifying操作、分页排序、原生SQL支持以及与Spring MVC的结合使用等等内容就不在本文中详细展开,这里先挖个坑,后续再补文章填坑,如您对这些感兴趣可以关注我博客或简书,同样欢迎大家留言交流想法。
单元测试
在完成了上面的数据访问接口之后,按照惯例就是编写对应的单元测试来验证编写的内容是否正确。这里就不多做介绍,主要通过数据操作和查询来反复验证操作的正确性。
@RunWith(SpringRunner.class)@SpringBootTestpublic class ApplicationTests {@Autowiredprivate UserRepository userRepository;@Testpublic void test() throws Exception {// 创建10条记录userRepository.save(new User("AAA", 10));userRepository.save(new User("BBB", 20));userRepository.save(new User("CCC", 30));userRepository.save(new User("DDD", 40));userRepository.save(new User("EEE", 50));userRepository.save(new User("FFF", 60));userRepository.save(new User("GGG", 70));userRepository.save(new User("HHH", 80));userRepository.save(new User("III", 90));userRepository.save(new User("JJJ", 100));// 测试findAll, 查询所有记录Assert.assertEquals(10, userRepository.findAll().size());// 测试findByName, 查询姓名为FFF的UserAssert.assertEquals(60, userRepository.findByName("FFF").getAge().longValue());// 测试findUser, 查询姓名为FFF的UserAssert.assertEquals(60, userRepository.findUser("FFF").getAge().longValue());// 测试findByNameAndAge, 查询姓名为FFF并且年龄为60的UserAssert.assertEquals("FFF", userRepository.findByNameAndAge("FFF", 60).getName());// 测试删除姓名为AAA的UseruserRepository.delete(userRepository.findByName("AAA"));// 测试findAll, 查询所有记录, 验证上面的删除是否成功Assert.assertEquals(9, userRepository.findAll().size());}}
拓展阅读:关于Spring Data
Spring Data JPA在Spring家族中实际上是一个二级项目,它隶属于Spring Data这个顶级项目。读者可以看一下关于这个项目的介绍,它除了涵盖对关系型数据库的抽象之外,其实还有很多对其他数据存储中间件的实现,比如我们常用的Redis、MongoDB、Elasticsearch等。
如果再找几个项目看一下它们的简单示例,你会发现:不论你是要访问什么数据存储产品,它们的编码方式几乎都是一样的!这就是Spring Data这个项目充满魅力的地方!通过对数据访问操作的抽象来屏蔽细节,用不同子项目的方式去实现细节。让开发者只需要学会使用Spring Data,就能方便快捷的学会对各种数据存储的操作。所以,对于Spring Data,我是强烈推荐Java开发者们可以学、甚至读一下源码的重要框架。虽然,目前来说很多大型互联网公司并不会选择它(性能考量居多,能真正用好它的人不多)作为主要的开发框架,但是其背后的抽象思想是非常值得我们学习的。并且,在做一些非高并发项目的时候,这简直就是一个快捷开发神器,它可以帮助我们少写非常多的代码!
更多本系列免费教程连载:
代码示例
本文的相关例子可以查看下面仓库中的chapter3-4
目录:
Github:/dyc87112/SpringBoot-Learning/
Gitee:/didispace/SpringBoot-Learning/
如果您觉得本文不错,欢迎Star
支持,您的关注是我坚持的动力!
本文通过OpenWrite的Markdown转换工具发布
关注我,回复“加群”加入各种主题讨论群
快速入门
Spring Boot 2.x:版本关系
Spring Boot 2.x:快速入门
Spring Boot 2.x:工程结构推荐
Spring Boot 2.x:配置文件详解
Web开发
Spring Boot 2.x:构建RESTful API与单元测试
Spring Boot 2.x:使用Swagger2构建强大的API文档
Spring Boot 2.x:JSR-303实现请求参数校验
Spring Boot 2.x:Swagger接口分类与各元素排序问题详解
Spring Boot 2.x:Swagger静态API文档的生成
Spring Boot 2.x:找回启动日志中的请求路径列表
数据访问
Spring Boot 2.x:使用JdbcTemplate访问MySQL数据库
Spring Boot 2.x:默认数据源Hikari的配置详解
Spring Boot 2.x:使用国产数据库连接池Druid