使用 JPA 访问数据 - springboot guide中文文档

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

您将构建什么

您将构建一个应用程序，该应用程序将 Customer POJO（简单的Java对象）存储在基于内存的数据库中。

您需要什么

大约15分钟
一个喜欢的文本编辑器或集成开发环境(IDE)
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以直接将代码导入到您的 IDE 中：

如何完成本指南

与大多数 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 开始

您可以使用这个预初始化项目，然后点击生成以下载一个ZIP文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

访问 https://start.spring.io。该服务会拉取应用程序所需的所有依赖，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假设您选择了 Java。
点击 Dependencies，然后选择 Spring Data JPA，接着选择 H2 Database。
点击 Generate。
下载生成的 ZIP 文件，该文件是根据您的选择配置的 Web 应用程序的归档。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成此过程。

您也可以从 Github 上 fork 该项目，并在您的 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 类，它包含三个属性：id、firstName 和 lastName。类中有两个构造函数。默认构造函数仅为了 JPA 而存在，您不会直接使用它，因此被标记为 protected。另一个构造函数用于创建 Customer 实例并将其保存到数据库中。

Customer 类使用了 @Entity 注解，表明它是一个 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 接口。它所操作的实体类型和 ID，即 Customer 和 Long，在 CrudRepository 的泛型参数中指定。通过继承 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。例如，如果类路径上有 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，当应用程序启动时会自动运行该代码。

默认情况下，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 数据。

另请参阅

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