使用 NoSQL 技术

Spring Data 提供了多个附加项目，帮助您访问各种 NoSQL 技术，包括：

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

Spring Boot 还为 InfluxDB 客户端提供了自动配置，但已弃用，推荐使用新的 InfluxDB Java 客户端，它提供了自己的 Spring Boot 集成。

Redis

Redis 是一个缓存、消息代理和功能丰富的键值存储。 Spring Boot 为 Lettuce 和 Jedis 客户端库以及 Spring Data Redis 提供的抽象层提供了基本的自动配置。

有一个 spring-boot-starter-data-redis starter，方便地收集依赖项。默认情况下，它使用 Lettuce。该 starter 支持传统和响应式应用程序。

我们还提供了一个 spring-boot-starter-data-redis-reactive starter，以与其他支持响应式的存储保持一致。

连接到 Redis

您可以像注入其他 Spring Bean 一样注入自动配置的 RedisConnectionFactory、StringRedisTemplate 或原生的 RedisTemplate 实例。以下列表显示了一个这样的 bean 示例：

Java
Kotlin

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

}

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 的 Redis 服务器。您可以使用 spring.data.redis.* 属性指定自定义连接细节，如下例所示：

Properties
YAML

spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.database=0
spring.data.redis.username=user
spring.data.redis.password=secret

spring:
  data:
    redis:
      host: "localhost"
      port: 6379
      database: 0
      username: "user"
      password: "secret"

您还可以直接指定 Redis 服务器的 URL。设置 URL 时，host、port、username 和 password 属性将被忽略。如下例所示：

Properties
YAML

spring.data.redis.url=redis://user:secret@localhost:6379
spring.data.redis.database=0

spring:
  data:
    redis:
      url: "redis://user:secret@localhost:6379"
      database: 0

您还可以注册任意数量的实现 LettuceClientConfigurationBuilderCustomizer 的 bean，以进行更高级的自定义。 ClientResources 也可以使用 ClientResourcesBuilderCustomizer 进行自定义。如果您使用 Jedis，也可以使用 JedisClientConfigurationBuilderCustomizer。或者，您可以注册 RedisStandaloneConfiguration、RedisSentinelConfiguration 或 RedisClusterConfiguration 类型的 bean，以完全控制配置。

如果您添加了自己的任何自动配置类型的 @Bean，它将替换默认配置（除了 RedisTemplate 的情况，排除基于 bean 名称 redisTemplate，而不是其类型）。

默认情况下，如果类路径上有 commons-pool2，会自动配置一个池化连接工厂。

通过设置以下属性，可以配置自动配置的 RedisConnectionFactory 使用 SSL 与服务器通信，如下例所示：

Properties
YAML

spring.data.redis.ssl.enabled=true

spring:
  data:
    redis:
      ssl:
        enabled: true

可以在 SSL bundle 中配置自定义 SSL 信任材料，并将其应用于 RedisConnectionFactory，如下例所示：

Properties
YAML

spring.data.redis.ssl.bundle=example

spring:
  data:
    redis:
      ssl:
        bundle: "example"

MongoDB

MongoDB 是一个开源的 NoSQL 文档数据库，使用类似 JSON 的模式，而不是传统的基于表格的关系数据。 Spring Boot 为使用 MongoDB 提供了多种便利，包括 spring-boot-starter-data-mongodb 和 spring-boot-starter-data-mongodb-reactive starter。

连接到 MongoDB 数据库

要访问 MongoDB 数据库，您可以注入一个自动配置的 MongoDatabaseFactory。默认情况下，实例尝试连接到 mongodb://localhost/test 的 MongoDB 服务器。以下示例显示如何连接到 MongoDB 数据库：

Java
Kotlin

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

}

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。

自动配置的 MongoClient 使用 MongoClientSettings bean 创建。如果您定义了自己的 MongoClientSettings，它将不加修改地使用，spring.data.mongodb 属性将被忽略。否则，将自动配置一个 MongoClientSettings，并应用 spring.data.mongodb 属性。在任一情况下，您可以声明一个或多个 MongoClientSettingsBuilderCustomizer bean，以微调 MongoClientSettings 配置。每个 bean 将按顺序与用于构建 MongoClientSettings 的 MongoClientSettings.Builder 一起调用。

