|
对于最新的稳定版本，请使用 Spring Data LDAP 3.5.2！ |
配置
本节介绍配置 Spring Data LDAP。
Spring LDAP 存储库可以通过使用<data-ldap:repositories>标记或使用@EnableLdapRepositories配置类上的注释：
-
“Spring 命名空间”（XML 配置）
-
“基于注释的配置”（Java 配置）
包括对LdapQuery参数，让您的接口扩展LdapRepository而不是CrudRepository.
所有 Spring LDAP 存储库都必须使用带有 ODM 注释的实体，如对象目录映射中所述。
由于所有 ODM 托管类都必须具有 Distinguished Name 作为 ID，因此所有 Spring LDAP 存储库都必须将 ID 类型参数设置为javax.naming.Name.
事实上，内置的LdapRepository仅采用一个类型参数：托管实体类，其默认 ID 为javax.naming.Name.
由于 LDAP 协议的特殊性，Spring LDAP 存储库不支持分页和排序。
您必须使用 ODM 注释，例如org.springframework.ldap.odm.annotations.Id.
使用 Spring Data 的 Comments 不起作用，因为 Spring LDAP 使用自己的映射层。 |
基于注释的配置
Spring Data LDAP 存储库支持可以通过 JavaConfig 和自定义 XML 命名空间激活，如以下示例所示：
@Configuration
@EnableLdapRepositories("com.acme.*.repositories")
class MyConfig {
@Bean
ContextSource contextSource() {
LdapContextSource ldapContextSource = new LdapContextSource();
ldapContextSource.setUserDn("cn=Admin");
ldapContextSource.setPassword("secret");
ldapContextSource.setUrl("ldap://127.0.0.1:389");
return ldapContextSource;
}
@Bean
LdapTemplate ldapTemplate(ContextSource contextSource) {
return new LdapTemplate(contextSource);
}
}此配置会导致扫描基本包以查找扩展包含 LDAP 存储库的接口，并为找到的每个存储库创建 Spring Bean。
如果未配置基本包，则基础架构将扫描带注释的配置类的包。
Spring 命名空间
Spring Data 的 LDAP 模块包含一个自定义命名空间，允许定义存储库 Bean。
它还包含 LDAP 特有的某些功能和元素属性。
通常，可以使用repositories元素，如以下示例所示：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ldap="http://www.springframework.org/schema/ldap"
xmlns:data-ldap="http://www.springframework.org/schema/data/ldap"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/ldap
https://www.springframework.org/schema/ldap/spring-ldap.xsd
http://www.springframework.org/schema/data/ldap
https://www.springframework.org/schema/data/ldap/spring-ldap.xsd">
<ldap:context-source url="ldap://127.0.0.1:389"
username="cn=Admin"
password="secret" />
<ldap:ldap-template />
<data-ldap:repositories base-package="com.acme.*.repositories" />
</beans>此配置会导致扫描基本包以查找扩展包含 LDAP 存储库的接口，并为找到的每个存储库创建 Spring Bean。
默认情况下，存储库会自动连接LdapTemplate被称为春豆ldapTemplate，因此您只需配置ldap-template-ref如果您偏离此约定，则明确。
| JavaConfig 和 XML 哪个更好？ XML 是很久以前 Spring 的配置方式。 在当今 Java、记录类型、注释等快速增长的时代，新项目通常使用尽可能多的纯 Java。 虽然没有立即取消 XML 支持的计划，但某些最新功能可能无法通过 XML 获得。 |
使用repositories元素查找 Spring Data 存储库，如创建存储库实例中所述。
自定义命名空间属性
超越默认属性repositories元素，LDAP 命名空间提供了其他属性，使您可以更详细地控制存储库的设置：
|
显式连接 |
Spring Data LDAP 需要LdapMappingContext名为 beanldapMappingContext在场。
如果没有定义这样的bean，则Spring Data LDAP会在应用程序上下文中注册一个默认实例。 |