SQL 数据库

Spring Framework 为使用 SQL 数据库提供了广泛的支持,从使用 JdbcClientJdbcTemplate 的直接 JDBC 访问,到像 Hibernate 这样的完整的“对象关系映射”技术。Spring Data 提供了更高层次的功能:直接从接口创建 Repository 实现,并使用约定从方法名称生成查询。

配置 DataSource

Java 的 DataSource 接口提供了一种使用数据库连接的标准方法。传统上,DataSource 使用一个 URL 和一些凭据来建立数据库连接。

有关更高级的示例,通常是为了完全控制 DataSource 的配置,请参阅“操作指南”中的配置自定义 DataSource 部分。

嵌入式数据库支持

使用内存中的嵌入式数据库开发应用程序通常很方便。显然,内存数据库不提供持久存储。您需要在应用程序启动时填充数据库,并准备好在应用程序结束时丢弃数据。

“操作指南”部分包含有关如何初始化数据库的章节

Spring Boot 可以自动配置嵌入式 H2HSQLDerby 数据库。您无需提供任何连接 URL。您只需包含对要使用的嵌入式数据库的构建依赖项。如果类路径上有多个嵌入式数据库,请设置 spring.datasource.embedded-database-connection 配置属性来控制使用哪个数据库。将该属性设置为 none 将禁用嵌入式数据库的自动配置。

如果您在测试中使用此功能,您可能会注意到无论您使用多少个应用程序上下文,整个测试套件都会重复使用相同的数据库。如果您希望确保每个上下文都有一个单独的嵌入式数据库,您应该将 spring.datasource.generate-unique-name 设置为 true

例如,典型的 POM 依赖项如下所示

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
	<groupId>org.hsqldb</groupId>
	<artifactId>hsqldb</artifactId>
	<scope>runtime</scope>
</dependency>
您需要一个对 spring-jdbc 的依赖项才能自动配置嵌入式数据库。在此示例中,它通过 spring-boot-starter-data-jpa 传递地引入。
如果出于某种原因,您为嵌入式数据库配置了连接 URL,请注意确保禁用数据库的自动关闭。如果您使用 H2,您应该使用 DB_CLOSE_ON_EXIT=FALSE 来实现这一点。如果您使用 HSQLDB,您应该确保不使用 shutdown=true。禁用数据库的自动关闭允许 Spring Boot 控制数据库何时关闭,从而确保在不再需要访问数据库时关闭数据库。

连接到生产数据库

生产数据库连接也可以通过使用池化的 DataSource 自动配置。

DataSource 配置

DataSource 配置由 spring.datasource.* 中的外部配置属性控制。例如,您可以在 application.properties 中声明以下部分

  • 属性

  • YAML

spring.datasource.url=jdbc:mysql:///test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring:
  datasource:
    url: "jdbc:mysql:///test"
    username: "dbuser"
    password: "dbpass"
您至少应该通过设置 spring.datasource.url 属性来指定 URL。否则,Spring Boot 会尝试自动配置嵌入式数据库。
Spring Boot 可以从 URL 推断出大多数数据库的 JDBC 驱动程序类。如果您需要指定一个特定的类,您可以使用 spring.datasource.driver-class-name 属性。
为了创建池化的 DataSource,我们需要能够验证有效的 Driver 类是否可用,因此我们在执行任何操作之前会检查这一点。换句话说,如果您设置 spring.datasource.driver-class-name=com.mysql.jdbc.Driver,那么该类必须是可加载的。

有关更多支持的选项,请参阅 DataSourceProperties API 文档。这些是无论 实际实现 如何都适用的标准选项。也可以使用各自的前缀(spring.datasource.hikari.*spring.datasource.tomcat.*spring.datasource.dbcp2.*spring.datasource.oracleucp.*)微调特定于实现的设置。有关更多详细信息,请参阅您正在使用的连接池实现的文档。

例如,如果您使用 Tomcat 连接池,您可以自定义许多额外的设置,如下例所示

  • 属性

  • YAML

spring.datasource.tomcat.max-wait=10000
spring.datasource.tomcat.max-active=50
spring.datasource.tomcat.test-on-borrow=true
spring:
  datasource:
    tomcat:
      max-wait: 10000
      max-active: 50
      test-on-borrow: true

