数据

1. SQL数据库

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

1.1. 配置数据源

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

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

1.1.1. 嵌入式数据库支持

使用内存嵌入式数据库开发应用程序通常很方便。 显然,内存数据库不提供持久存储。 您需要在应用程序启动时填充数据库,并准备好在应用程序结束时丢弃数据。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 控制数据库何时关闭,从而确保在不再需要访问数据库时发生关闭。

1.1.2. 连接到生产数据库

还可以使用池自动配置生产数据库连接DataSource.spring-doc.cadn.net.cn

1.1.3. 数据源配置

数据源配置由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以获取更多支持的选项。 这些是无论实际实现如何都有效的标准选项。 还可以使用它们各自的前缀 (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

1.1.4. 支持的连接池

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“starters”,则会自动获得对HikariCP.

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

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

1.1.5. 连接到 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"

1.2. 使用 JdbcTemplate

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

Java
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 ...
    }

}
Kotlin
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
NamedParameterJdbcTemplate重复使用相同的JdbcTemplate幕后实例。 如果多个JdbcTemplate定义且不存在主要候选者,则NamedParameterJdbcTemplate未自动配置。

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

1.3.1. 实体类

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

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

Java
import java.io.Serializable;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.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

}
Kotlin
import java.io.Serializable
import javax.persistence.Column
import javax.persistence.Entity
import javax.persistence.GeneratedValue
import javax.persistence.Id

@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注解。 请参阅“howto.html”作方法。

1.3.2. 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

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

}
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

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

1.3.3. Spring Data Envers 存储库

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

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

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

}
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

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

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

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

1.3.4. 创建和删除 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.jpa.generate-ddl标志,但如果 Hibernate 自动配置处于活动状态,则不会使用它,因为ddl-auto设置更加细粒度。spring-doc.cadn.net.cn

1.3.5. 在视图中打开 EntityManager

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

1.4. 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 的完整详细信息,请参阅参考文档

1.5. 使用 H2 的 Web 控制台

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

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

1.5.1. 更改 H2 控制台的路径

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

1.5.2. 在安全应用程序中访问 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

Java
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.web.SecurityFilterChain;

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

    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    SecurityFilterChain h2ConsoleSecurityFilterChain(HttpSecurity http) throws Exception {
        http.requestMatcher(PathRequest.toH2Console());
        http.authorizeRequests(yourCustomAuthorization());
        http.csrf((csrf) -> csrf.disable());
        http.headers((headers) -> headers.frameOptions().sameOrigin());
        return http.build();
    }


}
Kotlin
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().disable()
            .headers().frameOptions().sameOrigin().and()
            .build()
    }


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

1.6. 使用 jOOQ

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

1.6.1. 代码生成

为了使用 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>

1.6.2. 使用 DSLContext

jOOQ 提供的流畅 API 是通过org.jooq.DSLContext接口。 Spring Boot 自动配置一个DSLContext作为 Spring Bean 并将其连接到您的应用程序DataSource. 要使用DSLContext,您可以注入它,如以下示例所示:spring-doc.cadn.net.cn

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


}
Kotlin
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

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

1.6.3. jOOQ SQL 方言

除非spring.jooq.sql-dialect属性,Spring Boot 确定要用于数据源的 SQL 方言。 如果 Spring Boot 无法检测到方言,它会使用DEFAULT.spring-doc.cadn.net.cn

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

1.6.4. 自定义 jOOQ

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

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

1.7. 使用 R2DBC

响应式关系数据库连接 (R2DBC) 项目将响应式编程 API 引入关系数据库。 R2DBC 的io.r2dbc.spi.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

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

}
Kotlin
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

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

}
Kotlin
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

1.7.1. 嵌入式数据库支持

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

1.7.2. 使用 DatabaseClient

一个DatabaseClientbean 是自动配置的,您可以@Autowire它直接放入您自己的 bean中,如以下示例所示:spring-doc.cadn.net.cn

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

}
Kotlin
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()
    }

}

1.7.3. 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

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

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

2. 使用 NoSQL 技术

Spring Data 提供了其他项目来帮助您访问各种 NoSQL 技术,包括:spring-doc.cadn.net.cn

其中,Spring Boot 为 Cassandra、Couchbase、Elasticsearch、LDAP、MongoDB、Neo4J 和 Redis 提供了自动配置。 此外,Spring Boot for Apache GeodeApache Geode 提供自动配置。 您可以使用其他项目,但必须自行配置它们。 请参阅 spring.io/projects/spring-data 的相应参考文档。spring-doc.cadn.net.cn

Spring Boot 还为 InfluxDB 和 Solr 客户端提供自动配置。spring-doc.cadn.net.cn

2.1. Redis的

Redis 是一个缓存、消息代理和功能丰富的键值存储。 Spring Boot 为 LettuceJedis 客户端库以及 Spring Data Redis 提供的抽象提供了基本的自动配置。spring-doc.cadn.net.cn

有一个spring-boot-starter-data-redis“Starter”,用于以方便的方式收集依赖项。 默认情况下,它使用 Lettuce。 该Starters可以处理传统和响应式应用程序。spring-doc.cadn.net.cn

