https://docs.spring.io/spring-boot/docs/3.2.0/reference/htmlsingle/#data.nosql
Spring Data提供了额外的项目,有助于你访问各种NoSQL技术,包括:
- Cassandra
- Couchbase
- Elasticsearch
- GemFire 或 Geode
- LDAP
- MongoDB
- Neo4J
- Redis
其中,Spring Boot为Cassandra、Couchbase、Elasticsearch、LDAP、MongoDB、Neo4J和Redis提供了自动配置。此外,Spring Boot for Apache Geode为Apache Geode提供了自动配置。你可以使用其它项目,但必须自己进行配置。
Spring Boot还为InfluxDB客户端提供了自动配置,但它已被弃用,而新的InfluxDB Java客户端提供了自己的Spring Boot集成。
Redis
Redis是一个缓存、消息代理和功能丰富的键值存储。Spring Boot为Lettuce和Jedis客户端库以及Spring Data Redis提供的这些库之上的抽象提供了基本的自动配置。
有一个spring-boot-starter-data-redis
“Starter”可以方便地收集依赖项。默认情况下,它使用Lettuce。该启动器既适用于传统应用程序,也适用于响应式应用程序。
提示:为了与其它具有响应式支持的存储库保持一致,Spring Boot还提供了一个spring-boot-starter-data-redis-reactive
“Starter”。
连接到Redis
可以像注入其他Spring Bean一样注入自动配置的RedisConnectionFactory
、StringRedisTemplate
或普通的RedisTemplate
实例。以下列表显示了此类bean的一个示例:
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");
}
}
默认情况下,该实例尝试连接到localhost:6379
上的Redis服务器。你可以使用spring.data.redis.*
属性指定自定义连接详细信息,如下所示:
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
提示:
还可以注册任意数量的实现LettuceClientConfigurationBuilderCustomizer
接口的bean以进行更高级的自定义。还可以使用ClientResourcesBuilderCustomizer
自定义ClientResources
。如果使用Jedis,则还可以使用JedisClientConfigurationBuilderCustomizer
。另外,可以注册类型为RedisStandaloneConfiguration
、RedisSentinelConfiguration
或RedisClusterConfiguration
的bean,以完全控制配置。
如果添加了任何自动配置类型的自己的@Bean
,则会替换默认配置(但RedisTemplate
除外,排除是基于bean名称redisTemplate
,而不是其类型)。
如果commons-pool2
位于类路径中,则默认情况下将自动配置连接池连接工厂。
可以通过设置以下示例中所示的属性来配置自动配置的RedisConnectionFactory
,以使用SSL与服务器进行通信:
spring.data.redis.ssl.enabled=true
可以在SSL bundle 中配置自定义SSL信任材料,并将其应用于RedisConnectionFactory
,如以下示例所示:
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数据库,可以注入自动配置的org.springframework.data.mongodb.MongoDatabaseFactory
。默认情况下,该实例尝试连接到mongodb://localhost/test
上的MongoDB服务器。以下示例显示了如何连接到MongoDB数据库:
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");
}
}
如果定义了自己的MongoClient
,则会使用它来自动配置一个合适的MongoDatabaseFactory
。
自动配置的MongoClient
是使用MongoClientSettings
bean创建的。如果定义了自己的MongoClientSettings
,则它将未经修改地被使用,并且将忽略spring.data.mongodb
属性。否则,将自动配置一个MongoClientSettings
,并将spring.data.mongodb
属性应用于它。在任何情况下,都可以声明一个或多个MongoClientSettingsBuilderCustomizer
bean来微调MongoClientSettings
配置。每个都将按顺序调用,并使用构建MongoClientSettings
的MongoClientSettings.Builder
。
可以通过设置spring.data.mongodb.uri
属性来更改URL并配置其他设置,如replica
集,如下所示:
spring.data.mongodb.uri=mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test
或者,可以使用离散属性指定连接详细信息。例如,可以在application.properties
中声明以下设置:
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
可以通过设置以下示例中所示的属性来配置自动配置的MongoClient
,以使用SSL与服务器进行通信:
spring.data.mongodb.uri=mongodb://user:secret@mongoserver1.example.com:27017,mongoserver2.example.com:23456/test
spring.data.mongodb.ssl.enabled=true
可以在SSL bundle中配置自定义SSL信任材料,并将其应用于MongoClient
,如以下示例所示:
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.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,如下所示:
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");
}
}
Spring Data MongoDB存储库
Spring Data包括对MongoDB的存储库支持,基本原则是根据方法名自动构建查询。
实际上,Spring Data JPA和Spring Data MongoDB共享相同的公共基础设施。假设City现在是MongoDB数据类而不是JPA @Entity
,如下所示:
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);
}
存储库和文档是通过扫描找到的。默认情况下,将扫描自动配置的包。可以通过分别使用@EnableMongoRepositories
和@EntityScan
来定制查找存储库和文档的位置。
Neo4j
Neo4j是一个开源的NoSQL图形数据库,它使用由一级关系连接的节点丰富的数据模型,这比传统的RDBMS方法更适合连接的大数据。Spring Boot为与Neo4j一起工作提供了几个便利,包括spring-boot-starter-data-neo4j
“Starter”。
连接到Neo4j数据库
要访问Neo4j服务器,可以注入一个自动配置的org.neo4j.driver.Driver
。默认情况下,该实例尝试使用Bolt协议连接到localhost:7687
上的Neo4j服务器。以下示例显示了如何注入Neo4j Driver
,该Driver
除了其它功能外,还提供了对Session的访问:
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());
}
}
}
可以使用spring.neo4j.*
属性配置驱动程序的各种方面。以下示例显示了如何配置要使用的URI和凭据:
spring.neo4j.uri=bolt://my-server:7687
spring.neo4j.authentication.username=neo4j
spring.neo4j.authentication.password=secret
自动配置的Driver
是使用ConfigBuilder
创建的。要微调其配置,请声明一个或多个ConfigBuilderCustomizer
bean。每个bean都将按顺序与用于构建Driver
的ConfigBuilder
一起调用。
Spring Data Neo4j存储库
Spring Data包括Neo4j的存储库支持。
Spring Data Neo4j与其它许多Spring Data模块一样,与Spring Data JPA共享通用基础设施。下面示例中City
定义为Spring Data Neo4j @Node
,而不是JPA @Entity
,存储库抽象将以相同的方式工作,如下所示:
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);
}
spring-boot-starter-data-neo4j
“Starter”启用了存储库支持和事务管理。Spring Boot支持传统的Neo4j存储库和响应式Neo4j存储库,使用Neo4jTemplate
或ReactiveNeo4jTemplate
bean。当Project Reactor在类路径上时,响应式风格也将自动配置。
存储库和实体是通过扫描找到的。默认情况下,将扫描自动配置的包。可以通过分别使用@EnableNeo4jRepositories
和@EntityScan
来定制查找存储库和实体的位置。
注意:在使用响应式样式的应用程序中,不会自动配置ReactiveTransactionManager
。要启用事务管理,必须在你的配置中定义以下bean:
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);
}
}
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.*
属性来进一步调整客户端的配置,如下所示:
spring.elasticsearch.uris=https://search.example.com:9200
spring.elasticsearch.socket-timeout=10s
spring.elasticsearch.username=user
spring.elasticsearch.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的配置,如下所示:
spring.elasticsearch.restclient.sniffer.interval=10m
spring.elasticsearch.restclient.sniffer.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
,如下所示:
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);
}
}
在存在spring-data-elasticsearch
和Reactor的情况下,Spring Boot还可以自动配置ReactiveElasticsearchClient
和ReactiveElasticsearchTemplate
作为beans。它们是其它REST客户端的反应式等价物。
Spring Data Elasticsearch 存储库
Spring Data 为 Elasticsearch 提供了存储库支持,基本原则是根据方法名称自动为您构建查询。
实际上,Spring Data JPA 和 Spring Data Elasticsearch 共享相同的基础设施。
存储库和文档是通过扫描找到的。默认情况下,会扫描自动配置的包。可以使用 @EnableElasticsearchRepositories
和 @EntityScan
分别自定义查找存储库和文档的位置。
Spring Boot 支持经典反应式 Elasticsearch 存储库,使用 ElasticsearchRestTemplate
或 ReactiveElasticsearchTemplate
bean。只要所需的依赖项存在,这些 bean 通常会被 Spring Boot 自动配置。
如果想使用自己的模板来支持 Elasticsearch 存储库,可以添加自己的 ElasticsearchRestTemplate
或 ElasticsearchOperations
@Bean
,只要其名为 “elasticsearchTemplate
” 即可。对于 ReactiveElasticsearchTemplate
和 ReactiveElasticsearchOperations
,同样适用,bean 名称应为 “reactiveElasticsearchTemplate
”。
可以通过以下属性选择禁用存储库支持:
spring.data.elasticsearch.repositories.enabled=false
Cassandra
Cassandra 是一个开源的、分布式的数据库管理系统,设计用于处理跨许多普通服务器的大量数据。Spring Boot 为 Cassandra 提供了自动配置,以及 Spring Data Cassandra 在其之上提供的抽象。有一个名为 "spring-boot-starter-data-cassandra"
的 “Starter”,可以方便地收集依赖项。
连接到 Cassandra
可以像使用其它Spring Bean一样注入自动配置的CassandraTemplate
或Cassandra CqlSession
实例。可以使用spring.cassandra.*
属性来定制连接。通常,需要提供键空间名称(keyspace-name
)和接触点(contact-points
),以及本地数据中心名称,如下所示:
spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1:9042,cassandrahost2:9042
spring.cassandra.local-datacenter=datacenter1
如果所有接触点使用的端口相同,可以使用快捷方式,只指定主机名,如下所示:
spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1
提示:这两个示例是等效的,因为默认端口是 9042
。如果需要配置端口,请使用spring.cassandra.port
。
可以通过设置如下示例中的属性,将自动配置的CqlSession
配置为使用SSL与服务器进行通信:
spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1
spring.cassandra.ssl.enabled=true
可以将自定义的SSL信任材料配置为SSL bundle,并将其应用于CqlSession
,如下所示:
spring.cassandra.keyspace-name=mykeyspace
spring.cassandra.contact-points=cassandrahost1,cassandrahost2
spring.cassandra.local-datacenter=datacenter1
spring.cassandra.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:
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);
}
}
如果你添加了自己的类型为CassandraTemplate
的@Bean
,则会替换默认的CassandraTemplate
。
Spring Data Cassandra 存储库
Spring Data 包含对 Cassandra 的基本存储库支持。目前,与JPA 存储库相比,这种支持更为有限,需要带有 @Query
注解的查找器方法。
通过扫描找到存储库和实体。默认情况下,会扫描自动配置的包。可以使用@EnableCassandraRepositories
和@EntityScan
分别自定义查找存储库和实体的位置。
Couchbase
Couchbase 是一个开源的、分布式的、多模型的 NoSQL 文档数据库,专为交互式应用程序进行优化。Spring Boot 为 Couchbase 提供了自动配置,以及 Spring Data Couchbase 在其之上提供的抽象。有名为 “spring-boot-starter-data-couchbase
” 和 "spring-boot-starter-data-couchbase-reactive"
的 “Starter”,可以方便地收集依赖项。
连接到 Couchbase
可以通过添加 Couchbase SDK 和一些配置来获取一个集群。可以使用spring.couchbase.*
属性来定制连接。通常,需要提供连接字符串、用户名和密码,如下所示:
spring.couchbase.connection-string=couchbase://192.168.1.123
spring.couchbase.username=user
spring.couchbase.password=secret
还可以定制一些ClusterEnvironment
设置。例如,以下配置更改了打开新Bucket
的超时时间,并启用了 SSL 支持,同时引用了配置的 SSL bundle:
spring.couchbase.env.timeouts.connect=3s
spring.couchbase.env.ssl.bundle=example
提示:为了获得更多控制权,可以使用一个或多个ClusterEnvironmentBuilderCustomizer
bean。
Spring Data Couchbase 存储库
Spring Data 包含对 Couchbase 的存储库支持。
通过扫描找到存储库和文档。默认情况下,会扫描自动配置的包。可以使用@EnableCouchbaseRepositories
和@EntityScan
分别自定义查找存储库和文档的位置。
只要有一个CouchbaseClientFactory
bean 可用,就可以像其它 Spring Bean 一样注入自动配置的CouchbaseTemplate
实例。当如上文所述可用一个Cluster
,并且已指定一个存储桶名称时,这种情况就会发生:
spring.data.couchbase.bucket-name=my-bucket
以下示例显示了如何注入一个CouchbaseTemplate
bean:
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();
}
}
可以在自己的配置中定义一些 bean,以覆盖自动配置提供的 bean:
- 一个名为
couchbaseMappingContext
的CouchbaseMappingContext
@Bean
。 - 一个名为
couchbaseCustomConversions
的CustomConversions
@Bean
。 - 一个名为
couchbaseTemplate
的CouchbaseTemplate
@Bean
。
为了避免在自己的配置中硬编码这些名称,可以重用 Spring Data Couchbase 提供的 BeanNames
。例如,可以按以下方式自定义要使用的转换器:
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()));
}
}
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,如下所示:
spring.ldap.urls=ldap://myserver:1235
spring.ldap.username=admin
spring.ldap.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 Bean 一样注入一个自动配置的LdapTemplate
实例,如下所示:
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);
}
}
嵌入式内存 LDAP 服务器
对于测试目的,Spring Boot 支持自动配置来自 UnboundID 的嵌入式内存 LDAP 服务器。要配置服务器,请添加对 com.unboundid:unboundid-ldapsdk
的依赖,并声明一个spring.ldap.embedded.base-dn
属性,如下所示:
spring.ldap.embedded.base-dn=dc=spring,dc=io
注意:
可以定义多个 base-dn
值,但是,由于可分辨名称通常包含逗号,因此必须使用正确的表示法来定义它们。
在 YAML 文件中,可以使用 YAML 列表表示法。在属性文件中,必须将索引作为属性名称的一部分包含进来:
spring.ldap.embedded.base-dn[0]=dc=spring,dc=io
spring.ldap.embedded.base-dn[1]=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
定义你的自定义属性类型或对象类。
InfluxDB
注意:InfluxDB 的自动配置已被弃用,并计划在 Spring Boot 3.4 中移除,转而使用提供其自己的 Spring Boot 集成的新 InfluxDB Java 客户端。
InfluxDB 是一个开源时间序列数据库,专为快速、高可用性存储和检索操作监控、应用指标、物联网传感器数据和实时分析等字段的时间序列数据而优化。
连接到 InfluxDB
如果 influxdb-java
客户端在类路径上,并且已使用 spring.influx.url
设置了数据库的 URL,则 Spring Boot 会自动配置一个 InfluxDB
实例。
如果连接到 InfluxDB 需要用户名和密码,则可以相应地设置spring.influx.user
和spring.influx.password
属性。
InfluxDB 依赖于 OkHttp。如果需要调整 InfluxDB 在后台使用的 http 客户端,可以注册一个InfluxDbOkHttpClientBuilderProvider
bean。
如果需要更多控制权来配置 InfluxDB,请考虑注册一个InfluxDbCustomizer
bean。