如果连接不可用,这将设置池等待 10000 毫秒后抛出异常,将最大连接数限制为 50,并在从池中借用连接之前验证连接。

支持的连接池

Spring Boot 使用以下算法选择特定的实现

  1. 我们偏爱 HikariCP 的性能和并发性。如果 HikariCP 可用,我们总是选择它。

  2. 否则,如果 Tomcat 池化 DataSource 可用,我们使用它。

  3. 否则,如果 Commons DBCP2 可用,我们使用它。

  4. 如果 HikariCP、Tomcat 和 DBCP2 均不可用,并且 Oracle UCP 可用,我们使用它。

如果您使用 spring-boot-starter-jdbcspring-boot-starter-data-jpa starter,您会自动获得对 HikariCP 的依赖。

您可以通过设置 spring.datasource.type 属性完全绕过该算法并指定要使用的连接池。如果您在 Tomcat 容器中运行应用程序,这一点尤其重要,因为 tomcat-jdbc 默认提供。

始终可以使用 DataSourceBuilder 手动配置其他连接池。如果您定义自己的 DataSource bean,则不会发生自动配置。DataSourceBuilder 支持以下连接池

连接到 JNDI DataSource

如果您将 Spring Boot 应用程序部署到应用程序服务器,您可能希望使用应用程序服务器的内置功能配置和管理 DataSource,并通过 JNDI 访问它。

spring.datasource.jndi-name 属性可以用作 spring.datasource.urlspring.datasource.usernamespring.datasource.password 属性的替代方案,用于从特定的 JNDI 位置访问 DataSource。例如,application.properties 中的以下部分显示了如何访问 JBoss AS 定义的 DataSource

  • 属性

  • YAML

spring.datasource.jndi-name=java:jboss/datasources/customers
spring:
  datasource:
    jndi-name: "java:jboss/datasources/customers"

使用 JdbcTemplate

Spring 的 JdbcTemplateNamedParameterJdbcTemplate 类是自动配置的,您可以将它们直接自动注入到您自己的 bean 中,如下例所示

  • Java

  • Kotlin

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final JdbcTemplate jdbcTemplate;

	public MyBean(JdbcTemplate jdbcTemplate) {
		this.jdbcTemplate = jdbcTemplate;
	}

	public void doSomething() {
		this.jdbcTemplate ...
	}

}
import org.springframework.jdbc.core.JdbcTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val jdbcTemplate: JdbcTemplate) {

	fun doSomething() {
		jdbcTemplate.execute("delete from customer")
	}

}

您可以使用 spring.jdbc.template.* 属性自定义模板的一些属性,如下例所示

  • 属性

  • YAML

spring.jdbc.template.max-rows=500
spring:
  jdbc:
    template:
      max-rows: 500

如果需要调整 SQL 异常,您可以定义自己的 SQLExceptionTranslator bean,以便将其与自动配置的 JdbcTemplate 相关联。

NamedParameterJdbcTemplate 在幕后重用相同的 JdbcTemplate 实例。如果定义了多个 JdbcTemplate 且不存在主候选者,则不自动配置 NamedParameterJdbcTemplate

使用 JdbcClient

Spring 的 JdbcClient 根据 NamedParameterJdbcTemplate 的存在自动配置。您也可以将其直接注入到您自己的 bean 中,如下例所示

  • Java

  • Kotlin

import org.springframework.jdbc.core.simple.JdbcClient;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final JdbcClient jdbcClient;

	public MyBean(JdbcClient jdbcClient) {
		this.jdbcClient = jdbcClient;
	}

	public void doSomething() {
		this.jdbcClient ...
	}

}
import org.springframework.jdbc.core.simple.JdbcClient
import org.springframework.stereotype.Component

@Component
class MyBean(private val jdbcClient: JdbcClient) {

	fun doSomething() {
		jdbcClient.sql("delete from customer").update()
	}

}

如果您依赖自动配置来创建底层的 JdbcTemplate,那么使用 spring.jdbc.template.* 属性进行的任何自定义也会在客户端中考虑。

JPA 和 Spring Data JPA