我们还提供spring-boot-starter-data-redis-reactive“Starter”与其他具有反应性支持的商店保持一致。

2.1.1. 连接到 Redis

您可以注入自动配置的RedisConnectionFactory,StringRedisTemplate或香草RedisTemplate实例,就像你对待任何其他 Spring Bean 一样。 以下列表显示了此类 bean 的示例:spring-doc.cadn.net.cn

Java
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final StringRedisTemplate template;

    public MyBean(StringRedisTemplate template) {
        this.template = template;
    }

    // ...

    public Boolean someMethod() {
        return this.template.hasKey("spring");
    }

}
Kotlin
import org.springframework.data.redis.core.StringRedisTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val template: StringRedisTemplate) {

    // ...

    fun someMethod(): Boolean {
        return template.hasKey("spring")
    }

}

默认情况下,实例会尝试连接到位于localhost:6379. 您可以使用以下命令指定自定义连接详细信息spring.redis.*属性,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.redis.host=localhost
spring.redis.port=6379
spring.redis.database=0
spring.redis.username=user
spring.redis.password=secret
亚姆尔
spring:
  redis:
    host: "localhost"
    port: 6379
    database: 0
    username: "user"
    password: "secret"
您还可以注册任意数量的 bean,以实现LettuceClientConfigurationBuilderCustomizer用于更高级的自定义。ClientResources也可以使用ClientResourcesBuilderCustomizer. 如果你使用 Jedis,JedisClientConfigurationBuilderCustomizer也可用。 或者,您可以注册类型为RedisStandaloneConfiguration,RedisSentinelConfigurationRedisClusterConfiguration以完全控制配置。

如果您添加自己的@Bean在任何自动配置的类型中,它都会替换默认值(除非RedisTemplate,当排除基于 Bean 名称时,redisTemplate,而不是其类型)。spring-doc.cadn.net.cn

默认情况下,如果出现以下情况,则会自动配置池连接工厂commons-pool2在类路径上。spring-doc.cadn.net.cn

2.2. Mongo数据库

MongoDB 是一个开源 NoSQL 文档数据库,它使用类似 JSON 的模式而不是传统的基于表的关系数据。 Spring Boot 为使用 MongoDB 提供了多种便利,包括spring-boot-starter-data-mongodbspring-boot-starter-data-mongodb-reactive“Starters”。spring-doc.cadn.net.cn

2.2.1. 连接到MongoDB数据库

要访问 MongoDB 数据库,您可以注入自动配置的org.springframework.data.mongodb.MongoDatabaseFactory. 默认情况下,实例会尝试连接到位于mongodb://localhost/test. 以下示例显示了如何连接到 MongoDB 数据库:spring-doc.cadn.net.cn

Java
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
import org.bson.Document;

import org.springframework.data.mongodb.MongoDatabaseFactory;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final MongoDatabaseFactory mongo;

    public MyBean(MongoDatabaseFactory mongo) {
        this.mongo = mongo;
    }

    // ...

    public MongoCollection<Document> someMethod() {
        MongoDatabase db = this.mongo.getMongoDatabase();
        return db.getCollection("users");
    }

}
Kotlin
import com.mongodb.client.MongoCollection
import org.bson.Document
import org.springframework.data.mongodb.MongoDatabaseFactory
import org.springframework.stereotype.Component

@Component
class MyBean(private val mongo: MongoDatabaseFactory) {

    // ...

    fun someMethod(): MongoCollection<Document> {
        val db = mongo.mongoDatabase
        return db.getCollection("users")
    }

}

如果您已经定义了自己的MongoClient,它将用于自动配置合适的MongoDatabaseFactory.spring-doc.cadn.net.cn

自动配置的MongoClient是使用MongoClientSettings豆。 如果您已经定义了自己的MongoClientSettings,它将不加修改地使用,并且spring.data.mongodb属性将被忽略。否则MongoClientSettings将自动配置,并且将具有spring.data.mongodb属性。无论哪种情况,您都可以声明一个或多个MongoClientSettingsBuilderCustomizerbean 来微调MongoClientSettings配置。 每个都将按顺序调用,并使用MongoClientSettings.Builder用于构建MongoClientSettings.spring-doc.cadn.net.cn

您可以将spring.data.mongodb.uri属性来更改 URL 并配置其他设置,例如副本集,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.data.mongodb.uri=mongodb://user:[email protected]:12345,mongo2.example.com:23456/test
亚姆尔
spring:
  data:
    mongodb:
      uri: "mongodb://user:[email protected]:12345,mongo2.example.com:23456/test"

或者,您可以使用离散属性指定连接详细信息。 例如,您可以在application.properties:spring-doc.cadn.net.cn

性能
spring.data.mongodb.host=mongoserver.example.com
spring.data.mongodb.port=27017
spring.data.mongodb.database=test
spring.data.mongodb.username=user
spring.data.mongodb.password=secret
亚姆尔
spring:
  data:
    mongodb:
      host: "mongoserver.example.com"
      port: 27017
      database: "test"
      username: "user"
      password: "secret"