您可以设置 spring.data.mongodb.uri 属性来更改 URL 并配置其他设置，例如 副本集，如下例所示：

Properties
YAML

spring.data.mongodb.uri=mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test

spring:
  data:
    mongodb:
      uri: "mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test"

或者，您可以使用单独的属性指定连接细节。例如，您可以在 application.properties 中声明以下设置：

Properties
YAML

spring.data.mongodb.host=mongoserver1.example.com
spring.data.mongodb.port=27017
spring.data.mongodb.additional-hosts[0]=mongoserver2.example.com:23456
spring.data.mongodb.database=test
spring.data.mongodb.username=user
spring.data.mongodb.password=secret

spring:
  data:
    mongodb:
      host: "mongoserver1.example.com"
      port: 27017
      additional-hosts:
      - "mongoserver2.example.com:23456"
      database: "test"
      username: "user"
      password: "secret"

通过设置以下属性，可以配置自动配置的 MongoClient 使用 SSL 与服务器通信，如下例所示：

Properties
YAML

spring.data.mongodb.uri=mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test
spring.data.mongodb.ssl.enabled=true

spring:
  data:
    mongodb:
      uri: "mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test"
      ssl:
        enabled: true

可以在 SSL bundle 中配置自定义 SSL 信任材料，并将其应用于 MongoClient，如下例所示：

Properties
YAML

spring.data.mongodb.uri=mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test
spring.data.mongodb.ssl.bundle=example

spring:
  data:
    mongodb:
      uri: "mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test"
      ssl:
        bundle: "example"

如果未指定 spring.data.mongodb.port，将使用默认值 27017。您可以从前面的示例中删除此行。

您还可以使用 host:port 语法格式作为主机地址的一部分指定端口。如果需要更改 additional-hosts 条目的端口，应使用此格式。

如果您不使用 Spring Data MongoDB，可以注入 MongoClient bean，而不是使用 MongoDatabaseFactory。如果您想完全控制建立 MongoDB 连接，还可以声明自己的 MongoDatabaseFactory 或 MongoClient bean。

如果使用响应式驱动程序，SSL 需要 Netty。如果 Netty 可用且未自定义工厂，自动配置会自动配置此工厂。

MongoTemplate

Spring Data MongoDB 提供了 MongoTemplate 类，其设计与 Spring 的 JdbcTemplate 非常相似。与 JdbcTemplate 一样，Spring Boot 为您自动配置一个 bean 以注入模板，如下所示：

Java
Kotlin

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

}

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

}

有关完整详情，请参阅 MongoOperations API 文档。

Spring Data MongoDB 存储库

Spring Data 为 MongoDB 提供了存储库支持。与前面讨论的 JPA 存储库一样，其基本原理是根据方法名称自动构建查询。

事实上，Spring Data JPA 和 Spring Data MongoDB 共享相同的基础设施。您可以拿前面的 JPA 示例，假设 City 现在是一个 MongoDB 数据类，而不是 JPA @Entity，它以相同的方式工作，如下例所示：

Java
Kotlin

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.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 Data MongoDB 的完整详情，包括其丰富的对象映射技术，请参阅其参考文档。

Neo4j

Neo4j 是一个开源的 NoSQL 图数据库，使用节点通过一流关系连接的丰富数据模型，相比传统的 RDBMS 方法更适合处理连接的大数据。 Spring Boot 为使用 Neo4j 提供了多种便利，包括 spring-boot-starter-data-neo4j starter。

连接到 Neo4j 数据库

要访问 Neo4j 服务器，您可以注入一个自动配置的 Driver。默认情况下，实例尝试使用 Bolt 协议连接到 localhost:7687 的 Neo4j 服务器。以下示例显示如何注入一个 Neo4j Driver，它提供了对 Session 等内容的访问：

Java
Kotlin

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

}

import org.neo4j.driver.*
import org.springframework.stereotype.Component