Java Persistence API 是一种标准技术,允许您将对象“映射”到关系数据库。spring-boot-starter-data-jpa POM 提供了一种快速入门的方法。它提供了以下关键依赖项

  • Hibernate:最流行的 JPA 实现之一。

  • Spring Data JPA:帮助您实现基于 JPA 的存储库。

  • Spring ORM:Spring Framework 提供的核心 ORM 支持。

我们在这里不会深入介绍 JPA 或 Spring Data 的太多细节。您可以遵循 spring.io 上的 使用 JPA 访问数据 指南,并阅读 Spring Data JPAHibernate 参考文档。

实体类

传统上,JPA “实体”类是在 persistence.xml 文件中指定的。使用 Spring Boot,此文件不再必要,而是使用“实体扫描”。默认情况下,自动配置包 会被扫描。

任何使用 @Entity@Embeddable@MappedSuperclass 注解的类都会被考虑。典型的实体类类似于以下示例

  • Java

  • Kotlin

import java.io.Serializable;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;

@Entity
public class City implements Serializable {

	@Id
	@GeneratedValue
	private Long id;

	@Column(nullable = false)
	private String name;

	@Column(nullable = false)
	private String state;

	// ... additional members, often include @OneToMany mappings

	protected City() {
		// no-args constructor required by JPA spec
		// this one is protected since it should not be used directly
	}

	public City(String name, String state) {
		this.name = name;
		this.state = state;
	}

	public String getName() {
		return this.name;
	}

	public String getState() {
		return this.state;
	}

	// ... etc

}
import jakarta.persistence.Column
import jakarta.persistence.Entity
import jakarta.persistence.GeneratedValue
import jakarta.persistence.Id
import java.io.Serializable

@Entity
class City : Serializable {

	@Id
	@GeneratedValue
	private val id: Long? = null

	@Column(nullable = false)
	var name: String? = null
		private set

	// ... etc
	@Column(nullable = false)
	var state: String? = null
		private set

	// ... additional members, often include @OneToMany mappings

	protected constructor() {
		// no-args constructor required by JPA spec
		// this one is protected since it should not be used directly
	}

	constructor(name: String?, state: String?) {
		this.name = name
		this.state = state
	}

}
您可以使用 @EntityScan 注解自定义实体扫描位置。请参阅“操作指南”的将 @Entity 定义与 Spring 配置分离部分。

Spring Data JPA 存储库

Spring Data JPA 存储库是您可以定义来访问数据的接口。JPA 查询是根据您的方法名称自动创建的。例如,CityRepository 接口可以声明一个 findAllByState(String state) 方法来查找给定状态中的所有城市。

对于更复杂的查询,您可以使用 Spring Data 的 Query 注解来标注您的方法。

Spring Data 存储库通常扩展自 RepositoryCrudRepository 接口。如果您使用自动配置,自动配置包 会被搜索以查找存储库。

您可以使用 @EnableJpaRepositories 自定义查找存储库的位置。

以下示例显示了一个典型的 Spring Data 存储库接口定义

  • Java

  • Kotlin

import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.City;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;

public interface CityRepository extends Repository<City, Long> {

	Page<City> findAll(Pageable pageable);

	City findByNameAndStateAllIgnoringCase(String name, String state);

}
import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.City
import org.springframework.data.domain.Page
import org.springframework.data.domain.Pageable
import org.springframework.data.repository.Repository

interface CityRepository : Repository<City, Long> {

	fun findAll(pageable: Pageable?): Page<City>?

	fun findByNameAndStateAllIgnoringCase(name: String?, state: String?): City?

}

Spring Data JPA 存储库支持三种不同的引导模式:默认、延迟和懒惰。要启用延迟或懒惰引导,请将 spring.data.jpa.repositories.bootstrap-mode 属性分别设置为 deferredlazy。当使用延迟或懒惰引导时,自动配置的 EntityManagerFactoryBuilder 将使用上下文的 AsyncTaskExecutor(如果有的话)作为引导执行器。如果存在多个,将使用名为 applicationTaskExecutor 的执行器。

当使用延迟或懒惰引导时,请确保在应用程序上下文引导阶段之后延迟对 JPA 基础设施的任何访问。您可以使用 SmartInitializingSingleton 来调用任何需要 JPA 基础设施的初始化。对于作为 Spring Bean 创建的 JPA 组件(例如转换器),请使用 ObjectProvider 来延迟依赖项的解析(如果有的话)。