如果spring.data.mongodb.port未指定,则默认值为27017被使用。 可以从前面显示的示例中删除此行。
如果您不使用 Spring Data MongoDB,则可以注入MongoClientbean 而不是使用MongoDatabaseFactory. 如果您想完全控制建立 MongoDB 连接,您还可以声明自己的MongoDatabaseFactoryMongoClient豆。
如果您使用的是响应式驱动程序,则 SSL 需要 Netty。 如果 Netty 可用且要使用的工厂尚未自定义,则自动配置会自动配置此工厂。

2.2.2. Mongo模板

Spring Data MongoDB 提供了一个MongoTemplate类,其设计与 Spring 的JdbcTemplate. 与JdbcTemplate,Spring Boot 会自动配置一个 bean 供你注入模板,如下所示:spring-doc.cadn.net.cn

Java
import com.mongodb.client.MongoCollection;
import org.bson.Document;

import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final MongoTemplate mongoTemplate;

    public MyBean(MongoTemplate mongoTemplate) {
        this.mongoTemplate = mongoTemplate;
    }

    // ...

    public MongoCollection<Document> someMethod() {
        return this.mongoTemplate.getCollection("users");
    }

}
Kotlin
import com.mongodb.client.MongoCollection
import org.bson.Document
import org.springframework.data.mongodb.core.MongoTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val mongoTemplate: MongoTemplate) {

    // ...

    fun someMethod(): MongoCollection<Document> {
        return mongoTemplate.getCollection("users")
    }

}

请参阅MongoOperationsJavadoc获取完整详细信息。spring-doc.cadn.net.cn

2.2.3. Spring Data MongoDB 存储库

Spring Data 包括对 MongoDB 的存储库支持。 与前面讨论的 JPA 存储库一样,基本原则是根据方法名称自动构造查询。spring-doc.cadn.net.cn

事实上,Spring Data JPA 和 Spring Data MongoDB 共享相同的公共基础设施。 您可以以前面的 JPA 为例,假设City现在是一个 MongoDB 数据类,而不是 JPA@Entity,它的工作方式相同,如以下示例所示:spring-doc.cadn.net.cn

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

}
Kotlin
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?
}

通过扫描找到存储库和文档。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和文档@EnableMongoRepositories@EntityScan分别。spring-doc.cadn.net.cn

有关 Spring Data MongoDB 的完整详细信息,包括其丰富的对象映射技术,请参阅其参考文档

2.2.4. 嵌入式 Mongo

Spring Boot 为嵌入式 Mongo 提供自动配置。 要在 Spring Boot 应用程序中使用它,请添加一个依赖项de.flapdoodle.embed:de.flapdoodle.embed.mongo并将spring.mongodb.embedded.version属性以匹配您的应用程序将在生产中使用的 MongoDB 版本。spring-doc.cadn.net.cn

默认下载配置允许访问嵌入式 Mongo 的Version以及其他一些。 配置无法访问的版本将导致尝试下载服务器时出错。 可以通过定义适当配置的DownloadConfigBuilderCustomizer豆。

Mongo 监听的端口可以通过设置spring.data.mongodb.port财产。 要使用随机分配的可用端口,请使用值 0。 这MongoClient创建者MongoAutoConfiguration自动配置为使用随机分配的端口。spring-doc.cadn.net.cn

如果未配置自定义端口,则默认情况下,嵌入式支持使用随机端口(而不是 27017)。

如果类路径上有 SLF4J,则 Mongo 生成的输出会自动路由到名为org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongo.spring-doc.cadn.net.cn

您可以声明自己的IMongodConfigIRuntimeConfigbean 来控制 Mongo 实例的配置和日志记录路由。 可以通过声明DownloadConfigBuilderCustomizer豆。spring-doc.cadn.net.cn

2.3. Neo4j

Neo4j 是一个开源的 NoSQL 图数据库,它使用通过一等关系连接的节点的丰富数据模型,与传统的 RDBMS 方法相比,它更适合连接大数据。 Spring Boot 为使用 Neo4j 提供了多种便利,包括spring-boot-starter-data-neo4j“入门”。spring-doc.cadn.net.cn

2.3.1. 连接到 Neo4j 数据库

要访问 Neo4j 服务器,您可以注入一个自动配置的org.neo4j.driver.Driver. 默认情况下,实例会尝试连接到localhost:7687使用 Bolt 协议。 以下示例展示了如何注入 Neo4jDriver这使您可以访问Session:spring-doc.cadn.net.cn

Java
import org.neo4j.driver.Driver;
import org.neo4j.driver.Session;
import org.neo4j.driver.Values;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final Driver driver;

    public MyBean(Driver driver) {
        this.driver = driver;
    }

    // ...

    public String someMethod(String message) {
        try (Session session = this.driver.session()) {
            return session.writeTransaction(
                    (transaction) -> transaction
                        .run("CREATE (a:Greeting) SET a.message = $message RETURN a.message + ', from node ' + id(a)",
                                Values.parameters("message", message))
                        .single()
                        .get(0)
                        .asString());
        }
    }

}
Kotlin
import org.neo4j.driver.Driver
import org.neo4j.driver.Transaction
import org.neo4j.driver.Values
import org.springframework.stereotype.Component

