SQL 数据库

Spring Framework 为使用 SQL 数据库提供了广泛的支持,从JdbcClientJdbcTemplate以完成“对象关系映射”技术,例如 Hibernate。Spring Data 提供了额外的功能级别:创建Repository直接从接口实现,并使用约定从方法名称生成查询。spring-doc.cadn.net.cn

配置数据源

Java 的DataSource接口提供了一种处理数据库连接的标准方法。传统上,一个DataSource使用URL以及一些用于建立数据库连接的凭据。spring-doc.cadn.net.cn

有关更高级的示例,请参阅“作指南”的配置自定义数据源部分,通常用于完全控制数据源的配置。

嵌入式数据库支持

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

“作指南”部分包括有关如何初始化数据库的部分

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

如果您在测试中使用此功能,您可能会注意到,无论您使用的应用程序上下文数量如何,整个测试套件都会重用相同的数据库。如果要确保每个上下文都有一个单独的嵌入式数据库,则应将spring.datasource.generate-unique-nametrue.spring-doc.cadn.net.cn

例如,典型的 POM 依赖项如下:spring-doc.cadn.net.cn

<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.spring-doc.cadn.net.cn

数据源配置

数据源配置由spring.datasource.*. 例如,您可以在application.properties:spring-doc.cadn.net.cn

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

DataSourceProperties有关更多支持选项的 API 文档。 这些是无论实际实现如何都有效的标准选项。 还可以使用它们各自的前缀 (spring.datasource.hikari.*,spring.datasource.tomcat.*,spring.datasource.dbcp2.*spring.datasource.oracleucp.*). 有关更多详细信息,请参阅您正在使用的连接池实现的文档。spring-doc.cadn.net.cn

例如,如果使用 Tomcat 连接池,则可以自定义许多其他设置,如以下示例所示:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

支持的连接池

Spring Boot 使用以下算法来选择特定的实现:spring-doc.cadn.net.cn

  1. 我们更喜欢 HikariCP,因为它的性能和并发性。 如果 HikariCP 可用,我们总是选择它。spring-doc.cadn.net.cn

  2. 否则,如果 Tomcat 池化DataSource可用,我们使用它。spring-doc.cadn.net.cn

  3. 否则,如果共享资源 DBCP2 可用,我们使用它。spring-doc.cadn.net.cn

  4. 如果 HikariCP、Tomcat 和 DBCP2 都不可用,并且 Oracle UCP 可用,我们使用它。spring-doc.cadn.net.cn

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

您可以完全绕过该算法,并通过设置spring.datasource.type财产。 如果您在 Tomcat 容器中运行应用程序,这一点尤其重要,因为tomcat-jdbc默认提供。spring-doc.cadn.net.cn

其他连接池始终可以手动配置,使用DataSourceBuilder. 如果您定义自己的DataSourcebean,则不会发生自动配置。 以下连接池由以下连接池支持DataSourceBuilder:spring-doc.cadn.net.cn

连接到 JNDI 数据源

如果将 Spring Boot 应用程序部署到应用程序服务器,则可能需要使用应用程序服务器的内置功能配置和管理数据源,并使用 JNDI 访问它。spring-doc.cadn.net.cn

spring.datasource.jndi-name属性可以用作spring.datasource.url,spring.datasource.usernamespring.datasource.password属性以访问DataSource从特定的 JNDI 位置。 例如,以下部分application.properties显示了如何访问 JBoss AS 定义的DataSource:spring-doc.cadn.net.cn

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

使用 JdbcTemplate

Spring的JdbcTemplateNamedParameterJdbcTemplate类是自动配置的,您可以将它们直接自动连接到您自己的 bean,如以下示例所示:spring-doc.cadn.net.cn

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.*属性,如以下示例所示:spring-doc.cadn.net.cn

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

如果需要调整 SQL 异常,您可以定义自己的SQLExceptionTranslatorbean,以便它与自动配置的JdbcTemplate.spring-doc.cadn.net.cn

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

使用 JdbcClient

