使用 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 客户端提供自动配置，但已弃用，转而使用提供自己的 Spring Boot 集成的新 InfluxDB Java 客户端：the new InfluxDB Java client。

Redis

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

有一个 spring-boot-starter-data-redis 启动器，用于以方便的方式收集依赖项。默认情况下，它使用 Lettuce。该启动器同时处理传统和响应式应用程序。

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

连接到 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.* 属性指定自定义连接详细信息，如以下示例所示

  • 属性

  • 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 时，主机、端口、用户名和密码属性将被忽略。这在以下示例中显示

  • 属性

  • 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 或 RedisStaticMasterReplicaConfiguration 的 bean，以完全控制配置。

Jedis 不支持 master/replica。

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

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

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

  • 属性

  • YAML

spring.data.redis.ssl.enabled=true
spring:
  data:
    redis:
      ssl:
        enabled: true

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

  • 属性

  • 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 启动器。

连接到 MongoDB 数据库

要访问 MongoDB 数据库，您可以注入一个自动配置的 MongoDatabaseFactory。默认情况下，实例尝试连接到 mongodb:///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 配置。每个都将依次使用用于构建 MongoClientSettings 的 MongoClientSettings.Builder 进行调用。

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

  • 属性

  • YAML

spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test
spring:
  mongodb:
    uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test"

或者，您可以使用离散属性指定连接详细信息。例如，您可以在 application.properties 中声明以下设置

  • 属性

  • YAML

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

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

  • 属性

  • YAML

spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test
spring.mongodb.ssl.enabled=true
spring:
  mongodb:
    uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test"
    ssl:
      enabled: true

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

  • 属性

  • YAML

spring.mongodb.uri=mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test
spring.mongodb.ssl.bundle=example
spring:
  mongodb:
    uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test"
    ssl:
      bundle: "example"

如果未指定 spring.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 Repositories

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 图数据库，它使用丰富的由一流关系连接的节点数据模型，这比传统的关系型数据库方法更适合连接大数据。Spring Boot 为使用 Neo4j 提供了多种便利，包括 spring-boot-starter-data-neo4j 启动器。

连接到 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.Driver
import org.neo4j.driver.TransactionContext
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.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 和凭据

  • 属性

  • 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。每个都将依次使用用于构建 Driver 的 org.neo4j.driver.Config$ConfigBuilder 进行调用。

Spring Data Neo4j Repositories

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 启动器启用了存储库支持以及事务管理。Spring Boot 同时支持经典和响应式 Neo4j 存储库，使用 Neo4jTemplate 或 ReactiveNeo4jTemplate bean。当 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 支持多种客户端

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

使用 REST 客户端连接到 Elasticsearch

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

  • 属性

  • 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"

使用 Rest5Client 连接到 Elasticsearch

如果您的类路径中有 co.elastic.clients:elasticsearch-rest5-client，Spring Boot 将自动配置并注册一个 Rest5Client bean。除了前面描述的属性之外，为了微调 Rest5Client，您可以注册任意数量实现 Rest5ClientBuilderCustomizer 的 bean，以进行更高级的自定义。要完全控制客户端的配置，请定义一个 Rest5ClientBuilder bean。

此外，可以自动配置一个 Sniffer，以自动发现正在运行的 Elasticsearch 集群中的节点并将其设置到 Rest5Client bean 上。您可以进一步调整 Sniffer 的配置，如以下示例所示

  • 属性

  • YAML

spring.elasticsearch.restclient.sniffer.enabled=true
spring.elasticsearch.restclient.sniffer.interval=10m
spring.elasticsearch.restclient.sniffer.delay-after-failure=30s
spring:
  elasticsearch:
    restclient:
      sniffer:
        enabled: true
        interval: "10m"
        delay-after-failure: "30s"

使用 ElasticsearchClient 连接到 Elasticsearch

如果您使用 spring-boot-starter-elasticsearch 或已将 co.elastic.clients:elasticsearch-java 添加到类路径中，Spring Boot 将自动配置并注册一个 ElasticsearchClient bean。

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

使用 ReactiveElasticsearchClient 连接到 Elasticsearch

Spring Data Elasticsearch 附带了 ReactiveElasticsearchClient，用于以响应式方式查询 Elasticsearch 实例。如果您的类路径中有 Spring Data Elasticsearch 和 Reactor，Spring Boot 将自动配置并注册一个 ReactiveElasticsearchClient。

ReactiveElasticsearchClient 使用一个传输层，它依赖于前面描述的 Rest5Client。因此，前面描述的属性可以用于配置 ReactiveElasticsearchClient。此外，您可以定义一个 Rest5ClientOptions 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 支持经典和响应式 Elasticsearch 存储库，使用 ElasticsearchTemplate 或 ReactiveElasticsearchTemplate bean。如果存在所需的依赖项，Spring Boot 很可能会自动配置这些 bean。

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

您可以使用以下属性禁用存储库支持

  • 属性

  • 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 启动器，用于以方便的方式收集依赖项。

连接到 Cassandra

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

  • 属性

  • 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"

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

  • 属性

  • 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 与服务器通信，通过设置属性，如本例所示

  • 属性

  • 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 信任材料可以在 SSL bundle 中配置，并应用于 CqlSession，如本例所示

  • 属性

  • 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。CqlSession 可以使用类型为 CqlSessionBuilderCustomizer 的 bean 进行自定义。
如果您使用 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 启动器，用于以便捷的方式收集依赖项。

连接到 Couchbase

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

  • 属性

  • 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 的位置和密码可以配置，如以下示例所示

  • 属性

  • 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 编码的证书和私钥可以配置，如以下示例所示

  • 属性

  • 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 支持，并引用了已配置的 SSL bundle

  • 属性

  • 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 的完整详细信息，请参阅 参考文档。

您可以像注入任何其他 Spring Bean 一样注入自动配置的 CouchbaseTemplate 实例，前提是存在 CouchbaseClientFactory bean。当存在 Cluster（如上所述）并且已指定存储桶名称时，就会发生这种情况

  • 属性

  • 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

为了避免在您自己的配置中硬编码这些名称，您可以重用 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 服务器提供了自动配置。

LDAP 抽象由 Spring Data LDAP 提供。有一个 spring-boot-starter-data-ldap 启动器，用于以方便的方式收集依赖项。

连接到 LDAP 服务器

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

  • 属性

  • 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 属性，如下所示

  • 属性

  • 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 来定义您的自定义属性类型或对象类。

© . This site is unofficial and not affiliated with VMware.