@Component
class MyBean(private val driver: Driver) {

    // ...

    fun someMethod(message: String?): String {
        driver.session().use { session ->
            return@someMethod session.writeTransaction { transaction: Transaction ->
                transaction.run(
                    "CREATE (a:Greeting) SET a.message = \$message RETURN a.message + ', from node ' + id(a)",
                    Values.parameters("message", message)
                ).single()[0].asString()
            }
        }
    }

}

您可以使用spring.neo4j.*性能。 以下示例演示如何配置要使用的 uri 和凭据:spring-doc.cadn.net.cn

性能
spring.neo4j.uri=bolt://my-server:7687
spring.neo4j.authentication.username=neo4j
spring.neo4j.authentication.password=secret
亚姆尔
spring:
  neo4j:
    uri: "bolt://my-server:7687"
    authentication:
      username: "neo4j"
      password: "secret"

自动配置的Driver使用ConfigBuilder. 要微调其配置,请声明一个或多个ConfigBuilderCustomizer豆。 每个都将按顺序调用,并使用ConfigBuilder用于构建Driver.spring-doc.cadn.net.cn

2.3.2. Spring Data Neo4j 存储库

Spring Data 包括对 Neo4j 的存储库支持。 有关 Spring Data Neo4j 的完整详细信息,请参阅参考文档spring-doc.cadn.net.cn

Spring Data Neo4j 与 Spring Data JPA 共享公共基础设施,就像许多其他 Spring Data 模块一样。 您可以采用前面的 JPA 示例并定义City作为 Spring Data Neo4j@Node而不是 JPA@Entity存储库抽象的工作方式相同,如以下示例所示:spring-doc.cadn.net.cn

Java
import java.util.Optional;

import org.springframework.data.neo4j.repository.Neo4jRepository;

public interface CityRepository extends Neo4jRepository<City, Long> {

    Optional<City> findOneByNameAndState(String name, String state);

}
Kotlin
import org.springframework.data.neo4j.repository.Neo4jRepository
import java.util.Optional

interface CityRepository : Neo4jRepository<City?, Long?> {

    fun findOneByNameAndState(name: String?, state: String?): Optional<City?>?

}

spring-boot-starter-data-neo4j“Starter”启用存储库支持以及事务管理。 Spring Boot 支持经典和响应式 Neo4j 存储库,使用Neo4jTemplateReactiveNeo4jTemplate豆。 当 Project Reactor 在类路径上可用时,响应式样式也会自动配置。spring-doc.cadn.net.cn

存储库和实体是通过扫描找到的。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和实体@EnableNeo4jRepositories@EntityScan分别。spring-doc.cadn.net.cn

在使用响应式样式的应用程序中,ReactiveTransactionManager未自动配置。 要启用事务管理,必须在配置中定义以下 bean:spring-doc.cadn.net.cn

Java
import org.neo4j.driver.Driver;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.neo4j.core.ReactiveDatabaseSelectionProvider;
import org.springframework.data.neo4j.core.transaction.ReactiveNeo4jTransactionManager;

@Configuration(proxyBeanMethods = false)
public class MyNeo4jConfiguration {

    @Bean
    public ReactiveNeo4jTransactionManager reactiveTransactionManager(Driver driver,
            ReactiveDatabaseSelectionProvider databaseNameProvider) {
        return new ReactiveNeo4jTransactionManager(driver, databaseNameProvider);
    }

}
Kotlin
import org.neo4j.driver.Driver
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.data.neo4j.core.ReactiveDatabaseSelectionProvider
import org.springframework.data.neo4j.core.transaction.ReactiveNeo4jTransactionManager

@Configuration(proxyBeanMethods = false)
class MyNeo4jConfiguration {

    @Bean
    fun reactiveTransactionManager(driver: Driver,
            databaseNameProvider: ReactiveDatabaseSelectionProvider): ReactiveNeo4jTransactionManager {
        return ReactiveNeo4jTransactionManager(driver, databaseNameProvider)
    }
}

2.4. 索尔

Apache Solr 是一个搜索引擎。 Spring Boot 为 Solr 5 客户端库提供基本的自动配置。spring-doc.cadn.net.cn

2.4.1. 连接到 Solr

您可以注入自动配置的SolrClient实例,就像你对待任何其他 Spring bean 一样。 默认情况下,实例会尝试连接到localhost:8983/solr. 以下示例显示了如何注入 Solr bean:spring-doc.cadn.net.cn

Java
import java.io.IOException;

import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.response.SolrPingResponse;

import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final SolrClient solr;

    public MyBean(SolrClient solr) {
        this.solr = solr;
    }

    // ...

    public SolrPingResponse someMethod() throws SolrServerException, IOException {
        return this.solr.ping("users");
    }

}
Kotlin
import org.apache.solr.client.solrj.SolrClient
import org.apache.solr.client.solrj.response.SolrPingResponse
import org.springframework.stereotype.Component

