SpringBoot 2 使用 JPA 访问数据

最新推荐文章于 2023-04-19 13:16:46 发布
最新推荐文章于 2023-04-19 13:16:46 发布
阅读量417 收藏
点赞数
分类专栏： Spring 入门指南 文章标签： SpringBoot2JPA SpringBoot2访问H2 JPA访问内存数据库 SpringBoot2数据库 JPA访问H2
原文链接：https://spring.io/guides/gs/accessing-data-jpa/
版权

开篇词

该指南将引导构建你使用 Spring Data JPA 来在关系型数据库中存储和检索数据的应用。
 

你将创建的应用

我们将构建一个在基于内存的数据库中存储客户 POJO（普通 Java 对象）的应用。
 

你将需要的工具

如何完成这个指南

像大多数的 Spring 入门指南一样，你可以从头开始并完成每个步骤，也可以绕过你已经熟悉的基本设置步骤。如论哪种方式，你最终都有可以工作的代码。

  • 要从头开始，移步至从 Spring Initializr 开始；
  • 要跳过基础，执行以下操作：
    • 下载并解压缩该指南将用到的源代码，或借助 Git 来对其进行克隆操作：git clone https://github.com/spring-guides/gs-accessing-data-jpa.git
    • 切换至 gs-accessing-data-jpa/initial 目录；
    • 跳转至该指南的定义简单实体。

待一切就绪后，可以检查一下 gs-accessing-data-jpa/complete 目录中的代码。
 

从 Spring Initializr 开始

对于所有的 Spring 应用来说，你应该从 Spring Initializr 开始。Initializr 提供了一种快速的方法来提取应用程序所需的依赖，并为你完成许多设置。该示例需要 JPA 和 H2 依赖。下图显示了此示例项目的 Initializr 设置：
Spring Initializr 界面

上图显示了选择 Maven 作为构建工具的 Initializr。你也可以使用 Gradle。它还将 com.example 和 accessing-data-jpa 的值分别显示为 Group 和 Artifact。在本示例的其余部分，将用到这些值。

以下清单显示了选择 Maven 时创建的 pom.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>accessing-data-jpa</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>accessing-data-jpa</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

以下清单显示了在选择 Gradle 时创建的 build.gradle 文件：

