Usage of LdapTemplate forces to make project dependent on spring-boot-starter-data-ldap even when there are no instances of LdapRepository #14663
Description
I've prepared a demonstration for this case:
- checkout https://github.com/stsypanov/spring-boot-ldap-issue
- run
LimitTest
Test fails with NoSuchBeanDefinitionException and this explanation:
Description:
Parameter 0 of method ldapTemplate in com.luxoft.logeek.AppConfig required a bean of type 'org.springframework.ldap.core.LdapTemplate' that could not be found.
- Bean method 'ldapTemplate' not loaded because @ConditionalOnClass did not find required class 'org.springframework.data.ldap.repository.LdapRepository'
Here SB suggests to add dependency on 'org.springframework.data.ldap.repository.LdapRepository' which in fact means to add spring-boot-starter-data-ldap.
Looking closer it turns out that LdapTemplate is declared in LdapDataAutoConfiguration:
@Configuration
@ConditionalOnClass({LdapContext.class, LdapRepository.class})
@AutoConfigureAfter({LdapAutoConfiguration.class})
public class LdapDataAutoConfiguration {
public LdapDataAutoConfiguration() {
}
@Bean
@ConditionalOnMissingBean({LdapOperations.class})
public LdapTemplate ldapTemplate(ContextSource contextSource) {
return new LdapTemplate(contextSource);
}
}This forces to include spring-boot-starter-data-ldap into project dependencies even when there are no classes/interfaces extending from LdapRepository. So to fix the test I have to either uncomment spring-boot-starter-data-ldap declaration in pom.xml (lines 25-28), or to explicitly define LdapTemplate in context configuration.
Mixing spring-boot-starter-data-ldap and spring-boot-starter-data-jpa in project dependencies slows down application startup as spring-boot-starter-data-ldap somehow interacts with repository interfaces extending JpaRepository (see https://jira.spring.io/projects/DATAJPA/issues/DATAJPA-1370). On on of our projects with several dozens of JPA repositories we achieved even 30 seconds startup time reduction just replacing spring-boot-starter-data-ldap with spring-ldap-core.
Described workaround with explicit LdapTemplate definition seems to be dubious as it does what can be done by SB automatically. Also current declaration of LdapTemplate inside of LdapDataAutoConfiguration seems to be wrong because LdapTemplate is not necessarily a part of Spring Data LDAP and should be available as simple LDAP-related component.
Thus I suggest to move declaration of LdapTemplate into LdapAutoConfiguration and remove LdapDataAutoConfiguration. Anyway we have LdapRepositoriesAutoConfiguration for the case user need Spring Data LDAP.