Spring的JdbcClient根据NamedParameterJdbcTemplate. 您也可以将其直接注入到您自己的 bean 中,如以下示例所示:spring-doc.cadn.net.cn

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.*客户端中也会考虑属性。spring-doc.cadn.net.cn

JPA 和 Spring Data JPA

Java Persistence API 是一种标准技术,可让您将对象“映射”到关系数据库。 这spring-boot-starter-data-jpaPOM 提供了一种快速入门的方法。 它提供以下关键依赖项:spring-doc.cadn.net.cn

我们在这里不讨论太多关于 JPA 或 Spring Data 的细节。 您可以按照 spring.io 中的 使用 JPA 访问数据指南进行作,并阅读 Spring Data JPAHibernate 参考文档。

实体类

传统上,JPA“实体”类在persistence.xml文件。 对于 Spring Boot,不需要此文件,而是使用“实体扫描”。 默认情况下,将扫描自动配置包spring-doc.cadn.net.cn

任何用@Entity,@Embeddable@MappedSuperclass被考虑。 典型的实体类类似于以下示例:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

对于更复杂的查询,您可以使用 Spring Data 的Query注解。spring-doc.cadn.net.cn

Spring Data 存储库通常从RepositoryCrudRepository接口。 如果使用自动配置,则会在自动配置包中搜索存储库。spring-doc.cadn.net.cn

您可以使用以下命令自定义位置以查找存储库@EnableJpaRepositories.

以下示例显示了典型的 Spring Data 存储库接口定义:spring-doc.cadn.net.cn

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将使用 context 的AsyncTaskExecutor,如果有,作为引导执行器。 如果存在多个,则名为applicationTaskExecutor将被使用。spring-doc.cadn.net.cn

使用延迟或延迟引导时,请确保在应用程序上下文引导阶段之后延迟对 JPA 基础架构的任何访问。 您可以使用SmartInitializingSingleton调用需要 JPA 基础架构的任何初始化。 对于创建为 Spring bean 的 JPA 组件(例如转换器),请使用ObjectProvider延迟依赖关系的解析(如果有)。spring-doc.cadn.net.cn

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

Spring Data Envers 存储库

如果 Spring Data Envers 可用,则会自动配置 JPA 存储库以支持典型的 Envers 查询。spring-doc.cadn.net.cn

要使用 Spring Data Envers,请确保您的存储库从RevisionRepository如以下示例所示:spring-doc.cadn.net.cn

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 数据库

缺省情况下,仅当您使用嵌入式数据库(H2、HSQL 或 Derby)时,会自动创建 JPA 数据库。 您可以使用以下命令显式配置 JPA 设置spring.jpa.*性能。 例如,要创建和删除表,您可以将以下行添加到application.properties:spring-doc.cadn.net.cn

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

前面示例中的行传递值true对于hibernate.globally_quoted_identifiers属性添加到 Hibernate 实体管理器。spring-doc.cadn.net.cn

默认情况下,DDL 执行(或验证)将延迟到ApplicationContext已经开始了。spring-doc.cadn.net.cn

在视图中打开 EntityManager

如果您正在运行 Web 应用程序,则默认情况下 Spring Boot 会注册OpenEntityManagerInViewInterceptor以应用“在视图中打开 EntityManager”模式,以允许在 Web 视图中延迟加载。 如果您不希望此行为,则应将spring.jpa.open-in-viewfalse在你的application.properties.spring-doc.cadn.net.cn

Spring Data JDBC

Spring Data 包括对 JDBC 的存储库支持,并将自动为CrudRepository. 对于更高级的查询,一个@Query提供了注释。spring-doc.cadn.net.cn

当类路径上存在必要的依赖项时,Spring Boot 将自动配置 Spring Data 的 JDBC 存储库。 它们可以通过单个依赖项添加到您的项目中spring-boot-starter-data-jdbc. 如有必要,您可以通过添加@EnableJdbcRepositories注释或AbstractJdbcConfiguration子类添加到您的应用程序。spring-doc.cadn.net.cn

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

