对于最新的稳定版本,请使用 Spring Boot 3.5.5spring-doc.cadn.net.cn

使用 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 客户端提供自动配置,但它已被弃用,取而代之的是提供自己的 Spring Boot 集成的新 InfluxDB Java 客户端spring-doc.cadn.net.cn

Redis

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

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

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

连接到 Redis

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

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. 您可以使用以下命令指定自定义连接详细信息spring.data.redis.*属性,如以下示例所示:spring-doc.cadn.net.cn

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

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
您还可以注册任意数量的 bean,以实现LettuceClientConfigurationBuilderCustomizer用于更高级的自定义。ClientResources也可以使用ClientResourcesBuilderCustomizer. 如果你使用 Jedis,JedisClientConfigurationBuilderCustomizer也可用。或者,您可以注册类型为RedisStandaloneConfiguration,RedisSentinelConfigurationRedisClusterConfiguration以完全控制配置。

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

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

自动配置的RedisConnectionFactory可以通过设置以下示例所示的属性来配置为 SSL 与服务器通信:spring-doc.cadn.net.cn

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

自定义 SSL 信任材料可以在 SSL 捆绑包中配置并应用于RedisConnectionFactory如以下示例所示:spring-doc.cadn.net.cn

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

Mongo数据库

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

连接到MongoDB数据库

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

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.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]:27017,mongoserver2.example.com:23456/test
spring:
  data:
    mongodb:
      uri: "mongodb://user:[email protected]:27017,mongoserver2.example.com:23456/test"

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

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 与服务器通信:spring-doc.cadn.net.cn

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

自定义 SSL 信任材料可以在 SSL 捆绑包中配置并应用于MongoClient如以下示例所示:spring-doc.cadn.net.cn

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

如果spring.data.mongodb.port未指定,则默认值为27017被使用。 可以从前面显示的示例中删除此行。spring-doc.cadn.net.cn

您还可以使用host:port语法。 如果您需要更改additional-hosts进入。spring-doc.cadn.net.cn

如果您不使用 Spring Data MongoDB,则可以注入MongoClientbean 而不是使用MongoDatabaseFactory. 如果您想完全控制建立 MongoDB 连接,您还可以声明自己的MongoDatabaseFactoryMongoClient豆。
如果您使用的是响应式驱动程序,则 SSL 需要 Netty。 如果 Netty 可用且要使用的工厂尚未自定义,则自动配置会自动配置此工厂。

Mongo模板

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

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

}

请参阅MongoOperationsAPI 文档以获取完整详细信息。spring-doc.cadn.net.cn

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

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

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

Neo4j

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

连接到 Neo4j 数据库

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

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 和凭据: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使用org.neo4j.driver.Config$ConfigBuilder. 要微调其配置,请声明一个或多个ConfigBuilderCustomizer豆。 每个都将按顺序调用,并使用org.neo4j.driver.Config$ConfigBuilder用于构建Driver.spring-doc.cadn.net.cn

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

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-neo4jStarter 启用存储库支持以及事务管理。 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

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

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

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

使用 REST 客户端连接到 Elasticsearch

Elasticsearch 提供了两个不同的 REST 客户端,可用于查询集群:来自org.elasticsearch.client:elasticsearch-rest-client模块和 Java API 客户端co.elastic.clients:elasticsearch-java模块。 此外,Spring Boot 还从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豆。 除了前面描述的属性之外,要微调RestClient您可以注册任意数量的 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"

使用 ElasticsearchClient 连接到 Elasticsearch

如果您有co.elastic.clients:elasticsearch-java在类路径上,Spring Boot 将自动配置并注册一个ElasticsearchClient豆。spring-doc.cadn.net.cn

ElasticsearchClient使用依赖于前面描述的RestClient. 因此,前面描述的属性可用于配置ElasticsearchClient. 此外,您可以定义一个RestClientOptionsbean 来进一步控制传输的行为。spring-doc.cadn.net.cn

使用 ReactiveElasticsearchClient 连接到 Elasticsearch

Spring Data Elasticsearch 发布ReactiveElasticsearchClient以响应式方式查询 Elasticsearch 实例。如果类路径上有 Spring Data Elasticsearch 和 Reactor,Spring Boot 将自动配置并注册一个ReactiveElasticsearchClient.spring-doc.cadn.net.cn

ReactiveElasticsearchClient使用依赖于前面描述的RestClient. 因此,前面描述的属性可用于配置ReactiveElasticsearchClient. 此外,您可以定义一个RestClientOptionsbean 来进一步控制传输的行为。spring-doc.cadn.net.cn

使用 Spring Data 连接到 Elasticsearch

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

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 还可以自动配置ReactiveElasticsearchClientReactiveElasticsearchTemplate作为 bean。它们是其他 REST 客户端的响应式等价物。spring-doc.cadn.net.cn

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 存储库,使用ElasticsearchTemplateReactiveElasticsearchTemplate豆。 鉴于存在所需的依赖项,这些 bean 很可能是由 Spring Boot 自动配置的。spring-doc.cadn.net.cn

如果您希望使用自己的模板来支持 Elasticsearch 存储库,您可以添加自己的模板ElasticsearchTemplateElasticsearchOperations @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

Cassandra

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

连接到 Cassandra

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

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"

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

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 与服务器通信:spring-doc.cadn.net.cn

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 捆绑包中配置并应用于CqlSession如以下示例所示:spring-doc.cadn.net.cn

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

默认情况下,Spring Boot 不会查找这样的文件,但可以使用spring.cassandra.config. 如果属性同时存在于spring.cassandra.*和配置文件中,中的值spring.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

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

Spring Data Cassandra 存储库

Spring Data 包括对 Cassandra 的基本存储库支持。 目前,这比前面讨论的 JPA 存储库和需求更有限@Query带注释的查找器方法。spring-doc.cadn.net.cn

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

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

沙发底座

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

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

客户端证书可用于身份验证,而不是用户名和密码。 可以配置包含客户端证书的 Java 密钥库的位置和密码,如以下示例所示:spring-doc.cadn.net.cn

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 编码证书和私钥的配置如下例所示:spring-doc.cadn.net.cn

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

spring.couchbase.env.timeouts.connect=3s
spring.couchbase.env.ssl.bundle=example
spring:
  couchbase:
    env:
      timeouts:
        connect: "3s"
      ssl:
        bundle: "example"
检查spring.couchbase.env.*properties 了解更多详细信息。 要获得更多控制权,请ClusterEnvironmentBuilderCustomizer可以使用豆子。

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

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

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

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

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

连接到 LDAP 服务器

要连接到 LDAP 服务器,请确保声明对spring-boot-starter-data-ldapstarter 或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

Spring Data LDAP 存储库

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

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

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

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

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属性,如下所示: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