@Component
class MyBean(private val driver: Driver) {
	// ...
	fun someMethod(message: String?): String {
		driver.session().use { session ->
			return@someMethod session.executeWrite { transaction: TransactionContext ->
				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 和凭据：

Properties
YAML

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 使用 org.neo4j.driver.Config$ConfigBuilder 创建。要微调其配置，声明一个或多个 ConfigBuilderCustomizer bean。每个 bean 将按顺序与用于构建 Driver 的 org.neo4j.driver.Config$ConfigBuilder 一起调用。

Spring Data Neo4j 存储库

Spring Data 为 Neo4j 提供了存储库支持。有关 Spring Data Neo4j 的完整详情，请参阅参考文档。

Spring Data Neo4j 与 Spring Data JPA 等许多其他 Spring Data 模块共享相同的基础设施。您可以拿前面的 JPA 示例，将 City 定义为 Spring Data Neo4j @Node，而不是 JPA @Entity，存储库抽象以相同的方式工作，如下例所示：

Java
Kotlin

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

}

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 支持使用 Neo4jTemplate 或 ReactiveNeo4jTemplate bean 的经典和响应式 Neo4j 存储库。当类路径上有 Project Reactor 时，也会自动配置响应式风格。

通过扫描发现存储库和实体。默认情况下，扫描自动配置包。您可以分别使用 @EnableNeo4jRepositories 和 @EntityScan 自定义查找存储库和实体的位置。

在使用响应式风格的应用程序中，不会自动配置 ReactiveTransactionManager。要启用事务管理，必须在配置中定义以下 bean：

Java
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)
public class MyNeo4jConfiguration {

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

}

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

Elasticsearch

Elasticsearch 是一个开源的分布式 RESTful 搜索和分析引擎。 Spring Boot 为 Elasticsearch 客户端提供了基本的自动配置。

Spring Boot 支持多个客户端：

官方低级 REST 客户端
官方 Java API 客户端
Spring Data Elasticsearch 提供的 ReactiveElasticsearchClient

Spring Boot 提供了一个专用的 starter，spring-boot-starter-data-elasticsearch。

使用 REST 客户端连接到 Elasticsearch

Elasticsearch 提供了两个不同的 REST 客户端，您可以用来查询集群：来自 org.elasticsearch.client:elasticsearch-rest-client 模块的低级客户端和来自 co.elastic.clients:elasticsearch-java 模块的 Java API 客户端。此外，Spring Boot 支持来自 org.springframework.data:spring-data-elasticsearch 模块的响应式客户端。默认情况下，客户端的目标是 localhost:9200。您可以使用 spring.elasticsearch.* 属性进一步调整客户端的配置，如下例所示：

Properties
YAML

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 bean。除了前面描述的属性外，要微调 RestClient，您可以注册任意数量的实现 RestClientBuilderCustomizer 的 bean，以进行更高级的自定义。要完全控制客户端的配置，定义一个 RestClientBuilder bean。

此外，如果类路径上有 elasticsearch-rest-client-sniffer，将自动配置一个 Sniffer，以从运行中的 Elasticsearch 集群自动发现节点并将其设置到 RestClient bean 上。您可以进一步调整 Sniffer 的配置，如下例所示：

Properties
YAML

spring.elasticsearch.restclient.sniffer.interval=10m
spring.elasticsearch.restclient.sniffer.delay-after-failure=30s

spring:
  elasticsearch:
    restclient:
      sniffer:
        interval: "10m"
        delay-after-failure: "30s"

使用 ElasticsearchClient 连接到 Elasticsearch

如果类路径上有 co.elastic.clients:elasticsearch-java，Spring Boot 将自动配置并注册一个 ElasticsearchClient bean。

ElasticsearchClient 使用依赖于前面描述的 RestClient 的传输。因此，前面描述的属性可用于配置 ElasticsearchClient。此外，您可以定义一个 RestClientOptions bean，以进一步控制传输的行为。

使用 ReactiveElasticsearchClient 连接到 Elasticsearch

Spring Data Elasticsearch 提供了 ReactiveElasticsearchClient，以响应式方式查询 Elasticsearch 实例。如果类路径上有 Spring Data Elasticsearch 和 Reactor，Spring Boot 将自动配置并注册一个 ReactiveElasticsearchClient。

ReactiveElasticsearchClient 使用依赖于前面描述的 RestClient 的传输。因此，前面描述的属性可用于配置 ReactiveElasticsearchClient。此外，您可以定义一个 RestClientOptions bean，以进一步控制传输的行为。

使用 Spring Data 连接到 Elasticsearch

要连接到 Elasticsearch，必须定义一个 ElasticsearchClient bean，由 Spring Boot 自动配置或由应用程序手动提供（参见前几节）。在这种配置下，可以像注入其他 Spring bean 一样注入 ElasticsearchTemplate，如下例所示：

Java
Kotlin

import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final ElasticsearchTemplate template;

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

	// ...

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

}

import org.springframework.stereotype.Component

@Component
class MyBean(private val template: org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate ) {

