Allow customizing the bean name for repository beans [DATACMNS-168]

[spring-projects-issues]

Andreas Hackl opened DATACMNS-168 and commented

Its not possible to specify two repositories with the same name in different packages, because the beans are registered with the same name (uncapitalized non-qualified class name). So only the repository which was generated at least is in the bean definition or an BeanDefinitionStoreException occurs when bean definition overriding is not allowed.

Provide the ability to specify a specifiy bean name for a repository or a custom BeanNameGenerator strategy for bean name resolution. This is already possible in the core spring framework for naming autodetected components.

@Repository("myRepositoryBeanName")
public interface MyRepository extends Respository<...> {
    // ...
}

or

<beans ...>
    <jpa:repositories base-package="org.example" name-generator="org.example.MyNameGenerator" />
</beans>

---

Issue Links:

• DATACMNS-169 Handle naming collisions of interfaces when scanning and registering repository bean definitions

Referenced from: commits 874da36, b4a553e

Backported to: 1.5 Final, 1.4.1

1 votes, 5 watchers

[spring-projects-issues]

Oliver Drotbohm commented

You definitiely have a point here but I'd like to lower the severity as there's an easy workaround by slightly renaming one of the candidate repository interfaces

[spring-projects-issues]

Oliver Drotbohm commented

The bean name to be used is now determined by an AnnotationBeanNameGenerator which inspects the Spring stereotype annotations or falls back to the simple interface name. Registering custom BeanNameGenerator is not supported yet but the currently implemented solution should provide enough functionality to naturally customize bean names if necessary

[spring-projects-issues]

Diego Díez Ricondo commented

Are there any plans to allow registering a custom BeanNameGenerator? I feel the workaround using @Named a bit hardcoded. I am looking for somethin more 'dynamic'.
In our case, we have N repositories with the same name but in different feaures/packages (package visible to grant encapsulation), but with the currenly behaviour you could end up having name collisions.

I was thinking one of these options could replace the hardcoded delegate AnnotationBeanNameGenerator:

@EnableJpaRepositories(nameGenerator = MyCustomBeanNameGenerator.class)

new SpringApplicationBuilder(Application.class)
                .beanNameGenerator(new MyCustomBeanNameGenerator())
                .run(args);

Does it make sense?

[spring-projects-issues]

Sascha Woo commented

I've create a PR for it #262

[spring-projects-issues]

Oliver Drotbohm commented

Sascha Woo – Care to create a new ticket as this one has been resolved for quite some time already

[spring-projects-issues]

Sascha Woo commented

Okay will create a new one and update the PR