@Component
class MyBean(private val solr: SolrClient) {

    // ...

    fun someMethod(): SolrPingResponse {
        return solr.ping("users")
    }

}

如果您添加自己的@Bean类型SolrClient,它将替换默认值。spring-doc.cadn.net.cn

2.5. 弹性搜索

Elasticsearch 是一个开源、分布式、RESTful 的搜索和分析引擎。 Spring Boot 为 Elasticsearch 客户端提供基本的自动配置。spring-doc.cadn.net.cn

Spring Boot 支持多个客户端:spring-doc.cadn.net.cn

Spring Boot 提供了一个专用的“Starter”,spring-boot-starter-data-elasticsearch.spring-doc.cadn.net.cn

2.5.1. 使用 REST 客户端连接到 Elasticsearch

Elasticsearch 提供了两个不同的 REST 客户端,可用于查询集群:来自org.elasticsearch.client:elasticsearch-rest-client模块和高级客户端org.elasticsearch.client:elasticsearch-high-level-client模块。 此外,Spring Boot 基于 Spring Framework 的WebClient,从org.springframework.data:spring-data-elasticsearch模块。 默认情况下,客户端将以localhost:9200. 您可以使用spring.elasticsearch.*属性以进一步调整客户端的配置方式,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.elasticsearch.uris=https://search.example.com:9200
spring.elasticsearch.socket-timeout=10s
spring.elasticsearch.username=user
spring.elasticsearch.password=secret
亚姆尔
spring:
  elasticsearch:
    uris: "https://search.example.com:9200"
    socket-timeout: "10s"
    username: "user"
    password: "secret"
使用 RestClient 连接到 Elasticsearch

如果您有elasticsearch-rest-client在类路径上,Spring Boot 将自动配置并注册一个RestClient豆。 如果您有elasticsearch-rest-high-level-client在类路径上RestHighLevelClientbean 也将被自动配置。在 Elasticsearch 弃用RestHighLevelClient,其自动配置已弃用,并将在将来的版本中删除。除了前面描述的属性之外,要微调RestClientRestHighLevelClient,您可以注册任意数量的 bean,以实现RestClientBuilderCustomizer用于更高级的自定义。 要完全控制客户端的配置,请定义一个RestClientBuilder豆。spring-doc.cadn.net.cn

此外,如果elasticsearch-rest-client-sniffer在类路径上,则Sniffer自动配置为自动从正在运行的 Elasticsearch 集群中发现节点,并将其设置为RestClient豆。 您可以进一步调整如何Sniffer,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.elasticsearch.restclient.sniffer.interval=10m
spring.elasticsearch.restclient.sniffer.delay-after-failure=30s
亚姆尔
spring:
  elasticsearch:
    restclient:
      sniffer:
        interval: "10m"
        delay-after-failure: "30s"
使用 ReactiveElasticsearchClient 连接到 Elasticsearch

Spring Data Elasticsearch 发布ReactiveElasticsearchClient以响应式方式查询 Elasticsearch 实例。 它建立在 WebFlux 的WebClient,所以两者spring-boot-starter-elasticsearchspring-boot-starter-webflux依赖项对于启用此支持很有用。spring-doc.cadn.net.cn

默认情况下,Spring Boot 将自动配置并注册一个ReactiveElasticsearchClient. 除了前面描述的属性之外,spring.elasticsearch.webclient.*属性可用于配置特定于响应式的设置,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.elasticsearch.webclient.max-in-memory-size=1MB
亚姆尔
spring:
  elasticsearch:
    webclient:
      max-in-memory-size: "1MB"

如果spring.elasticsearch.spring.elasticsearch.webclient.配置属性不够,并且您想完全控制客户端配置,您可以注册自定义ClientConfiguration豆。spring-doc.cadn.net.cn

2.5.2. 使用 Spring Data 连接到 Elasticsearch

要连接到 Elasticsearch,请使用RestHighLevelClientbean 必须被定义, 由 Spring Boot 自动配置或由应用程序手动提供(请参阅前面的部分)。 使用此配置后,将ElasticsearchRestTemplate可以像任何其他春豆一样注射, 如以下示例所示:spring-doc.cadn.net.cn

Java
import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final ElasticsearchRestTemplate template;

    public MyBean(ElasticsearchRestTemplate template) {
        this.template = template;
    }

    // ...

    public boolean someMethod(String id) {
        return this.template.exists(id, User.class);
    }

}
Kotlin
import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val template: ElasticsearchRestTemplate) {

    // ...

    fun someMethod(id: String): Boolean {
        return template.exists(id, User::class.java)
    }

}

在存在的情况下spring-data-elasticsearch以及使用WebClient(通常spring-boot-starter-webflux),Spring Boot 还可以自动配置 ReactiveElasticsearchClientReactiveElasticsearchTemplate作为Beans。 它们是其他 REST 客户端的响应式等效项。spring-doc.cadn.net.cn