	// ...

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

}

如果类路径上有 spring-data-elasticsearch 和 Reactor，Spring Boot 还可以自动配置一个 ReactiveElasticsearchClient 和 ReactiveElasticsearchTemplate 作为 bean。它们是其他 REST 客户端的响应式等价物。

Spring Data Elasticsearch 存储库

Spring Data 为 Elasticsearch 提供了存储库支持。与前面讨论的 JPA 存储库一样，其基本原理是根据方法名称自动构建查询。

事实上，Spring Data JPA 和 Spring Data Elasticsearch 共享相同的基础设施。您可以拿前面的 JPA 示例，假设 City 现在是一个 Elasticsearch @Document 类，而不是 JPA @Entity，它以相同的方式工作。

通过扫描发现存储库和文档。默认情况下，扫描自动配置包。您可以分别使用 @EnableElasticsearchRepositories 和 @EntityScan 自定义查找存储库和文档的位置。

有关 Spring Data Elasticsearch 的完整详情，请参阅参考文档。

Spring Boot 支持使用 ElasticsearchTemplate 或 ReactiveElasticsearchTemplate bean 的经典和响应式 Elasticsearch 存储库。如果存在所需的依赖项，这些 bean 很可能是由 Spring Boot 自动配置的。

如果您希望为支持 Elasticsearch 存储库使用自己的模板，可以添加自己的 ElasticsearchTemplate 或 ElasticsearchOperations @Bean，只要其名称为 "elasticsearchTemplate"。对于 ReactiveElasticsearchTemplate 和 ReactiveElasticsearchOperations，bean 名称为 "reactiveElasticsearchTemplate"，同样适用。

您可以选择通过以下属性禁用存储库支持：

Properties
YAML

spring.data.elasticsearch.repositories.enabled=false

spring:
  data:
    elasticsearch:
      repositories:
        enabled: false

Cassandra

Cassandra 是一个开源的分布式数据库管理系统，设计用于处理跨多个商用服务器的大量数据。 Spring Boot 为 Cassandra 提供了自动配置以及 Spring Data Cassandra 提供的抽象层。有一个 spring-boot-starter-data-cassandra starter，方便地收集依赖项。

连接到 Cassandra

您可以像注入其他 Spring Bean 一样注入自动配置的 CqlTemplate、CassandraTemplate 或 Cassandra CqlSession 实例。 spring.cassandra.* 属性可用于自定义连接。通常，您需要提供 keyspace-name 和 contact-points 以及本地数据中心名称，如下例所示：

Properties
YAML

spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1:9042,cassandrahost2:9042
spring.cassandra.local-datacenter=datacenter1

spring:
  cassandra:
    keyspace-name: "mykeyspace"
    contact-points: "cassandrahost1:9042,cassandrahost2:9042"
    local-datacenter: "datacenter1"

如果所有联系点的端口相同，您可以使用快捷方式，仅指定主机名，如下例所示：

Properties
YAML

spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1

spring:
  cassandra:
    keyspace-name: "mykeyspace"
    contact-points: "cassandrahost1,cassandrahost2"
    local-datacenter: "datacenter1"

这两个示例是相同的，因为端口默认为 9042。如果需要配置端口，请使用 spring.cassandra.port。

通过设置以下属性，可以配置自动配置的 CqlSession 使用 SSL 与服务器通信，如下例所示：

Properties
YAML

spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1
spring.cassandra.ssl.enabled=true

spring:
  cassandra:
    keyspace-name: "mykeyspace"
    contact-points: "cassandrahost1,cassandrahost2"
    local-datacenter: "datacenter1"
    ssl:
      enabled: true

可以在 SSL bundle 中配置自定义 SSL 信任材料，并将其应用于 CqlSession，如下例所示：

Properties
YAML

spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1
spring.cassandra.ssl.bundle=example

spring:
  cassandra:
    keyspace-name: "mykeyspace"
    contact-points: "cassandrahost1,cassandrahost2"
    local-datacenter: "datacenter1"
    ssl:
      bundle: "example"

Cassandra 驱动程序有自己的配置基础设施，会加载类路径根目录下的 application.conf 文件。

Spring Boot 默认不查找此类文件，但可以使用 spring.cassandra.config 加载一个。如果 spring.cassandra. 和配置文件中都存在某个属性，spring.cassandra. 中的值优先。

要进行更高级的驱动程序自定义，可以注册任意数量的实现 DriverConfigLoaderBuilderCustomizer 的 bean。可以使用 CqlSessionBuilderCustomizer 类型的 bean 自定义 CqlSession。

如果您使用 CqlSessionBuilder 创建多个 CqlSession bean，请注意该构建器是可变的，因此请确保为每个会话注入一个新的副本。

以下代码列表显示如何注入 Cassandra bean：

Java
Kotlin

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

}

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 Data Cassandra 存储库