plugins {
    id 'org.springframework.boot' version '2.2.2.RELEASE'
    id 'io.spring.dependency-management' version '1.0.8.RELEASE'
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

test {
    useJUnitPlatform()
}

 

定义简单实体

在该示例中，我们存储了 Customer 对象，没个对象都被标注为 JPA 实体。以下清单显示了 Customer 类（在 src/main/java/com/example/accessingdatajpa/Customer.java）：

package com.example.accessingdatajpa;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Customer {

  @Id
  @GeneratedValue(strategy=GenerationType.AUTO)
  private Long id;
  private String firstName;
  private String lastName;

  protected Customer() {}

  public Customer(String firstName, String lastName) {
    this.firstName = firstName;
    this.lastName = lastName;
  }

  @Override
  public String toString() {
    return String.format(
        "Customer[id=%d, firstName='%s', lastName='%s']",
        id, firstName, lastName);
  }

  public Long getId() {
    return id;
  }

  public String getFirstName() {
    return firstName;
  }

  public String getLastName() {
    return lastName;
  }
}

这里，我们有一个 Customer 类，其三个属性分别为：id、firstName 和 lastName。我们也有两个构造函数。仅为了 JPA 而存在的默认构造函数。我们不直接使用它，因此将其指定为 protected。另一个构造函数是为要保存到数据库的 Customer 实例所创建的。

用 @Entity 标注 Customer 类，表明它是一个 JPA 实体。（由于没有用到 @Table 注解，因此假定该实体已映射到名为 Customer 的表。）

Customer 对象的 id 属性用 @Id 来标注，以便 JPA 将其识别为对象的 ID。id 属性也用 @GeneratedValue 来标注，以指示应该自动生成 ID。

其他两个属性，firstName 和 lastName，未被标注。假定它们映射到与属性名称相同的列。

方便的 toString() 方法可以打印出客户的属性。
 

创建简单查询

Spring Data JPA 专注于使用 JPA 将数据存储在关系型数据库中。它最引人注目的功能是能够在运行时从存储库接口自动创建存储库实现。

要查看其工作方式，请创建一个与 Customer 实体配合使用的存储库接口，如下清单（在 src/main/java/com/example/accessingdatajpa/CustomerRepository.java）所示：

package com.example.accessingdatajpa;

import java.util.List;

import org.springframework.data.repository.CrudRepository;

public interface CustomerRepository extends CrudRepository<Customer, Long> {

  List<Customer> findByLastName(String lastName);

  Customer findById(long id);
}

CustomerRepository 扩展了 CrudRepository 接口。在 CrudRepository 的通用参数中指定了与之配合使用的实体类型和 ID（Customer 和 Long）。通过扩展 CrudRepository，CustomerRepository 继承了几种用于处理 Customer 持久性的方法，包括保存、删除和查找 Customer 实体的方法。

Spring Data JPA 还允许我们通过声明其他方法的方法签名来定义它们。例如，CustomerRepository 包括 findByLastName() 方法。

在典型的 Java 应用中，我们可能希望写一个实现 CustomerRepository 的类。但是，这就是使 Spring Data JPA 如此强大的原因：我们无需编写存储库接口实现。当我们运行应用时，Spring Data JPA 将创建一个实现。

现在，我们可以连接该示例并查看其运行结果！
 

创建应用类

Spring Initializr 为应用创建了一个简单的类。以下清单显示了 Initializr 为该示例创建的类（在 src/main/java/com/example/accessingdatajpa/AccessingDataJpaApplication.java 中）：

package com.example.accessingdatajpa;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AccessingDataJpaApplication {

  public static void main(String[] args) {
    SpringApplication.run(AccessingDataJpaApplication.class, args);
  }

}

@SpringBootApplication 是一个便利的注解，它添加了以下所有内容：

  • @Configuration：将类标记为应用上下文 Bean 定义的源；
  • @EnableAutoConfiguration：告诉 Spring Boot 根据类路径配置、其他 bean 以及各种属性的配置来添加 bean。
  • @ComponentScan：告知 Spring 在 com/example 包中寻找他组件、配置以及服务。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法启动应用。

现在，我们需要修改 Initializr 为我们创建的简单类。要获得输出（在该示例中为控制台），我们需要设置一个记录器。然后，我们需要设置一些数据并将其用于生成输出。以下清单显示了完成的 AccessingDataJpaApplication 类（在 src/main/java/com/example/accessingdatajpa/AccessingDataJpaApplication.java 中）：

package com.example.accessingdatajpa;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class AccessingDataJpaApplication {

  private static final Logger log = LoggerFactory.getLogger(AccessingDataJpaApplication.class);

  public static void main(String[] args) {
    SpringApplication.run(AccessingDataJpaApplication.class);
  }

  @Bean
  public CommandLineRunner demo(CustomerRepository repository) {
    return (args) -> {
      // save a few customers
      repository.save(new Customer("Jack", "Bauer"));
      repository.save(new Customer("Chloe", "O'Brian"));
      repository.save(new Customer("Kim", "Bauer"));
      repository.save(new Customer("David", "Palmer"));
      repository.save(new Customer("Michelle", "Dessler"));

      // fetch all customers
      log.info("Customers found with findAll():");
      log.info("-------------------------------");
      for (Customer customer : repository.findAll()) {
        log.info(customer.toString());
      }
      log.info("");

      // fetch an individual customer by ID
      Customer customer = repository.findById(1L);
      log.info("Customer found with findById(1L):");
      log.info("--------------------------------");
      log.info(customer.toString());
      log.info("");

      // fetch customers by last name
      log.info("Customer found with findByLastName('Bauer'):");
      log.info("--------------------------------------------");
      repository.findByLastName("Bauer").forEach(bauer -> {
        log.info(bauer.toString());
      });
      // for (Customer bauer : repository.findByLastName("Bauer")) {
      //  log.info(bauer.toString());
      // }
      log.info("");
    };
  }

}

Application 包含一个 demo() 方法，该方法将对 CustomerRepository 进行一些测试。首先，它从 Spring 应用上下文中获取 CustomerRepository。然后，它保存了一些 Customer 对象，演示了 save() 方法并设置了一些可使用的数据。接下来，它调用 findAll() 从数据库中获取所有 Customer 对象。然后，它调用 findOne() 以通过其 ID 获取单个 Customer。最后，它调用 findByLastName() 来查找姓氏为 “Bauer” 的所有客户。demo() 方法返回一个 CommandLineRunner bean，该 bean 在应用启动时自动运行代码。

AccessingDataJpaApplication 类包含 main() 方法，该方法使 CustomerRepository 经过一些测试。首先，它从 Spring 应用上下文中获取 CustomerRepository。然后，它保存了少量 Customer 对象，演示了 save() 方法并设置了一些要使用的数据。接下来，它调用 findAll() 从数据库中获取所有 Customer 对象。然后，它调用 findOne() 以通过其 ID 提取单个 Customer。最后，它调用 findByLastName() 来查找姓氏为 “Bauer” 的所有客户。

默认情况下，Spring Boot 启用 JPA 存储库支持，并在 @SpringBootApplication 所在的包（及其子包）中查找。如果我们将 JPA 存储库接口定义配置在不可见的包中，则可以使用 @EnableJpaRepositories 及其类型安全的 basePackageClasses=MyRepository.class 参数指出用来代替的包。

 

构建可执行 JAR

我们可以结合 Gradle 或 Maven 来从命令行运行该应用。我们还可以构建一个包含所有必须依赖项、类以及资源的可执行 JAR 文件，然后运行该文件。在整个开发生命周期中，跨环境等等情况下，构建可执行 JAR 可以轻松地将服务作为应用进行发布、版本化以及部署。

如果使用 Gradle，则可以借助 ./gradlew bootRun 来运行应用。或通过借助 ./gradlew build 来构建 JAR 文件，然后运行 JAR 文件，如下所示：

java -jar build/libs/gs-accessing-data-jpa-0.1.0.jar

由官网提供的以上这条命令的执行结果与我本地的不一样，我需要这样才能运行：java -jar build/libs/accessing-data-jpa-0.0.1-SNAPSHOT.jar。

如果使用 Maven，则可以借助 ./mvnw spring-boot:run 来运行该用。或可以借助 ./mvnw clean package 来构建 JAR 文件，然后运行 JAR 文件，如下所示：

java -jar target/gs-accessing-data-jpa-0.1.0.jar

由官网提供的以上这条命令的执行结果与我本地的不一样，我需要这样才能运行：java -jar target/accessing-data-jpa-0.0.1-SNAPSHOT.jar。

我们还可以构建一个经典的 WAR 文件。

运行应用后，我们应该看到以下输出：

== Customers found with findAll():
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=2, firstName='Chloe', lastName='O'Brian']
Customer[id=3, firstName='Kim', lastName='Bauer']
Customer[id=4, firstName='David', lastName='Palmer']
Customer[id=5, firstName='Michelle', lastName='Dessler']

== Customer found with findById(1L):
Customer[id=1, firstName='Jack', lastName='Bauer']

== Customer found with findByLastName('Bauer'):
Customer[id=1, firstName='Jack', lastName='Bauer']
Customer[id=3, firstName='Kim', lastName='Bauer']

 

概述

恭喜你！我们已经编写了一个简单的应用，该应用使用 Spring Data JPA 将对象保存到数据库中并从数据库中获取它们，而所有这些都无需编写具体的存储库实现。

如果你想轻松地使用基于超媒体的 RESTful 前段暴露 JPA 存储库，则可能需要阅读使用 REST 访问 JPA 数据库（尽请期待～）。

 

参见

以下指南也可能会有所帮助：

想看指南的其他内容？请访问该指南的所属专栏：《Spring 官方指南》

Snow Hide（雪诺海德）
关注
专栏目录
【SpringBoot】76、SpringBoot中使用JPA作为数据持久化框架
Asurplus
03-16 9万+
JPA是Java Persistence API的简称，中文名Java持久层API，是JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体对象持久化到数据库中。
7.springboot中整合Jpa多数据源
daimenglaoshi的博客
12-05 878
在使用Mybatis时会涉及多数据源的问题，同样，当我们使用Jpa作为持久化处理方式时，也会涉及多数据源的问题，本节我们来讲解一下Springboot如何整合Spring data Jpa多数据源。添加lomboc，web，spring data jpa, mysql依赖默认Mysql驱动时8，如果本机安装的Mysql是5，需要手动修改版本 ，修改后的依赖信息如下： 添加 Druid连接池依赖 创建好的项目结构如下:boot1和boot2application.properties中配置两个数据源 4.创
SpringBoot2.x系列教程——整合使用JPA
dyuan134的博客
04-19 260
JPA是Sun官方提出的Java持久化规范,是Java Persistence API的简称，中文名‘Java持久层API’，它本质上是一种ORM规范。JPA通过 JDK 5.0 的 注解或XML 两种形式来描述 ‘对象–关系表’ 的映射关系，并将运行期的实体对象持久化到数据库中。
spring boot2 整合（二）JPA（特别完整！）
weixin_33862188的博客
03-14 132
JPA全称Java Persistence API.JPA通过JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体对象持久化到数据库中。 JPA 的目标之一是制定一个可以由很多供应商实现的API，并且开发人员可以编码来实现该API，而不是使用私有供应商特有的API。 JPA是需要P...
Springboot2（51）集成jpa
热门推荐
cowbin2012的专栏
06-26 1万+
源码地址 springboot2教程系列 Spring Data JPA 与 MyBatis简单对比 Spring Data JPA是Spring Data的子模块。使用Spring Data，使得基于“repositories”概念的JPA实现更简单和容易。Spring Data JPA的目标是大大简化数据访问层代码的编码。作为使用者，我们只需要编写自己的repository接口，接口中包含...
Spring Boot2 系列教程(二十四)Spring Boot 整合 Jpa
江南一点雨的专栏
11-21 3914
Spring Boot 中的数据持久化方案前面给大伙介绍了两种了，一个是 JdbcTemplate，还有一个 MyBatis，JdbcTemplate 配置简单，使用也简单，但是功能也非常有限，MyBatis 则比较灵活，功能也很强大，据我所知，公司采用 MyBatis 做数据持久化的相当多，但是 MyBatis 并不是唯一的解决方案，除了 MyBatis 之外，还有另外一个东西，那就是 Jpa，...
SpringBoot2.x【三】使用 JPA 快速开发
weixin_30882895的博客
06-27 219
SpringBoot2.x【三】使用 JPA 快速开发 1.什么是JPA？为什么要用？ 一种规范，并非ORM框架，也就是ORM上统一的规范 用了之后可以做什么，请看下述代码解释： 一个简单的实体类 package com.example.springredis.entity; import lombok.Data; import javax.persistence.Entity; import...
在springboot中使用JPA访问数据.pdf
最新发布
08-14
在springboot中使用JPA访问数据
springboot同时整合JPA和mybatis的demo
08-12
本示例"springboot同时整合JPA和mybatis的demo"旨在演示如何在一个项目中同时使用Spring Boot与两种ORM（对象关系映射）框架：JPA（Java Persistence API）和MyBatis。这为我们提供了更大的灵活性，可以根据不同的...
SpringBoot+JPA
04-03
将SpringBoot与JPA结合，可以实现高效、简洁的数据库访问。本文将详细介绍如何在SpringBoot项目中整合SpringDataJPA，以及其带来的诸多优势。 1. **SpringBoot简介** SpringBoot旨在简化Spring应用的初始搭建以及...
springboot2+jpa+mysql
06-08
idea建的springboot2 + jpa + mysql环境 简单写了CRUD操作代码
SpringBoot2.x教程——整合使用JPA
qianfeng_dashuju的博客
04-28 875
一. JPA简介 1. JPA概念 JPA是Sun官方提出的Java持久化规范,是Java Persistence API的简称，中文名‘Java持久层API’，它本质上是一种ORM规范。 JPA通过 JDK 5.0 的 注解或XML 两种形式来描述 ‘对象--关系表’ 的映射关系，并将运行期的实体对象持久化到数据库中。 2. JPA出现的原因 Sun引入 JPA 规范是出于两个原因： ...
SpringBoot入门-使用JPA访问数据
qq_37143903的博客
07-07 117
创建项目 配置gradle project 添加 spring_web spring_jpa 创建数据库 mysql> create database db_example; -- Creates the new database mysql> create user 'springuser'@'%' identified by 'ThePassword'; -- Creates the user mysql> grant all on db_example.*..
Springboot2整合JPA
海盗
12-30 346
Springboot2整合JPA
Springboot整合JPA（二）
God_WZH的博客
09-06 676
Springboot整合JPA(二) 第1章 Spring Data JPA的概述 1.1 Spring Data JPA概述 Spring Data JPA 是 Spring 基于 ORM 框架、JPA 规范的基础上封装的一套JPA应用框架，可使开发者用极简的代码即可实现对数据库的访问和操作。它提供了包括增删改查等在内的常用功能，且易于扩展！学习并使用 Spring Data JPA 可以极大提高开发效率！ Spring Data JPA 让我们解脱了DAO层的操作，基本上所有CRUD都可以依赖于它来实现
【springBoot】 springBoot2.x整合jpa
李光 未来科技
10-31 370
前言： 上篇博客用SpringBoot集成了mybatis，Mybatis的重心关注的是数据库表，而jpa关注的是实体，本篇博客从0进行整合jpa 1、pom文件 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.2.RELEASE<
SpringBoot2.x入门：使用JPA
Throwable
08-18 3580
前提这篇文章是《SpringBoot2.x入门》专辑的「第9篇」文章，使用的SpringBoot版本为2.3.1.RELEASE，JDK版本为1.8。这篇文章会介绍一下SpringBoo...
spring boot2.0集成jpa
lanshizizhong的博客
11-24 87
添加依赖 配置application.yml文件 spring: datasource: # hikari driver-class-name: com.mysql.cj.jdbc.Driver # mysql 8 username: root password: url: jdbc:mysql://localhost:3306/springboot_test?useUnicode=true&characterEncoding=utf8&serverT
SpringBoot快速集成JPA实战教程
这就是一个简单的SpringBoot集成JPA的示例，通过这些步骤，你可以快速搭建起一个数据访问层，方便地与MySQL数据库进行交互。理解并掌握这个流程，对于构建高效、可维护的Spring Boot应用至关重要。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值