Browse Source

Add support for using custom BeanNameGenerator.

Closes: #4756
pull/4728/head
Christoph Strobl 1 year ago
parent
commit
d70508edcf
No known key found for this signature in database
GPG Key ID: E6054036D0C37A4B
  1. 8
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/EnableMongoRepositories.java
  2. 8
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/EnableReactiveMongoRepositories.java
  3. 86
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/config/MongoRepositoriesRegistrarUnitTests.java
  4. 86
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/config/ReactiveMongoRepositoriesRegistrarUnitTests.java

8
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/EnableMongoRepositories.java

@ -23,6 +23,7 @@ import java.lang.annotation.RetentionPolicy; @@ -23,6 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Import;
import org.springframework.data.mongodb.core.MongoTemplate;
@ -117,6 +118,13 @@ public @interface EnableMongoRepositories { @@ -117,6 +118,13 @@ public @interface EnableMongoRepositories {
*/
Class<?> repositoryBaseClass() default DefaultRepositoryBaseClass.class;
/**
* Configure a specific {@link BeanNameGenerator} to be used when creating the repository beans.
* @return the {@link BeanNameGenerator} to be used or the base {@link BeanNameGenerator} interface to indicate context default.
* @since 4.4
*/
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
/**
* Configures the name of the {@link MongoTemplate} bean to be used with the repositories detected.
*

8
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/EnableReactiveMongoRepositories.java

@ -24,6 +24,7 @@ import java.lang.annotation.RetentionPolicy; @@ -24,6 +24,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Import;
import org.springframework.data.mongodb.core.MongoTemplate;
@ -119,6 +120,13 @@ public @interface EnableReactiveMongoRepositories { @@ -119,6 +120,13 @@ public @interface EnableReactiveMongoRepositories {
*/
Class<?> repositoryBaseClass() default DefaultRepositoryBaseClass.class;
/**
* Configure a specific {@link BeanNameGenerator} to be used when creating the repository beans.
* @return the {@link BeanNameGenerator} to be used or the base {@link BeanNameGenerator} interface to indicate context default.
* @since 4.4
*/
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
/**
* Configures the name of the {@link MongoTemplate} bean to be used with the repositories detected.
*

86
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/config/MongoRepositoriesRegistrarUnitTests.java

@ -0,0 +1,86 @@ @@ -0,0 +1,86 @@
/*
* Copyright 2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.mongodb.repository.config;
import static org.assertj.core.api.Assertions.assertThat;
import java.util.Arrays;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.AnnotationBeanNameGenerator;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.mongodb.repository.PersonRepository;
/**
* @author Christoph Strobl
*/
class MongoRepositoriesRegistrarUnitTests {
private BeanDefinitionRegistry registry;
@BeforeEach
void setUp() {
registry = new DefaultListableBeanFactory();
}
@ParameterizedTest // GH-499, GH-3440
@MethodSource(value = { "args" })
void configuresRepositoriesCorrectly(AnnotationMetadata metadata, String[] beanNames) {
MongoRepositoriesRegistrar registrar = new MongoRepositoriesRegistrar();
registrar.setResourceLoader(new DefaultResourceLoader());
registrar.setEnvironment(new StandardEnvironment());
registrar.registerBeanDefinitions(metadata, registry);
Iterable<String> names = Arrays.asList(registry.getBeanDefinitionNames());
assertThat(names).contains(beanNames);
}
static Stream<Arguments> args() {
return Stream.of(
Arguments.of(AnnotationMetadata.introspect(Config.class),
new String[] { "personRepository", "samplePersonRepository", "contactRepository" }),
Arguments.of(AnnotationMetadata.introspect(ConfigWithBeanNameGenerator.class),
new String[] { "personREPO", "samplePersonREPO", "contactREPO" }));
}
@EnableMongoRepositories(basePackageClasses = PersonRepository.class)
private class Config {
}
@EnableMongoRepositories(basePackageClasses = PersonRepository.class, nameGenerator = MyBeanNameGenerator.class)
private class ConfigWithBeanNameGenerator {
}
static class MyBeanNameGenerator extends AnnotationBeanNameGenerator {
@Override
public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
return super.generateBeanName(definition, registry).replaceAll("Repository", "REPO");
}
}
}

86
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/config/ReactiveMongoRepositoriesRegistrarUnitTests.java

@ -0,0 +1,86 @@ @@ -0,0 +1,86 @@
/*
* Copyright 2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.mongodb.repository.config;
import static org.assertj.core.api.Assertions.assertThat;
import java.util.Arrays;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.AnnotationBeanNameGenerator;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.mongodb.repository.PersonRepository;
/**
* @author Christoph Strobl
*/
class ReactiveMongoRepositoriesRegistrarUnitTests {
private BeanDefinitionRegistry registry;
@BeforeEach
void setUp() {
registry = new DefaultListableBeanFactory();
}
@ParameterizedTest // GH-499, GH-3440
@MethodSource(value = { "args" })
void configuresRepositoriesCorrectly(AnnotationMetadata metadata, String[] beanNames) {
ReactiveMongoRepositoriesRegistrar registrar = new ReactiveMongoRepositoriesRegistrar();
registrar.setResourceLoader(new DefaultResourceLoader());
registrar.setEnvironment(new StandardEnvironment());
registrar.registerBeanDefinitions(metadata, registry);
Iterable<String> names = Arrays.asList(registry.getBeanDefinitionNames());
assertThat(names).contains(beanNames);
}
static Stream<Arguments> args() {
return Stream.of(
Arguments.of(AnnotationMetadata.introspect(Config.class), new String[] { "reactivePersonRepository" }),
Arguments.of(AnnotationMetadata.introspect(ConfigWithBeanNameGenerator.class),
new String[] { "reactivePersonREPO" }));
}
@EnableReactiveMongoRepositories(basePackageClasses = PersonRepository.class)
private class Config {
}
@EnableReactiveMongoRepositories(basePackageClasses = PersonRepository.class,
nameGenerator = MyBeanNameGenerator.class)
private class ConfigWithBeanNameGenerator {
}
static class MyBeanNameGenerator extends AnnotationBeanNameGenerator {
@Override
public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
return super.generateBeanName(definition, registry).replaceAll("Repository", "REPO");
}
}
}
Loading…
Cancel
Save