Spring Data 为 Cassandra 提供了基本的存储库支持。目前，这比前面讨论的 JPA 存储库更有限，需要使用 @Query 注解的查找方法。

通过扫描发现存储库和实体。默认情况下，扫描自动配置包。您可以分别使用 @EnableCassandraRepositories 和 @EntityScan 自定义查找存储库和实体的位置。

有关 Spring Data Cassandra 的完整详情，请参阅参考文档。

Couchbase

Couchbase 是一个开源的分布式多模型 NoSQL 面向文档的数据库，优化用于交互式应用程序。 Spring Boot 为 Couchbase 提供了自动配置以及 Spring Data Couchbase 提供的抽象层。有 spring-boot-starter-data-couchbase 和 spring-boot-starter-data-couchbase-reactive starter，方便地收集依赖项。

连接到 Couchbase

通过添加 Couchbase SDK 和一些配置，您可以获得一个 Cluster。 spring.couchbase.* 属性可用于自定义连接。通常，您需要提供连接字符串和用于认证的凭据。可以使用用户名和密码进行基本认证，如下例所示：

Properties
YAML

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"

客户端证书可用于代替用户名和密码进行认证。包含客户端证书的 Java KeyStore 的位置和密码可以按以下示例配置：

Properties
YAML

spring.couchbase.connection-string=couchbase://192.168.1.123
spring.couchbase.env.ssl.enabled=true
spring.couchbase.authentication.jks.location=classpath:client.p12
spring.couchbase.authentication.jks.password=secret

spring:
  couchbase:
    connection-string: "couchbase://192.168.1.123"
    env:
      ssl:
        enabled: true
    authentication:
      jks:
        location: "classpath:client.p12"
        password: "secret"

PEM 编码的证书和私钥可以按以下示例配置：

Properties
YAML

spring.couchbase.connection-string=couchbase://192.168.1.123
spring.couchbase.env.ssl.enabled=true
spring.couchbase.authentication.pem.certificates=classpath:client.crt
spring.couchbase.authentication.pem.private-key=classpath:client.key

spring:
  couchbase:
    connection-string: "couchbase://192.168.1.123"
    env:
      ssl:
        enabled: true
    authentication:
      pem:
        certificates: "classpath:client.crt"
        private-key: "classpath:client.key"

还可以自定义 ClusterEnvironment 的一些设置。例如，以下配置更改了打开新 Bucket 的超时时间，并启用对配置的 SSL bundle 的引用以支持 SSL：

Properties
YAML

spring.couchbase.env.timeouts.connect=3s
spring.couchbase.env.ssl.bundle=example

spring:
  couchbase:
    env:
      timeouts:
        connect: "3s"
      ssl:
        bundle: "example"

请查看 spring.couchbase.env.* 属性以获取更多详情。要获得更多控制，可以使用一个或多个 ClusterEnvironmentBuilderCustomizer bean。

Spring Data Couchbase 存储库

Spring Data 为 Couchbase 提供了存储库支持。