我们刚刚触及了 Spring Data JPA 的皮毛。有关完整详细信息,请参阅 Spring Data JPA 参考文档

Spring Data Envers 存储库

如果 Spring Data Envers 可用,JPA 存储库会自动配置以支持典型的 Envers 查询。

要使用 Spring Data Envers,请确保您的存储库扩展自 RevisionRepository,如下例所示

  • Java

  • Kotlin

import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.history.RevisionRepository;

public interface CountryRepository extends RevisionRepository<Country, Long, Integer>, Repository<Country, Long> {

	Page<Country> findAll(Pageable pageable);

}
import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country
import org.springframework.data.domain.Page
import org.springframework.data.domain.Pageable
import org.springframework.data.repository.Repository
import org.springframework.data.repository.history.RevisionRepository

interface CountryRepository :
		RevisionRepository<Country, Long, Int>,
		Repository<Country, Long> {

	fun findAll(pageable: Pageable?): Page<Country>?

}
有关更多详细信息,请查看 Spring Data Envers 参考文档

创建和删除 JPA 数据库

默认情况下,JPA 数据库< strong>仅在您使用嵌入式数据库(H2、HSQL 或 Derby)时自动创建。您可以使用 spring.jpa.* 属性显式配置 JPA 设置。例如,要创建和删除表,您可以在 application.properties 中添加以下行

  • 属性

  • YAML

spring.jpa.hibernate.ddl-auto=create-drop
spring:
  jpa:
    hibernate.ddl-auto: "create-drop"
Hibernate 自己的内部属性名称(如果您碰巧记得更清楚)是 hibernate.hbm2ddl.auto。您可以设置它以及其他 Hibernate 本机属性,方法是使用 spring.jpa.properties.*(在将它们添加到实体管理器之前会剥离前缀)。以下行显示了为 Hibernate 设置 JPA 属性的示例
  • 属性

  • YAML

spring.jpa.properties.hibernate.globally_quoted_identifiers=true
spring:
  jpa:
    properties:
      hibernate:
        "globally_quoted_identifiers": "true"

上例中的行将 hibernate.globally_quoted_identifiers 属性的值 true 传递给 Hibernate 实体管理器。

默认情况下,DDL 执行(或验证)会延迟到 ApplicationContext 启动之后。

在视图中打开 EntityManager

如果您正在运行 Web 应用程序,Spring Boot 默认注册 OpenEntityManagerInViewInterceptor 以应用“在视图中打开 EntityManager”模式,从而允许在 Web 视图中进行延迟加载。如果您不希望此行为,则应在 application.properties 中将 spring.jpa.open-in-view 设置为 false

Spring Data JDBC

Spring Data 包含对 JDBC 的存储库支持,并将自动为 CrudRepository 上的方法生成 SQL。对于更高级的查询,提供了 @Query 注解。

当必要的依赖项在类路径上时,Spring Boot 将自动配置 Spring Data 的 JDBC 存储库。可以通过对 spring-boot-starter-data-jdbc 的单一依赖项将其添加到您的项目中。如果需要,您可以通过在应用程序中添加 @EnableJdbcRepositories 注解或 AbstractJdbcConfiguration 子类来控制 Spring Data JDBC 的配置。

有关 Spring Data JDBC 的完整详细信息,请参阅参考文档

使用 H2 Web 控制台

H2 数据库 提供了一个 基于浏览器的控制台,Spring Boot 可以为您自动配置。当满足以下条件时,控制台会自动配置

  • 您正在开发一个基于 Servlet 的 Web 应用程序。

  • com.h2database:h2 在类路径上。

  • 您正在使用 Spring Boot 的开发工具

如果您没有使用 Spring Boot 的开发工具但仍然希望使用 H2 控制台,您可以将 spring.h2.console.enabled 属性配置为 true
H2 控制台仅用于开发期间,因此您应注意确保在生产环境中未将 spring.h2.console.enabled 设置为 true

更改 H2 控制台路径

默认情况下,控制台可在 /h2-console 访问。您可以使用 spring.h2.console.path 属性自定义控制台的路径。

在安全应用程序中访问 H2 控制台

