使用 JPA 访问数据

本指南将引导您完成构建应用程序的过程,该应用程序使用 Spring Data JPA 在关系数据库中存储和检索数据。

您将构建什么

您将构建一个应用程序,该应用程序将 Customer POJO(普通旧 Java 对象)存储在基于内存的数据库中。

您需要什么

如何完成本指南

与大多数 Spring 入门指南 一样,您可以从头开始完成每一步,或者跳过您已经熟悉的设置步骤。无论哪种方式,您最终都会获得可正常工作的代码。

从头开始,请转到 从 Spring Initializr 开始

跳过基础知识,请执行以下操作

完成后,可以根据 gs-accessing-data-jpa/complete 中的代码检查结果。

从 Spring Initializr 开始

可以使用此 预初始化项目,然后单击“生成”以下载 ZIP 文件。此项目已配置为适合本教程中的示例。

手动初始化项目

  1. 导航到 https://start.spring.io。此服务会提取应用程序所需的所有依赖项,并为您完成大部分设置。

  2. 选择 Gradle 或 Maven 以及要使用的语言。本指南假设您选择了 Java。

  3. 单击依赖项,然后选择Spring Data JPA,再选择H2 数据库

  4. 单击生成

  5. 下载生成的 ZIP 文件,该文件是已根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 具有 Spring Initializr 集成,则可以从 IDE 完成此过程。
您还可以从 Github 分叉项目,然后在 IDE 或其他编辑器中打开它。

定义一个简单实体

在此示例中,您存储 Customer 对象,每个对象都标注为 JPA 实体。以下列表显示了 Customer 类(位于 src/main/java/com/example/accessingdatajpa/Customer.java 中)

package com.example.accessingdatajpa;

import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.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 类,它具有三个属性:idfirstNamelastName。您还有两个构造函数。默认构造函数仅为 JPA 而存在。您不会直接使用它,因此将其指定为 protected。另一个构造函数是您用来创建要保存到数据库的 Customer 实例的构造函数。

Customer 类使用 @Entity 进行标注,表示它是一个 JPA 实体。(由于不存在 @Table 标注,因此假定此实体映射到名为 Customer 的表。)

Customer 对象的 id 属性用 @Id 注释,以便 JPA 将其识别为对象的 ID。id 属性还用 @GeneratedValue 注释,以指示应自动生成 ID。

其他两个属性 firstNamelastName 未注释。假设它们映射到与属性本身同名的列。

便捷的 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 接口。它所处理的实体和 ID 的类型 CustomerLong,在 CrudRepository 上的泛型参数中指定。通过扩展 CrudRepositoryCustomerRepository 继承了多种用于处理 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。例如,如果 spring-webmvc 在类路径上,此注释将应用程序标记为 Web 应用程序并激活关键行为,例如设置 DispatcherServlet

  • @ComponentScan:告诉 Spring 在 com/example 包中查找其他组件、配置和服务,以便它找到控制器。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法启动应用程序。您是否注意到没有一行 XML?也没有 web.xml 文件。此 Web 应用程序是 100% 纯 Java,您不必处理任何管道或基础架构的配置。

现在,您需要修改 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("-------------------------------");
      repository.findAll().forEach(customer -> {
        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());
      });
      log.info("");
    };
  }

}

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

默认情况下,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

如果您使用 Maven,则可以使用 ./mvnw spring-boot:run 运行应用程序。或者,您可以使用 ./mvnw clean package 构建 JAR 文件,然后运行 JAR 文件,如下所示

java -jar target/gs-accessing-data-jpa-0.1.0.jar
此处描述的步骤会创建一个可运行的 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 数据

另请参阅

以下指南也可能会有帮助

想要编写新指南或为现有指南做出贡献?查看我们的 贡献指南

所有指南都随附 ASLv2 代码许可证,以及 署名,禁止派生作品创作共用许可证 用于编写。

获取代码

免费

在云中工作

在 Spring Academy 云中完成本指南。

转到 Spring Academy