Skip to content

Add support for using custom BeanNameGenerator. #2952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<version>3.4.0-SNAPSHOT</version>
<version>3.4.x-GH-2951-SNAPSHOT</version>

<name>Spring Data Redis</name>
<description>Spring Data module for Redis</description>
Expand All @@ -18,7 +18,7 @@
</parent>

<properties>
<springdata.keyvalue>3.4.0-SNAPSHOT</springdata.keyvalue>
<springdata.keyvalue>3.4.x-GH-586-SNAPSHOT</springdata.keyvalue>
<springdata.commons>3.4.0-SNAPSHOT</springdata.commons>
<awaitility>4.0.2</awaitility>
<beanutils>1.9.4</beanutils>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
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.keyvalue.core.KeyValueOperations;
Expand Down Expand Up @@ -126,6 +127,13 @@
*/
Class<?> repositoryBaseClass() default DefaultRepositoryBaseClass.class;

/**
* Configure a specific {@link BeanNameGenerator} to be used when creating the repositoy beans.
* @return the {@link BeanNameGenerator} to be used or the base {@link BeanNameGenerator} interface to indicate context default.
* @since 3.4
*/
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;

/**
* Configures the name of the {@link KeyValueOperations} bean to be used with the repositories detected.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
/*
* 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.redis.repository.configuration;

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.redis.core.RedisHash;
import org.springframework.data.repository.CrudRepository;

/**
* @author Christoph Strobl
*/
class RedisRepositoriesRegistrarUnitTests {

private BeanDefinitionRegistry registry;

@BeforeEach
void setUp() {
registry = new DefaultListableBeanFactory();
}

@ParameterizedTest // GH-499, GH-3440
@MethodSource(value = { "args" })
void configuresRepositoriesCorrectly(AnnotationMetadata metadata, String[] beanNames) {

RedisRepositoriesRegistrar registrar = new RedisRepositoriesRegistrar();
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[] { "redisRepositoriesRegistrarUnitTests.PersonRepository" }),
Arguments.of(AnnotationMetadata.introspect(ConfigWithBeanNameGenerator.class),
new String[] { "redisRepositoriesRegistrarUnitTests.PersonREPO" }));
}

@EnableRedisRepositories(basePackageClasses = PersonRepository.class, considerNestedRepositories = true)
private class Config {

}

@EnableRedisRepositories(basePackageClasses = PersonRepository.class, nameGenerator = MyBeanNameGenerator.class,
considerNestedRepositories = true)
private class ConfigWithBeanNameGenerator {

}

static class MyBeanNameGenerator extends AnnotationBeanNameGenerator {

@Override
public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
return super.generateBeanName(definition, registry).replaceAll("Repository", "REPO");
}
}

interface PersonRepository extends CrudRepository<Person, String> {

}

@RedisHash
static class Person {}
}
Loading