自定义Spring注解bean的命名策略

时间:2023-03-09 07:49:48
自定义Spring注解bean的命名策略

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

例如:

Java代码

1 @Service("TestService")
2 public class TestService {
3 }

这等同于:

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

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

Xml代码

1 <!-- sdp-service主要是注入服务类 -->
2
3 <context:component-scanbase-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代码

1 com.xyz.FooServiceImpl -> fooServiceImpl  

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

1 protected String buildDefaultBeanName(BeanDefinition definition) {
2 String shortClassName = ClassUtils.getShortName(definition.getBeanClassName());
3 return Introspector.decapitalize(shortClassName);
4
5 }

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

Java代码

1 public class SdpAnnotationBeanNameGenerator extends AnnotationBeanNameGenerator {
2 @Override
3 protected String buildDefaultBeanName(BeanDefinitiondefinition) {
4 return definition.getBeanClassName();
5 }
6 }

我的改写代码:

自定义Spring注解bean的命名策略
 1 @Override
2 protected String buildDefaultBeanName(BeanDefinition definition) {
3 String className =definition.getBeanClassName();
4
5 className=className.substring(className.lastIndexOf(".")+1);
6 if(className.toLowerCase().endsWith("impl")){
7 className=className.substring(0, className.length()-4);
8 }
9 if((className.toLowerCase().endsWith("service")||className.toLowerCase().endsWith("dao"))==false){
10 return super.buildDefaultBeanName(definition);
11 }
12
13
14 className=className.substring(0,1).toLowerCase() + className.substring(1);
15 return className;
16 }
自定义Spring注解bean的命名策略

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

1 <!-- sdp-service主要是注入服务类 -->
2 <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就返回此类的实例,而不用在

强制转换类型了。

1 public static <T>T getService(String classFullName) throws ClassNotFoundException,BeansException{
2 Class<T> requiredType=(Class<T>)Class.forName(classFullName);
3 return SdpContext.getContext().getBean(classFullName,requiredType); }

强制转换类型代码:

Java代码

1 TestService testService2=(TestService ) SdpContext.getContext().getBean("TestService ");
2 System.out.println(testService2);

改进后的代码:

Java代码

1 @Service
2 public class TestService { }
1 TestService testService=SdpContext.getService("org.sdp.context.TestService");
2 System.out.println(testService);