原标题:了解如何使用 Spring Data JPA 处理 JPA 数据持久性(Spring中国教育管理中心)
本指南将引导您完成构建使用 Spring Data JPA 在关系数据库中存储和检索数据的应用程序的过程。
您将构建的内容
您将构建一个应用程序,该应用程序将 POJO(普通旧 Java 对象)存储在基于内存的数据库中。Customer
你需要什么
- 约15分钟
- 喜欢的文本编辑器或 IDE
- JDK 1.8或更高版本
- 格拉德尔 4+或梅文 3.2+
- 您还可以将代码直接导入到 IDE 中:
- 弹簧工具套件 (STS)
- IntelliJ IDEA
如何完成本指南
像大多数春天一样入门指南,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,你最终都会得到工作代码。
要从头开始,请转到从 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。
- 单击依赖关系,然后选择?Spring Data JPA,然后选择?H2 数据库。
- 单击"生成"。
- 下载生成的 ZIP 文件,该文件是使用您的选择配置的 Web 应用程序的存档。
如果您的 IDE 具有 Spring Initializr 集成,则可以从 IDE 完成此过程。
您还可以从 Github 分叉项目,然后在 IDE 或其他编辑器中打开它。
定义简单实体
在此示例中,您将存储对象,每个对象都注释为一个 JPA 实体。以下清单显示了"客户"类(在): Customersrc/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;
}
}COPY
此处有一个具有三个属性的类:、、和 。您还有两个构造函数。缺省构造函数的存在只是为了 JPA。您不直接使用它,因此它被指定为 。另一个构造函数是用于创建要保存到数据库的实例的构造函数。 CustomeridfirstNamelastNameprotectedCustomer
该类用 注释,表示它是一个 JPA 实体。(由于不存在批注,因此假定此实体映射到名为 的表。Customer@Entity@TableCustomer
对象的属性用批注,以便 JPA 将其识别为对象的 ID。该属性还带有批注,以指示应自动生成 ID。Customerid@Idid@GeneratedValue
其他两个属性 和 未注释。假定它们映射到与属性本身同名的列。firstNamelastName
方便的方法打印出客户的属性。toString()
创建简单查询
Spring Data JPA专注于使用JPA在关系数据库中存储数据。它最引人注目的功能是能够在运行时从存储库界面自动创建存储库实现。
要了解其工作原理,请创建一个与实体一起使用的存储库界面,如以下列表(在 中所示): Customersrc/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);
}COPY
CustomerRepository扩展接口。实体的类型及其使用的 ID 和 在 上的泛型参数中指定。通过扩展 ,继承了几种用于处理持久性的方法,包括用于保存、删除和查找实体的方法。 CrudRepositoryCustomerLongCrudRepositoryCrudRepositoryCustomerRepositoryCustomerCustomer
Spring Data JPA还允许您通过声明其他查询方法的方法签名来定义其他查询方法。例如,包括该方法。 CustomerRepositoryfindByLastName()
在典型的 Java 应用程序中,您可能希望编写一个实现 的类。然而,这就是Spring Data JPA如此强大的原因:你不需要编写存储库接口的实现。Spring Data JPA 会在您运行应用程序时创建一个实现。CustomerRepository
现在,您可以连接此示例,看看它是什么样子的!
创建应用程序类
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);
}
}COPY
@SpringBootApplication是添加以下所有内容的便利注释:
- @Configuration:将类标记为应用程序上下文的 Bean 定义的源。
- @EnableAutoConfiguration:告诉 Spring Boot 根据类路径设置、其他 Bean 和各种属性设置开始添加 Bean。例如,如果在类路径上,则此批注将应用程序标记为 Web 应用程序并激活关键行为,如设置 .spring-webmvcDispatcherServlet
- @ComponentScan:告诉Spring在软件包中查找其他组件、配置和服务,让它找到控制器。com/example
该方法使用Spring Boot的方法启动应用程序。您是否注意到没有一行 XML?也没有文件。此Web应用程序是100%纯Java,您不必处理配置任何管道或基础架构。main()SpringApplication.run()web.xml
现在,您需要修改 Initializr 为您创建的简单类。若要获取输出(在此示例中为控制台),需要设置记录器。然后,您需要设置一些数据并使用它来生成输出。以下清单显示了已完成的类(在): AccessingDataJpaApplicationsrc/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("");
};
}
}COPY
该类包括一个方法,该方法通过一些测试。首先,它从 Spring 应用程序上下文中获取。然后,它保存了一些对象,演示了该方法并设置了一些要使用的数据。接下来,它调用以从数据库中获取所有对象。然后,它调用以通过其 ID 获取单个。最后,它调用以查找姓氏为"Bauer"的所有客户。该方法返回一个 Bean,该 Bean 在应用程序启动时自动运行代码。 AccessingDataJpaApplicationdemo()CustomerRepositoryCustomerRepositoryCustomersave()findAll()CustomerfindById()CustomerfindByLastName()demo()CommandLineRunner
缺省情况下,Spring Boot 启用 JPA 存储库支持,并在包(及其子包)中查找所在的位置。如果您的配置具有位于不可见的包中的 JPA 存储库接口定义,则可以通过 using 及其类型安全参数指出备用包。@SpringBootApplication@ EnableJpaRepositoriesbasePackageClasses=MyRepository.class
构建可执行的 JAR
您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar,可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。
如果您使用 Gradle,则可以使用 运行应用程序。或者,您可以使用 JAR 文件构建 JAR 文件,然后运行该 JAR 文件,如下所示:./gradlew bootRun./gradlew build
java -jar build/libs/gs-accessing-data-jpa-0.1.0.jar
如果使用 Maven,则可以使用 运行应用程序。或者,您可以使用 JAR 文件构建 JAR 文件,然后运行该 JAR 文件,如下所示:./mvnw spring-boot:run./mvnw clean package
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将对象保存到数据库中并从中获取它们,所有这些都不需要编写具体的存储库实现。
?
|