还是基于Java代码配置。本文将详细讨论这些策略。
1.使用@Component的默认Bean命名
默认情况下,Spring会使用声明Bean类型的简单名称,将第一个字母改为小写,并使用生成的值来命名Bean。此种方式适用于所有定型注解(@Service、@Repository 等)。
下面我我们声明一个非常简单的bean,如下所示:
@Configuration
@ComponentScan
public class AppConfig {
//...
}
@Component
public class DemoBean {
//...
}
DemoBean使用@Component注解,当我们从应用程序上下文中检索 bean 并打印其名称时,它会打印“ demoBean ”。
var applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
Arrays.stream(applicationContext.getBeanDefinitionNames()).forEach(System.out::println);
程序输出:
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.annotation.internalPersistenceAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
appConfig
demoBean
在以上结果输出中,我们可以看到 Spring 创建的基础设施 bean,还有我们创建的beanappConfig和demoBean.
2. 使用@Bean的默认Bean命名
当我们使用@Bean注解来创建一个新的bean时,该bean将以创建它的方法命名。
让我们通过一个示例来理解,我们创建两个具有不同方法名称的DemoBean类型的 bean 。
@Configuration
public class AppConfig {
@Bean
DemoBean demoBean(){
return new DemoBean();
}
@Bean
DemoBean anotherDemoBean(){
return new DemoBean();
}
}
当我们运行代码并打印bean名称时,会输出以下结果:
...
appConfig
demoBean
anotherDemoBean
3. 带有值的显式 Bean 命名
对于所有的注解类型,都有一个默认属性名为"value",可以用一个值进行初始化,作为用于标识bean的名称。
@Component(value = "newBeanName")
public class DemoBean {
//...
}
注意,@Component(value = "newBeanName") 等同于 @Component("newBeanName")。它们产生一样的结果。
同样@Bean注解有两个属性name 和 value,可以为bean定义一个显式名称。
@Configuration
public class AppConfig {
@Bean(name = "newBeanName")
DemoBean demoBean(){
return new DemoBean();
}
@Bean(value = "anotherNewBeanName")
DemoBean anotherDemoBean(){
return new DemoBean();
}
}
当我们运行代码并打印bean名称时,会输出以下结果:
...
appConfig
newBeanName
anotherNewBeanName
4. Bean 名称别名:多个 Bean 名称
@Bean 注解的 name 或 value 属性可以指定一个值数组,用于引用 bean 的名称。当这样做时,数组中的第一个值将成为主要名称,而其他值将成为别名。
@Bean(value = {"newBeanName", "newBeanName-1", "newBeanName-2"})
DemoBean demoBean(){
return new DemoBean();
}
现在,当打印 bean 的名称时,它仍然是 "newBeanName"。但是当我们打印 bean 的名称别名时,我们会得到额外的名称,即 "newBeanName-1" 和 "newBeanName-2"。
var applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
Arrays.stream(applicationContext.getBeanDefinitionNames()).forEach(System.out::println);
var demoBean = applicationContext.getBeansOfType(DemoBean.class);
demoBean.forEach((k, v) -> {
var aliases = applicationContext.getAliases(k);
if (aliases.length > 0) {
Arrays.stream(aliases).forEach(System.out::println);
}
});
输出
...
appConfig
newBeanName
newBeanName-2
newBeanName-1
5.生成自定义Bean名称
与Spring中的所有功能类似,bean的命名也可以进行自定义。为了进行自定义名称生成,我们可以定义一个类,继承 AnnotationBeanNameGenerator 并在 @ComponentScan 注解中指定该类的名称。
@Configuration
@ComponentScan(nameGenerator = CustomBeanNameGenerator.class)
public class AppConfig {
//...
}
接下来,我们通过在 CustomBeanNameGenerator 类中重写 buildDefaultBeanName() 方法来定义自定义的名称生成逻辑。
以下示例会返回由小写的简单类名与唯一标识符连接而成的 bean 名称。
public class CustomBeanNameGenerator extends AnnotationBeanNameGenerator {
@Override
protected String buildDefaultBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
var beanName = definition.getBeanClassName()
.substring(definition.getBeanClassName().lastIndexOf(".") + 1)
.toLowerCase(Locale.ROOT);
var uid = UUID.randomUUID().toString().replace("-","").substring(0,8);
return beanName + "-" + uid;
}
}
输出
appConfig
demobean-889ed00b
总结
在本Spring教程中,我们学习了5种bean命名策略希望对你有所帮助。