2.5.3. Spring Data Elasticsearch 存储库

Spring Data 包括对 Elasticsearch 的存储库支持。 与前面讨论的 JPA 存储库一样,基本原则是根据方法名称自动为您构造查询。spring-doc.cadn.net.cn

事实上,Spring Data JPA 和 Spring Data Elasticsearch 共享相同的公共基础设施。 您可以以前面的 JPA 为例,假设City现在是 Elasticsearch@Document类而不是 JPA@Entity,它以同样的方式工作。spring-doc.cadn.net.cn

通过扫描找到存储库和文档。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和文档@EnableElasticsearchRepositories@EntityScan分别。spring-doc.cadn.net.cn

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

Spring Boot 支持经典和响应式 Elasticsearch 存储库,使用ElasticsearchRestTemplateReactiveElasticsearchTemplate豆。 鉴于存在所需的依赖项,这些 bean 很可能是由 Spring Boot 自动配置的。spring-doc.cadn.net.cn

如果您希望使用自己的模板来支持 Elasticsearch 存储库,您可以添加自己的模板ElasticsearchRestTemplateElasticsearchOperations @Bean,只要命名"elasticsearchTemplate". 这同样适用于ReactiveElasticsearchTemplateReactiveElasticsearchOperations,与 bean 名称"reactiveElasticsearchTemplate".spring-doc.cadn.net.cn

您可以选择使用以下属性禁用存储库支持:spring-doc.cadn.net.cn

性能
spring.data.elasticsearch.repositories.enabled=false
亚姆尔
spring:
  data:
    elasticsearch:
      repositories:
        enabled: false

2.6. 卡桑德拉

Cassandra 是一个开源的分布式数据库管理系统,旨在处理跨许多商用服务器的大量数据。Spring Boot 为 Cassandra 以及 Spring Data Cassandra 提供的抽象提供了自动配置。有一个spring-boot-starter-data-cassandra“Starter”,用于以方便的方式收集依赖项。spring-doc.cadn.net.cn

2.6.1. 连接到 Cassandra

您可以注入自动配置的CassandraTemplate或卡桑德拉CqlSession实例,就像您对任何其他 Spring Bean 一样。 这spring.data.cassandra.*属性可用于自定义连接。通常,您提供keyspace-namecontact-points以及本地数据中心名称,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.data.cassandra.keyspace-name=mykeyspace
spring.data.cassandra.contact-points=cassandrahost1:9042,cassandrahost2:9042
spring.data.cassandra.local-datacenter=datacenter1
亚姆尔
spring:
  data:
    cassandra:
      keyspace-name: "mykeyspace"
      contact-points: "cassandrahost1:9042,cassandrahost2:9042"
      local-datacenter: "datacenter1"

如果所有接触点的端口都相同,则可以使用快捷方式并仅指定主机名,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.data.cassandra.keyspace-name=mykeyspace
spring.data.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.data.cassandra.local-datacenter=datacenter1
亚姆尔
spring:
  data:
    cassandra:
      keyspace-name: "mykeyspace"
      contact-points: "cassandrahost1,cassandrahost2"
      local-datacenter: "datacenter1"
这两个示例与端口默认为9042. 如果需要配置端口,请使用spring.data.cassandra.port.

Cassandra 驱动程序有自己的配置基础结构,用于加载application.conf在类路径的根目录下。spring-doc.cadn.net.cn

默认情况下,Spring Boot 不会查找这样的文件,但可以使用spring.data.cassandra.config. 如果属性同时存在于spring.data.cassandra.*和配置文件中,中的值spring.data.cassandra.*优先。spring-doc.cadn.net.cn

对于更高级的驱动程序自定义,您可以注册任意数量的 bean,以实现DriverConfigLoaderBuilderCustomizer. 这CqlSession可以使用类型的 bean 进行定制CqlSessionBuilderCustomizer.spring-doc.cadn.net.cn

如果您使用CqlSessionBuilder创建多个CqlSessionbean,请记住构建器是可变的,因此请确保为每个会话注入一个新副本。

以下代码列表显示了如何注入 Cassandra bean:spring-doc.cadn.net.cn

Java
import org.springframework.data.cassandra.core.CassandraTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final CassandraTemplate template;

    public MyBean(CassandraTemplate template) {
        this.template = template;
    }

    // ...

    public long someMethod() {
        return this.template.count(User.class);
    }

}
Kotlin
import org.springframework.data.cassandra.core.CassandraTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val template: CassandraTemplate) {

    // ...

    fun someMethod(): Long {
        return template.count(User::class.java)
    }

}

如果您添加自己的@Bean类型CassandraTemplate,它将替换默认值。spring-doc.cadn.net.cn

2.6.2. Spring Data Cassandra 存储库

Spring Data 包括对 Cassandra 的基本存储库支持。 目前,这比前面讨论的 JPA 存储库更有限,需要使用@Query.spring-doc.cadn.net.cn

存储库和实体是通过扫描找到的。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和实体@EnableCassandraRepositories@EntityScan分别。spring-doc.cadn.net.cn

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

2.7. 库奇库

