使用 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 Database

  4. 单击生成

  5. 下载生成的 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 类: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 为您创建的简单类。为了获得输出(在此示例中是控制台输出),您需要设置一个 logger。然后您需要设置一些数据并使用它来生成输出。以下列表显示了完成的 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