H2 控制台使用框架,并且由于它仅用于开发,因此不实现 CSRF 保护措施。如果您的应用程序使用 Spring Security,则需要将其配置为

  • 禁用针对控制台请求的 CSRF 保护,

  • 在控制台的响应上设置标头 X-Frame-OptionsSAMEORIGIN

有关 CSRFX-Frame-Options 标头的更多信息可以在 Spring Security 参考指南中找到。

在简单的设置中,可以使用如下所示的 SecurityFilterChain

  • Java

  • Kotlin

import org.springframework.boot.security.autoconfigure.web.servlet.PathRequest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configurers.CsrfConfigurer;
import org.springframework.security.config.annotation.web.configurers.HeadersConfigurer.FrameOptionsConfig;
import org.springframework.security.web.SecurityFilterChain;

@Profile("dev")
@Configuration(proxyBeanMethods = false)
public class DevProfileSecurityConfiguration {

	@Bean
	@Order(Ordered.HIGHEST_PRECEDENCE)
	SecurityFilterChain h2ConsoleSecurityFilterChain(HttpSecurity http) {
		http.securityMatcher(PathRequest.toH2Console());
		http.authorizeHttpRequests(yourCustomAuthorization());
		http.csrf(CsrfConfigurer::disable);
		http.headers((headers) -> headers.frameOptions(FrameOptionsConfig::sameOrigin));
		return http.build();
	}


}
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.Profile
import org.springframework.core.Ordered
import org.springframework.core.annotation.Order
import org.springframework.security.config.Customizer
import org.springframework.security.config.annotation.web.builders.HttpSecurity
import org.springframework.security.web.SecurityFilterChain

@Profile("dev")
@Configuration(proxyBeanMethods = false)
class DevProfileSecurityConfiguration {

	@Bean
	@Order(Ordered.HIGHEST_PRECEDENCE)
	fun h2ConsoleSecurityFilterChain(http: HttpSecurity): SecurityFilterChain {
		return http.authorizeHttpRequests(yourCustomAuthorization())
			.csrf { csrf -> csrf.disable() }
			.headers { headers -> headers.frameOptions { frameOptions -> frameOptions.sameOrigin() } }
			.build()
	}


}
H2 控制台仅用于开发。在生产环境中,禁用 CSRF 保护或允许网站使用框架可能会造成严重的安全风险。
PathRequest.toH2Console() 在控制台路径已自定义时也会返回正确的请求匹配器。

使用 jOOQ

jOOQ 面向对象查询 (jOOQ) 是 Data Geekery 的一个流行产品,它从您的数据库生成 Java 代码,并通过其流畅的 API 让您构建类型安全的 SQL 查询。商业版和开源版都可以与 Spring Boot 一起使用。

代码生成

为了使用 jOOQ 类型安全查询,您需要从数据库模式生成 Java 类。您可以按照 jOOQ 用户手册 中的说明进行操作。如果您使用 jooq-codegen-maven 插件,并且还使用 spring-boot-starter-parent “父 POM”,您可以安全地省略插件的 <version> 标签。您还可以使用 Spring Boot 定义的版本变量(例如 h2.version)来声明插件的数据库依赖项。以下列表显示了一个示例

<plugin>
	<groupId>org.jooq</groupId>
	<artifactId>jooq-codegen-maven</artifactId>
	<executions>
		...
	</executions>
	<dependencies>
		<dependency>
			<groupId>com.h2database</groupId>
			<artifactId>h2</artifactId>
			<version>${h2.version}</version>
		</dependency>
	</dependencies>
	<configuration>
		<jdbc>
			<driver>org.h2.Driver</driver>
			<url>jdbc:h2:~/yourdatabase</url>
		</jdbc>
		<generator>
			...
		</generator>
	</configuration>
</plugin>

使用 DSLContext

jOOQ 提供的流畅 API 通过 DSLContext 接口启动。Spring Boot 将 DSLContext 自动配置为 Spring Bean,并将其连接到您的应用程序 DataSource。要使用 DSLContext,您可以注入它,如下例所示

  • Java

  • Kotlin

import java.util.GregorianCalendar;
import java.util.List;

import org.jooq.DSLContext;

import org.springframework.stereotype.Component;