通过扫描发现存储库和文档。默认情况下，扫描自动配置包。您可以分别使用 @EnableCouchbaseRepositories 和 @EntityScan 自定义查找存储库和文档的位置。

有关 Spring Data Couchbase 的完整详情，请参阅参考文档。

只要 CouchbaseClientFactory bean 可用，您就可以像注入其他 Spring Bean 一样注入自动配置的 CouchbaseTemplate 实例。当 Cluster 可用（如上所述）且已指定桶名称时，会发生这种情况：

Properties
YAML

spring.data.couchbase.bucket-name=my-bucket

spring:
  data:
    couchbase:
      bucket-name: "my-bucket"

以下示例显示如何注入 CouchbaseTemplate bean：

Java
Kotlin

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

}

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：

名称为 couchbaseMappingContext 的 CouchbaseMappingContext @Bean。
名称为 couchbaseCustomConversions 的 CustomConversions @Bean。
名称为 couchbaseTemplate 的 CouchbaseTemplate @Bean。

为了避免在自己的配置中硬编码这些名称，您可以重用 Spring Data Couchbase 提供的 BeanNames。例如，您可以按以下方式自定义要使用的转换器：

Java
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)
public class MyCouchbaseConfiguration {

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

}

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

}

LDAP

LDAP（轻量级目录访问协议）是一个开放的、供应商中立的行业标准应用程序协议，用于通过 IP 网络访问和维护分布式目录信息服务。 Spring Boot 为任何符合标准的 LDAP 服务器提供自动配置，并支持来自 UnboundID 的嵌入式内存 LDAP 服务器。

Spring Data LDAP 提供了 LDAP 抽象。有一个 spring-boot-starter-data-ldap starter，方便地收集依赖项。

连接到 LDAP 服务器

要连接到 LDAP 服务器，请确保声明对 spring-boot-starter-data-ldap starter 或 spring-ldap-core 的依赖，然后在 application.properties 中声明服务器的 URL，如下例所示：

Properties
YAML

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.base 和 spring.ldap.base-environment 属性。

根据这些设置自动配置一个 LdapContextSource。如果有 DirContextAuthenticationStrategy bean 可用，它将关联到自动配置的 LdapContextSource。如果需要自定义它，例如使用 PooledContextSource，您仍然可以注入自动配置的 LdapContextSource。请确保将自定义的 ContextSource 标记为 @Primary，以便自动配置的 LdapTemplate 使用它。

Spring Data LDAP 存储库

Spring Data 为 LDAP 提供了存储库支持。

通过扫描发现存储库和文档。默认情况下，扫描自动配置包。您可以分别使用 @EnableLdapRepositories 和 @EntityScan 自定义查找存储库和文档的位置。

有关 Spring Data LDAP 的完整详情，请参阅参考文档。

您还可以像注入其他 Spring Bean 一样注入自动配置的 LdapTemplate 实例，如下例所示：

Java
Kotlin

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

}

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

}

嵌入式内存 LDAP 服务器

为了测试目的，Spring Boot 支持来自 UnboundID 的嵌入式内存 LDAP 服务器的自动配置。要配置服务器，添加对 com.unboundid:unboundid-ldapsdk 的依赖，并声明 spring.ldap.embedded.base-dn 属性，如下所示：

Properties
YAML

spring.ldap.embedded.base-dn=dc=spring,dc=io

spring:
  ldap:
    embedded:
      base-dn: "dc=spring,dc=io"

可以定义多个 base-dn 值，但是，由于区分名称通常包含逗号，必须使用正确的表示法定义它们。

在 YAML 文件中，您可以使用 YAML 列表表示法。在属性文件中，必须将索引作为属性名称的一部分包含：

Properties
YAML

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 属性。

如果类路径上有 schema.ldif 文件，它将用于初始化服务器。如果您想从其他资源加载初始化脚本，还可以使用 spring.ldap.embedded.ldif 属性。

默认情况下，使用标准模式验证 LDIF 文件。您可以通过设置 spring.ldap.embedded.validation.enabled 属性完全关闭验证。如果您有自定义属性，可以使用 spring.ldap.embedded.validation.schema 定义自定义属性类型或对象类。