通过注释而不是XML配置Spring LdapTemplate的最佳实践？

Question

对于Spring Boot应用程序，我使用注释成功地配置了SpringLdapTemplate，包括应用程序中带有@Values的LdapContextSource依赖项。财产。（呜呜！我找不到一个例子，所以这可能会帮助其他人。）

下面的代码片段设置了上下文源，将其插入到LdapTemplate中，并将其自动连接到my DirectoryService中。

有没有更好/更干净的方法来设置ContextSource在Spring Boot应用程序中？

应用属性（在类路径上）：

ldap.url=ldap://server.domain.com:389
ldap.base:OU=Employees,OU=Users,DC=domain,DC=com
ldap.username:CN=myuserid,OU=employees,OU=Users,DC=domain,DC=com
ldap.password:secretthingy

MyLdapContextSource.java：

@Component
public class MyLdapContextSource extends LdapContextSource implements ContextSource {

    @Value("${ldap.url}")
    @Override
    public void setUrl(String url) { super.setUrl(url);  }

    @Value("${ldap.base}")
    @Override
    public void setBase(String base) {super.setBase(base); }

    @Value("${ldap.username}")
    @Override
    public void setUserDn(String userDn) {super.setUserDn(userDn); }

    @Value("${ldap.password}")
    @Override
    public void setPassword(String password) { super.setPassword(password); }
}

我的模板。爪哇：

@Component
public class MyLdapTemplate extends LdapTemplate {

    @Autowired
    public MyLdapTemplate(ContextSource contextSource) { super(contextSource); }
}

目录服务。爪哇：

@Service
public class DirectoryService {

    private final LdapTemplate ldapTemplate;

    @Value("${ldap.base}")
    private String BASE_DN;

    @Autowired
    public DirectoryService(LdapTemplate ldapTemplate) { this.ldapTemplate = ldapTemplate; }

    public Person lookupPerson(String username) {
        return (Person) ldapTemplate.lookup("cn=" + username, new PersonAttributesMapper());
    }

    public List<Person> searchDirectory(String searchterm) {
        SearchControls searchControls = new SearchControls();
        searchControls.setCountLimit(25);
        searchControls.setSearchScope(SearchControls.SUBTREE_SCOPE);

        List<Person> people = (List<Person>) ldapTemplate.search(
                BASE_DN, "cn=" + searchterm, searchControls, new PersonAttributesMapper());
        return people;
    }
}

Answer 1

对于直截了当的情况，根本不需要显式地连接LDAP。这正是Spring Boot首先要通过固执己见来消除的。

确保包含spring boot starter数据ldap或spring ldap核心依赖项，例如在pom:xml中包含Maven：

xml prettyprint-override"><dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-ldap</artifactId>
</dependency>

在应用程序中配置LDAP。属性，使用以下键：

# Note the spring prefix for each and use just the CN for username
spring.ldap.url=ldap://server.domain.com:389
spring.ldap.base=OU=Employees,OU=Users,DC=domain,DC=com
spring.ldap.username=myuserid
spring.ldap.password=secretthingy

然后简单地依靠Spring自动连线，例如使用现场注射¹：

@Autowired
private final LdapTemplate ldapTemplate;

参考： Spring Boot参考指南： LDAP

¹通常不推荐现场注射，但在这里用于简洁。

Answer 2

为什么所有的子类？只需使用配置来配置bean。XML或Java配置。

@Configuration
public class LdapConfiguration {

    @Autowired
    Environment env;

    @Bean
    public LdapContextSource contextSource () {
        LdapContextSource contextSource= new LdapContextSource();
        contextSource.setUrl(env.getRequiredProperty("ldap.url"));
        contextSource.setBase(env.getRequiredProperty("ldap.base"));
        contextSource.setUserDn(env.getRequiredProperty("ldap.user"));
        contextSource.setPassword(env.getRequiredProperty("ldap.password"));
        return contextSource;
    }

    @Bean
    public LdapTemplate ldapTemplate() {
        return new LdapTemplate(contextSource());        
    }

}

您的DirectoryService可以保持不变，因为它将自动连接LdapTemplate。

一般的经验法则是，您不想扩展基础结构bean（比如DataSource或LdapTemplate），而是显式地配置它们。这与应用程序bean（服务、存储库等）不同。