Spring Bean 命名各种方式,看着一篇就够了

2023-12-02 23:28

本文主要是介绍Spring Bean 命名各种方式,看着一篇就够了,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

公众号「架构成长指南」,专注于生产实践、云原生、分布式系统、大数据技术分享。

在 Spring 框架中,每个 bean 必须至少有一个唯一的名称。Spring 遵循简单且默认的命名策略来确定 bean 的名称,无论我们使用 XML 配置还是基于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,还有我们创建的beanappConfigdemoBean.

2. 使用@Bean的默认Bean命名

当我们使用@Bean注解来创建一个新的bean时,该bean将以创建它的方法命名。

让我们通过一个示例来理解,我们创建两个具有不同方法名称的DemoBean类型的 bean 。

@Configuration
public class AppConfig {@BeanDemoBean demoBean(){return new DemoBean();}@BeanDemoBean anotherDemoBean(){return new DemoBean();}
}

当我们运行代码并打印bean名称时,会输出以下结果:

...
appConfig
demoBean
anotherDemoBean

3. 带有值的显式 Bean 命名

对于所有的注解类型,都有一个默认属性名为"value",可以用一个值进行初始化,作为用于标识bean的名称。

@Component(value = "newBeanName")
public class DemoBean {//...
}

注意,@Component(value = "newBeanName") 等同于 @Component("newBeanName")。它们产生一样的结果。

同样@Bean注解有两个属性namevalue,可以为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 {@Overrideprotected 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命名策略希望对你有所帮助。

这篇关于Spring Bean 命名各种方式,看着一篇就够了的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/447233

相关文章

Java实现Excel与HTML互转

《Java实现Excel与HTML互转》Excel是一种电子表格格式,而HTM则是一种用于创建网页的标记语言,虽然两者在用途上存在差异,但有时我们需要将数据从一种格式转换为另一种格式,下面我们就来看看... Excel是一种电子表格格式,广泛用于数据处理和分析,而HTM则是一种用于创建网页的标记语言。虽然两

java图像识别工具类(ImageRecognitionUtils)使用实例详解

《java图像识别工具类(ImageRecognitionUtils)使用实例详解》:本文主要介绍如何在Java中使用OpenCV进行图像识别,包括图像加载、预处理、分类、人脸检测和特征提取等步骤... 目录前言1. 图像识别的背景与作用2. 设计目标3. 项目依赖4. 设计与实现 ImageRecogni

Java中Springboot集成Kafka实现消息发送和接收功能

《Java中Springboot集成Kafka实现消息发送和接收功能》Kafka是一个高吞吐量的分布式发布-订阅消息系统,主要用于处理大规模数据流,它由生产者、消费者、主题、分区和代理等组件构成,Ka... 目录一、Kafka 简介二、Kafka 功能三、POM依赖四、配置文件五、生产者六、消费者一、Kaf

Java访问修饰符public、private、protected及默认访问权限详解

《Java访问修饰符public、private、protected及默认访问权限详解》:本文主要介绍Java访问修饰符public、private、protected及默认访问权限的相关资料,每... 目录前言1. public 访问修饰符特点:示例:适用场景:2. private 访问修饰符特点:示例:

详解Java如何向http/https接口发出请求

《详解Java如何向http/https接口发出请求》这篇文章主要为大家详细介绍了Java如何实现向http/https接口发出请求,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 用Java发送web请求所用到的包都在java.net下,在具体使用时可以用如下代码,你可以把它封装成一

SpringBoot使用Apache Tika检测敏感信息

《SpringBoot使用ApacheTika检测敏感信息》ApacheTika是一个功能强大的内容分析工具,它能够从多种文件格式中提取文本、元数据以及其他结构化信息,下面我们来看看如何使用Ap... 目录Tika 主要特性1. 多格式支持2. 自动文件类型检测3. 文本和元数据提取4. 支持 OCR(光学

Java内存泄漏问题的排查、优化与最佳实践

《Java内存泄漏问题的排查、优化与最佳实践》在Java开发中,内存泄漏是一个常见且令人头疼的问题,内存泄漏指的是程序在运行过程中,已经不再使用的对象没有被及时释放,从而导致内存占用不断增加,最终... 目录引言1. 什么是内存泄漏?常见的内存泄漏情况2. 如何排查 Java 中的内存泄漏?2.1 使用 J

JAVA系统中Spring Boot应用程序的配置文件application.yml使用详解

《JAVA系统中SpringBoot应用程序的配置文件application.yml使用详解》:本文主要介绍JAVA系统中SpringBoot应用程序的配置文件application.yml的... 目录文件路径文件内容解释1. Server 配置2. Spring 配置3. Logging 配置4. Ma

Java 字符数组转字符串的常用方法

《Java字符数组转字符串的常用方法》文章总结了在Java中将字符数组转换为字符串的几种常用方法,包括使用String构造函数、String.valueOf()方法、StringBuilder以及A... 目录1. 使用String构造函数1.1 基本转换方法1.2 注意事项2. 使用String.valu

java脚本使用不同版本jdk的说明介绍

《java脚本使用不同版本jdk的说明介绍》本文介绍了在Java中执行JavaScript脚本的几种方式,包括使用ScriptEngine、Nashorn和GraalVM,ScriptEngine适用... 目录Java脚本使用不同版本jdk的说明1.使用ScriptEngine执行javascript2.