import static org.springframework.boot.docs.data.sql.jooq.dslcontext.Tables.AUTHOR;

@Component
public class MyBean {

	private final DSLContext create;

	public MyBean(DSLContext dslContext) {
		this.create = dslContext;
	}


}
import org.jooq.DSLContext
import org.springframework.stereotype.Component
import java.util.GregorianCalendar

@Component
class MyBean(private val create: DSLContext) {


}
jOOQ 手册倾向于使用名为 create 的变量来保存 DSLContext

然后,您可以使用 DSLContext 来构建查询,如下例所示

  • Java

  • Kotlin

	public List<GregorianCalendar> authorsBornAfter1980() {
		return this.create.selectFrom(AUTHOR)
			.where(AUTHOR.DATE_OF_BIRTH.greaterThan(new GregorianCalendar(1980, 0, 1)))
			.fetch(AUTHOR.DATE_OF_BIRTH);
	fun authorsBornAfter1980(): List<GregorianCalendar> {
		return create.selectFrom<Tables.TAuthorRecord>(Tables.AUTHOR)
			.where(Tables.AUTHOR?.DATE_OF_BIRTH?.greaterThan(GregorianCalendar(1980, 0, 1)))
			.fetch(Tables.AUTHOR?.DATE_OF_BIRTH)
	}

jOOQ SQL 方言

除非已配置 spring.jooq.sql-dialect 属性,否则 Spring Boot 会确定要用于数据源的 SQL 方言。如果 Spring Boot 无法检测到方言,它将使用 DEFAULT

Spring Boot 只能自动配置 jOOQ 开源版本支持的方言。

自定义 jOOQ

通过定义自己的 DefaultConfigurationCustomizer bean 可以实现更高级的自定义,该 bean 将在创建 Configuration @Bean 之前调用。这优先于自动配置应用的任何内容。

如果您想完全控制 jOOQ 配置,您还可以创建自己的 Configuration @Bean

使用 R2DBC

Reactive Relational Database Connectivity (R2DBC) 项目将响应式编程 API 带入关系数据库。R2DBC 的 Connection 提供了一种使用非阻塞数据库连接的标准方法。连接由 ConnectionFactory 提供,类似于 JDBC 的 DataSource

ConnectionFactory 配置由 spring.r2dbc.* 中的外部配置属性控制。例如,您可以在 application.properties 中声明以下部分

  • 属性

  • YAML

spring.r2dbc.url=r2dbc:postgresql:///test
spring.r2dbc.username=dbuser
spring.r2dbc.password=dbpass
spring:
  r2dbc:
    url: "r2dbc:postgresql:///test"
    username: "dbuser"
    password: "dbpass"
您无需指定驱动程序类名,因为 Spring Boot 从 R2DBC 的 Connection Factory 发现中获取驱动程序。
至少应提供 URL。URL 中指定的信息优先于单个属性,即 nameusernamepassword 和池化选项。
“操作指南”部分包含有关如何初始化数据库的章节

要自定义由 ConnectionFactory 创建的连接,即设置您不想(或不能)在中央数据库配置中配置的特定参数,您可以使用 ConnectionFactoryOptionsBuilderCustomizer @Bean。以下示例显示了如何手动覆盖数据库端口,而其他选项则从应用程序配置中获取

  • Java

  • Kotlin

import io.r2dbc.spi.ConnectionFactoryOptions;

import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyR2dbcConfiguration {

	@Bean
	public ConnectionFactoryOptionsBuilderCustomizer connectionFactoryPortCustomizer() {
		return (builder) -> builder.option(ConnectionFactoryOptions.PORT, 5432);
	}

}
import io.r2dbc.spi.ConnectionFactoryOptions
import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration(proxyBeanMethods = false)
class MyR2dbcConfiguration {

	@Bean
	fun connectionFactoryPortCustomizer(): ConnectionFactoryOptionsBuilderCustomizer {
		return ConnectionFactoryOptionsBuilderCustomizer { builder ->
			builder.option(ConnectionFactoryOptions.PORT, 5432)
		}
	}

}

以下示例展示了如何设置一些 PostgreSQL 连接选项

  • Java

  • Kotlin

import java.util.HashMap;
import java.util.Map;

import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider;

import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
public class MyPostgresR2dbcConfiguration {

	@Bean
	public ConnectionFactoryOptionsBuilderCustomizer postgresCustomizer() {
		Map<String, String> options = new HashMap<>();
		options.put("lock_timeout", "30s");
		options.put("statement_timeout", "60s");
		return (builder) -> builder.option(PostgresqlConnectionFactoryProvider.OPTIONS, options);
	}

}
import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider
import org.springframework.boot.r2dbc.autoconfigure.ConnectionFactoryOptionsBuilderCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration(proxyBeanMethods = false)
class MyPostgresR2dbcConfiguration {

	@Bean
	fun postgresCustomizer(): ConnectionFactoryOptionsBuilderCustomizer {
		val options: MutableMap<String, String> = HashMap()
		options["lock_timeout"] = "30s"
		options["statement_timeout"] = "60s"
		return ConnectionFactoryOptionsBuilderCustomizer { builder ->
			builder.option(PostgresqlConnectionFactoryProvider.OPTIONS, options)
		}
	}

}

ConnectionFactory bean 可用时,常规 JDBC DataSource 自动配置将回退。如果您想保留 JDBC DataSource 自动配置,并且愿意承担在响应式应用程序中使用阻塞 JDBC API 的风险,请在应用程序的 @Configuration 类上添加 @Import(DataSourceAutoConfiguration.class) 以重新启用它。

嵌入式数据库支持

JDBC 支持类似,Spring Boot 可以自动配置嵌入式数据库以用于响应式使用。您无需提供任何连接 URL。您只需包含对要使用的嵌入式数据库的构建依赖项,如下例所示

<dependency>
	<groupId>io.r2dbc</groupId>
	<artifactId>r2dbc-h2</artifactId>
	<scope>runtime</scope>
</dependency>

如果您在测试中使用此功能,您可能会注意到无论您使用多少个应用程序上下文,整个测试套件都会重复使用相同的数据库。如果您希望确保每个上下文都有一个单独的嵌入式数据库,您应该将 spring.r2dbc.generate-unique-name 设置为 true

使用 DatabaseClient

一个 DatabaseClient bean 是自动配置的,您可以将其直接自动注入到您自己的 bean 中,如下例所示

  • Java

  • Kotlin

import java.util.Map;

import reactor.core.publisher.Flux;

import org.springframework.r2dbc.core.DatabaseClient;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final DatabaseClient databaseClient;

	public MyBean(DatabaseClient databaseClient) {
		this.databaseClient = databaseClient;
	}

	// ...

	public Flux<Map<String, Object>> someMethod() {
		return this.databaseClient.sql("select * from user").fetch().all();
	}

}
import org.springframework.r2dbc.core.DatabaseClient
import org.springframework.stereotype.Component
import reactor.core.publisher.Flux

