<context:component-scan>的name-generator属性自定义Spring Bean注解命名规则

最新推荐文章于 2024-07-30 09:01:31 发布

frankliu01

最新推荐文章于 2024-07-30 09:01:31 发布

阅读量6.1k

点赞数 2

分类专栏： Spring

Spring 专栏收录该内容

26 篇文章

订阅专栏

本文介绍如何解决 Spring 框架中因多人协作导致的 Bean 名称冲突问题，提出一种新的 Bean 命名策略，即使用类的全限定名作为 Bean 的 ID，并提供实现方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

由于项目的需要spring的业务相关的bean不是写在xml文件中，因为项目是一个模块一个模块提交的，提交的时候不想修改xml文件，因此就用到了spring的注解Service。

例如：

Java代码  

@Service("TestService")  

public class TestService {  

}

这等同于：

Xml代码  

<bean id="TestService" class="TestService"/>  

spring会在classpath里面扫描标记有TestService等标签的类，扫描组件的配置如下：

Xml代码  

<!-- sdp-service主要是注入服务类 -->  

<context:component-scan base-package="org.sdp" />  

加上以上的配置后，spring会自动的扫描org.sdp文件下的标记有注释的类。

以上的配置看似很“完美”，其实如果项目稍微大时就会出现问题，大家都知道spring的bean的id必须唯一，如果两个人同事写代码就有可以造成写同样的bean名称。

解决这个问题的一个思路是把bean的名称修改为类的全路径，例如org.sdp.A 和com.bey.A 。

只要修改spring默认的bean命名策略就可以了。

AnnotationBeanNameGenerator是bean的默认命名策略，他实现了BeanNameGenerator接口。在Service里面，如果不写bean的名称，那么默认的名曾是类名，但是第一个字母是小写的。

例如：

Html代码  

com.xyz.FooServiceImpl -> fooServiceImpl  

观察spring的源代码发现，buildDefaultBeanName方法首先了bean名称小写的作用。

Java代码  

protected String buildDefaultBeanName(BeanDefinition definition) {  

        String shortClassName = ClassUtils.getShortName(definition.getBeanClassName());  

        return Introspector.decapitalize(shortClassName);  

    }

因此，可以写一个类继承自AnnotationBeanNameGenerator，重写buildDefaultBeanName方法。

Java代码  

public class SdpAnnotationBeanNameGenerator extends AnnotationBeanNameGenerator {  

    @Override  

    protected String buildDefaultBeanName(BeanDefinition definition) {  

        return definition.getBeanClassName();  

    }  

}

在扫描配置中需要添加自己的命名策略类：

Xml代码  

<!-- sdp-service主要是注入服务类 -->  

lt;context:component-scan base-package="org.sdp" name-generator="org.sdp.spring.SdpAnnotationBeanNameGenerator" />  

通过以上配置，业务相关的bean不用写bean的名称了，ApplicationContext.getBean("类的全路径")就可以得到类的实例了。

如果是spring2.5则就结束了，但是spring3.0为完美提供了getBean(name,requiredType);使用了泛型，因此只要传入一个业务类的Class，getBean就返回此类的实例，而不用在

强制转换类型了。

Java代码  

public static <T>T getService(String classFullName) throws ClassNotFoundException,BeansException{  

        Class<T> requiredType=(Class<T>) Class.forName(classFullName);  

        return SdpContext.getContext().getBean(classFullName,requiredType);  

    }

强制转换类型代码：

Java代码  

TestService testService2=(TestService ) SdpContext.getContext().getBean("TestService ");  

System.out.println(testService2);  

改进后的代码：

Java代码  

@Service  

public class TestService {  

}

Java代码  

TestService testService=SdpContext.getService("org.sdp.context.TestService");  

System.out.println(testService);  

<context:component-scan>的name-generator属性 自定义Spring Bean注解命名规则

<context:component-scan>的name-generator属性自定义Spring Bean注解命名规则