Couchbase 是一个开源、分布式、多模型的面向文档的 NoSQL 数据库,针对交互式应用程序进行了优化。 Spring Boot 为 Couchbase 提供了自动配置,以及 Spring Data Couchbase 提供的抽象。 有spring-boot-starter-data-couchbasespring-boot-starter-data-couchbase-reactive“Starters”,用于以方便的方式收集依赖项。spring-doc.cadn.net.cn

2.7.1. 连接到 Couchbase

您可以获得一个Cluster通过添加 Couchbase SDK 和一些配置。 这spring.couchbase.*属性可用于自定义连接。 通常,提供连接字符串、用户名和密码,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.couchbase.connection-string=couchbase://192.168.1.123
spring.couchbase.username=user
spring.couchbase.password=secret
亚姆尔
spring:
  couchbase:
    connection-string: "couchbase://192.168.1.123"
    username: "user"
    password: "secret"

也可以自定义一些ClusterEnvironment设置。 例如,以下配置更改了超时,以用于打开新的Bucket并启用 SSL 支持:spring-doc.cadn.net.cn

性能
spring.couchbase.env.timeouts.connect=3s
spring.couchbase.env.ssl.key-store=/location/of/keystore.jks
spring.couchbase.env.ssl.key-store-password=secret
亚姆尔
spring:
  couchbase:
    env:
      timeouts:
        connect: "3s"
      ssl:
        key-store: "/location/of/keystore.jks"
        key-store-password: "secret"
检查spring.couchbase.env.*properties 了解更多详细信息。 要获得更多控制权,请ClusterEnvironmentBuilderCustomizer可以使用豆子。

2.7.2. Spring Data Couchbase 存储库

Spring Data 包括对 Couchbase 的存储库支持。spring-doc.cadn.net.cn

通过扫描找到存储库和文档。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和文档@EnableCouchbaseRepositories@EntityScan分别。spring-doc.cadn.net.cn

有关 Spring Data Couchbase 的完整详细信息,请参阅参考文档spring-doc.cadn.net.cn

您可以注入自动配置的CouchbaseTemplate实例,就像使用任何其他 Spring Bean 一样,提供一个CouchbaseClientFactory豆子可用。 当Cluster可用,如上所述,并且已指定存储分区名称:spring-doc.cadn.net.cn

性能
spring.data.couchbase.bucket-name=my-bucket
亚姆尔
spring:
  data:
    couchbase:
      bucket-name: "my-bucket"

以下示例展示了如何注入CouchbaseTemplate豆:spring-doc.cadn.net.cn

Java
import org.springframework.data.couchbase.core.CouchbaseTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final CouchbaseTemplate template;

    public MyBean(CouchbaseTemplate template) {
        this.template = template;
    }

    // ...

    public String someMethod() {
        return this.template.getBucketName();
    }

}
Kotlin
import org.springframework.data.couchbase.core.CouchbaseTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val template: CouchbaseTemplate) {

    // ...

    fun someMethod(): String {
        return template.bucketName
    }

}

您可以在自己的配置中定义一些 bean 来覆盖自动配置提供的 bean:spring-doc.cadn.net.cn

为了避免在您自己的配置中硬编码这些名称,您可以重用BeanNames由 Spring Data Couchbase 提供。 例如,您可以自定义要使用的转换器,如下所示:spring-doc.cadn.net.cn

Java
import org.assertj.core.util.Arrays;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.couchbase.config.BeanNames;
import org.springframework.data.couchbase.core.convert.CouchbaseCustomConversions;

@Configuration(proxyBeanMethods = false)
public class MyCouchbaseConfiguration {

    @Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS)
    public CouchbaseCustomConversions myCustomConversions() {
        return new CouchbaseCustomConversions(Arrays.asList(new MyConverter()));
    }

}
Kotlin
import org.assertj.core.util.Arrays
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.data.couchbase.config.BeanNames
import org.springframework.data.couchbase.core.convert.CouchbaseCustomConversions

@Configuration(proxyBeanMethods = false)
class MyCouchbaseConfiguration {

    @Bean(BeanNames.COUCHBASE_CUSTOM_CONVERSIONS)
    fun myCustomConversions(): CouchbaseCustomConversions {
        return CouchbaseCustomConversions(Arrays.asList(MyConverter()))
    }

}

2.8. LDAP

LDAP(轻量级目录访问协议)是一种开放的、提供商中立的行业标准应用协议,用于通过 IP 网络访问和维护分布式目录信息服务。 Spring Boot 为任何兼容的 LDAP 服务器提供自动配置,并支持 UnboundID 的嵌入式内存中 LDAP 服务器。spring-doc.cadn.net.cn

LDAP 抽象由 Spring Data LDAP 提供。 有一个spring-boot-starter-data-ldap“Starter”,用于以方便的方式收集依赖项。spring-doc.cadn.net.cn

2.8.1. 连接到 LDAP 服务器

