使用 JPA 访问数据

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

您将构建什么

您将构建一个将 Customer 对象存储在内存数据库中的应用程序。

您需要什么

大约 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
cd 到 gs-accessing-data-jpa/initial
跳到定义一个简单的实体。

完成后，您可以将您的结果与 gs-accessing-data-jpa/complete 中的代码进行比较。

从 Spring Initializr 开始

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

手动初始化项目

导航到 https://start.spring.io。此服务会为您拉取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您想要使用的语言。
单击依赖项并选择Spring Data JPA，然后选择H2 Database。
单击生成。
下载生成的 ZIP 文件，这是一个已根据您的选择配置好的 Web 应用程序存档。

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

您还可以从 GitHub fork 项目，并在您的 IDE 或其他编辑器中打开它。

定义一个简单的实体

在此示例中，您存储 Customer 对象，每个对象都标注为 JPA 实体。以下列表显示了 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;
    }
}

Kotlin

package com.example.accessingdatajpa

import jakarta.persistence.Entity
import jakarta.persistence.GeneratedValue
import jakarta.persistence.GenerationType
import jakarta.persistence.Id

@Entity
class Customer(
    var firstName: String = "",
    var lastName: String = ""
) {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    var id: Long? = null

    override fun toString(): String =
        "Customer[id=$id, firstName='$firstName', lastName='$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 实体一起工作的存储库接口，如以下列表所示

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);
}

Kotlin

package com.example.accessingdatajpa

import org.springframework.data.repository.CrudRepository

interface CustomerRepository : CrudRepository<Customer, Long> {
    fun findByLastName(lastName: String): List<Customer>
}

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 为此示例创建的类

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);
    }

}

Kotlin

package com.example.accessingdatajpa

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class AccessingDataJpaApplication

fun main(args: Array<String>) {
    runApplication<AccessingDataJpaApplication>(*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 类

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 logger = 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
            logger.info("Customers found with findAll():");
            logger.info("-------------------------------");
            repository.findAll().forEach(customer -> {
                logger.info(customer.toString());
            });
            logger.info("");

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

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

}

Kotlin

package com.example.accessingdatajpa

import org.slf4j.LoggerFactory
import org.springframework.boot.CommandLineRunner
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
import org.springframework.context.annotation.Bean

private val logger = LoggerFactory.getLogger(AccessingDataJpaApplication::class.java)

@SpringBootApplication
class AccessingDataJpaApplication {

    @Bean
    fun demo(repository: CustomerRepository) = CommandLineRunner {
        // save a few customers
        repository.saveAll(
            listOf(
                Customer("Jack", "Bauer"),
                Customer("Chloe", "O'Brian"),
                Customer("Kim", "Bauer"),
                Customer("David", "Palmer"),
                Customer("Michelle", "Dessler")
            )
        )

        // fetch all customers
        logger.info("Customers found with findAll():")
        logger.info("-------------------------------")
        repository.findAll().forEach { customer ->
            logger.info(customer.toString())
        }
        logger.info("")

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

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

fun main(args: Array<String>) {
    runApplication<AccessingDataJpaApplication>(*args)
}

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

项目

Spring Data JPA