@Component
class MyBean(private val databaseClient: DatabaseClient) {

	// ...

	fun someMethod(): Flux<Map<String, Any>> {
		return databaseClient.sql("select * from user").fetch().all()
	}

}

Spring Data R2DBC 存储库

Spring Data R2DBC 存储库是您可以定义来访问数据的接口。查询是根据您的方法名称自动创建的。例如,CityRepository 接口可以声明一个 findAllByState(String state) 方法来查找给定状态中的所有城市。

对于更复杂的查询,您可以使用 Spring Data 的 @Query 注解来标注您的方法。

Spring Data 存储库通常扩展自 RepositoryCrudRepository 接口。如果您使用自动配置,自动配置包 会被搜索以查找存储库。

以下示例显示了一个典型的 Spring Data 存储库接口定义

  • Java

  • Kotlin

import reactor.core.publisher.Mono;

import org.springframework.data.repository.Repository;

public interface CityRepository extends Repository<City, Long> {

	Mono<City> findByNameAndStateAllIgnoringCase(String name, String state);

}
import org.springframework.data.repository.Repository
import reactor.core.publisher.Mono

interface CityRepository : Repository<City, Long> {

	fun findByNameAndStateAllIgnoringCase(name: String, state: String): Mono<City>

}
我们刚刚触及了 Spring Data R2DBC 的皮毛。有关完整详细信息,请参阅 Spring Data R2DBC 参考文档
© . This site is unofficial and not affiliated with VMware.