要连接到 LDAP 服务器,请确保声明对spring-boot-starter-data-ldap“Starter”或spring-ldap-core,然后在 application.properties 中声明服务器的 URL,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.ldap.urls=ldap://myserver:1235
spring.ldap.username=admin
spring.ldap.password=secret
亚姆尔
spring:
  ldap:
    urls: "ldap://myserver:1235"
    username: "admin"
    password: "secret"

如果您需要自定义连接设置,可以使用spring.ldap.basespring.ldap.base-environment性能。spring-doc.cadn.net.cn

LdapContextSource根据这些设置自动配置。 如果DirContextAuthenticationStrategybean 可用,它与自动配置的LdapContextSource. 如果您需要自定义它,例如使用PooledContextSource,您仍然可以注入自动配置的LdapContextSource. 确保标记您的自定义ContextSource@Primary以便自动配置的LdapTemplate使用它。spring-doc.cadn.net.cn

2.8.2. Spring Data LDAP 存储库

Spring Data 包括对 LDAP 的存储库支持。spring-doc.cadn.net.cn

通过扫描找到存储库和文档。 默认情况下,将扫描自动配置包。 您可以使用以下命令自定义位置以查找存储库和文档@EnableLdapRepositories@EntityScan分别。spring-doc.cadn.net.cn

有关 Spring Data LDAP 的完整详细信息,请参阅参考文档spring-doc.cadn.net.cn

您还可以注入自动配置的LdapTemplate实例,就像使用任何其他 Spring Bean 一样,如以下示例所示:spring-doc.cadn.net.cn

Java
import java.util.List;

import org.springframework.ldap.core.LdapTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private final LdapTemplate template;

    public MyBean(LdapTemplate template) {
        this.template = template;
    }

    // ...

    public List<User> someMethod() {
        return this.template.findAll(User.class);
    }

}
Kotlin
import org.springframework.ldap.core.LdapTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val template: LdapTemplate) {

    // ...

    fun someMethod(): List<User> {
        return template.findAll(User::class.java)
    }

}

2.8.3. 嵌入式内存 LDAP 服务器

出于测试目的,Spring Boot 支持从 UnboundID 自动配置内存中 LDAP 服务器。 要配置服务器,请将依赖项添加到com.unboundid:unboundid-ldapsdk并声明一个spring.ldap.embedded.base-dn属性,如下所示:spring-doc.cadn.net.cn

性能
spring.ldap.embedded.base-dn=dc=spring,dc=io
亚姆尔
spring:
  ldap:
    embedded:
      base-dn: "dc=spring,dc=io"

可以定义多个 base-dn 值,但是,由于可分辨名称通常包含逗号,因此必须使用正确的表示法来定义它们。spring-doc.cadn.net.cn

在 yaml 文件中,您可以使用 yaml 列表表示法。在属性文件中,必须将索引作为属性名称的一部分包含在内:spring-doc.cadn.net.cn

性能
spring.ldap.embedded.base-dn[0]=dc=spring,dc=io
spring.ldap.embedded.base-dn[1]=dc=vmware,dc=com
亚姆尔
spring.ldap.embedded.base-dn:
  - "dc=spring,dc=io"
  - "dc=vmware,dc=com"

默认情况下,服务器在随机端口上启动并触发常规 LDAP 支持。 无需指定spring.ldap.urls财产。spring-doc.cadn.net.cn

如果有schema.ldif文件,它用于初始化服务器。 如果要从其他资源加载初始化脚本,还可以使用spring.ldap.embedded.ldif财产。spring-doc.cadn.net.cn

默认情况下,标准架构用于验证LDIF文件。 您可以通过将spring.ldap.embedded.validation.enabled财产。 如果您有自定义属性,您可以使用spring.ldap.embedded.validation.schema以定义自定义属性类型或对象类。spring-doc.cadn.net.cn

2.9. 流入数据库

InfluxDB 是一个开源时序数据库,针对运营监控、应用指标、物联网传感器数据和实时分析等领域的时序数据的快速、高可用性存储和检索进行了优化。spring-doc.cadn.net.cn

2.9.1. 连接到 InfluxDB

Spring Boot 自动配置InfluxDB实例,提供influxdb-javaclient 位于类路径上,并设置了数据库的 URL,如以下示例所示:spring-doc.cadn.net.cn

性能
spring.influx.url=https://172.0.0.1:8086
亚姆尔
spring:
  influx:
    url: "https://172.0.0.1:8086"

如果与 InfluxDB 的连接需要用户和密码,您可以将spring.influx.userspring.influx.password属性相应地。spring-doc.cadn.net.cn

InfluxDB 依赖于 OkHttp。 如果需要调优 http 客户端InfluxDB在后台使用,您可以注册InfluxDbOkHttpClientBuilderProvider豆。spring-doc.cadn.net.cn

如果您需要对配置进行更多控制,请考虑注册InfluxDbCustomizer豆。spring-doc.cadn.net.cn

3. 接下来要读什么

您现在应该对如何将 Spring Boot 与各种数据技术一起使用有所了解。 从这里,您可以了解 Spring Boot 对各种消息传递技术的支持以及如何在您的应用程序中启用它们。spring-doc.cadn.net.cn