使用 H2 的 Web 控制台

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

如果您没有使用 Spring Boot 的开发人员工具,但仍想使用 H2 的控制台,您可以配置spring.h2.console.enabled值为true.
H2 控制台仅供开发期间使用,因此应注意确保spring.h2.console.enabled未设置为true在生产中。

更改 H2 控制台的路径

默认情况下,控制台位于/h2-console. 您可以使用spring.h2.console.path财产。spring-doc.cadn.net.cn

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

H2 控制台使用帧,由于它仅用于开发,因此不实施 CSRF 保护措施。 如果您的应用程序使用 Spring Security,则需要将其配置为spring-doc.cadn.net.cn

有关 CSRF 和标头 X-Frame-Options 的更多信息,请参阅 Spring Security 参考指南。spring-doc.cadn.net.cn

在简单的设置中,一个SecurityFilterChain可以使用以下内容:spring-doc.cadn.net.cn

import org.springframework.boot.autoconfigure.security.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) throws Exception {
		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 一起使用。spring-doc.cadn.net.cn

代码生成

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

<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,您可以注入它,如以下示例所示:spring-doc.cadn.net.cn

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构造查询,如以下示例所示:spring-doc.cadn.net.cn

	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-doc.cadn.net.cn

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

自定义 jOOQ

可以通过定义您自己的自定义来实现更高级的自定义DefaultConfigurationCustomizerbean,该 bean 将在创建Configuration @Bean. 这优先于自动配置应用的任何内容。spring-doc.cadn.net.cn

您也可以创建自己的Configuration @Bean如果您想完全控制 jOOQ 配置。spring-doc.cadn.net.cn

使用 R2DBC

响应式关系数据库连接 (R2DBC) 项目将响应式编程 API 引入关系数据库。 R2DBC 的Connection提供了一种使用非阻塞数据库连接的标准方法。 连接是通过使用ConnectionFactory,类似于DataSource与 JDBC。spring-doc.cadn.net.cn

ConnectionFactory配置由spring.r2dbc.*. 例如,您可以在application.properties:spring-doc.cadn.net.cn

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

要自定义由ConnectionFactory,即设置您不想(或不能)在中央数据库配置中配置的特定参数,您可以使用ConnectionFactoryOptionsBuilderCustomizer @Bean. 以下示例演示如何手动覆盖数据库端口,而其余选项则取自应用程序配置:spring-doc.cadn.net.cn

import io.r2dbc.spi.ConnectionFactoryOptions;

import org.springframework.boot.autoconfigure.r2dbc.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.autoconfigure.r2dbc.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连接选项:spring-doc.cadn.net.cn

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

import io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider;

import org.springframework.boot.autoconfigure.r2dbc.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.autoconfigure.r2dbc.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)
		}
	}

}

ConnectionFactorybean 可用,常规 JDBCDataSource自动配置回退。 如果要保留 JDBCDataSourceauto-configuration 中,并且对在响应式应用程序中使用阻塞 JDBC API 的风险感到满意,请添加@Import(DataSourceAutoConfiguration.class)@Configuration类以重新启用它。spring-doc.cadn.net.cn

嵌入式数据库支持

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

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

如果您在测试中使用此功能,您可能会注意到,无论您使用的应用程序上下文数量如何,整个测试套件都会重用相同的数据库。如果要确保每个上下文都有一个单独的嵌入式数据库,则应将spring.r2dbc.generate-unique-nametrue.spring-doc.cadn.net.cn

使用 DatabaseClient

一个DatabaseClientbean 是自动配置的,您可以将其直接自动连接到您自己的 bean,如以下示例所示:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

对于更复杂的查询,您可以使用 Spring Data 的@Query注解。spring-doc.cadn.net.cn

Spring Data 存储库通常从RepositoryCrudRepository接口。 如果使用自动配置,则会在自动配置包中搜索存储库。spring-doc.cadn.net.cn

以下示例显示了典型的 Spring Data 存储库接口定义:spring-doc.cadn.net.cn

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 参考文档