欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring Boot中使用Spring-data-jpa的配置方法详解

程序员文章站 2024-02-27 13:49:45
为了解决这些大量枯燥的数据操作语句,我们第一个想到的是使用orm框架,比如:hibernate。通过整合hibernate之后,我们以操作java实体的方式最终将数据改变映...

为了解决这些大量枯燥的数据操作语句,我们第一个想到的是使用orm框架,比如:hibernate。通过整合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有一定了解,下面内容可以毫不费力的看懂并上手使用spring-data-jpa。如果您还是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/test 
spring.datasource.username=root 
spring.datasource.password=root 
spring.datasource.driver-class-name=com.mysql.jdbc.driver
spring.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
public class user {
  @id
  @generatedvalue
  private long id;
  @column(nullable = false)
  private string name;
  @column(nullable = false)
  private integer age;
  // 省略构造函数
  // 省略getter和setter
}

创建数据访问接口

下面针对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的一大特性:通过解析方法名创建查询。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对的支持。如果你想了解更多相关内容请查看下面相关链接