Spring 中三种 BeanName 生成器！

江南一点雨

发布于 2023-09-20 09:02:46

2600

发布于 2023-09-20 09:02:46

无论我们是通过 XML 文件，还是 Java 代码，亦或是包扫描的方式去注册 Bean，都可以不设置 BeanName，而 Spring 均会为之提供默认的 beanName，今天我们就来看看 Spring 中三种处理不同情况的 beanName 生成器。

1. BeanNameGenerator

Spring 中提供了一个名为 BeanNameGenerator 的接口，这个接口就只有一个需要实现的方法就是 generateBeanName，从名字就能看出来，这就是专门用来生成 beanName 的方法。

public interface BeanNameGenerator {
 String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry);
}

这个方法有两个参数：

definition：这个是要生成的 Bean 定义。
registry：这个是将来 BeanDefinition 的注册器。

BeanNameGenerator 有三个不同的实现类，对应不同的处理场景：

AnnotationBeanNameGenerator：这个专门用来处理包扫描的时候扫到的 Bean，对于这些 Bean，其 name 属性该如何处理，由这个类来解决，当然，小伙伴们都知道，通过 @Component/@Service/@Repository/@Controller 这些注解定义的 Bean，默认情况下，beanName 就是类名首字母小写。
FullyQualifiedAnnotationBeanNameGenerator：这个继承自 AnnotationBeanNameGenerator，并重写了 AnnotationBeanNameGenerator#buildDefaultBeanName 方法，这个是使用类的全路径来作为 Bean 的默认名称。
DefaultBeanNameGenerator：这个是专门用来解决 XML 文件中定义的 Bean 如果没有设置 beanName，那么就通过 DefaultBeanNameGenerator 来为其生成 beanName。

看了上面三个场景之后，可能有小伙伴发现一个 BUG，那么 @Bean 注解定义的 Bean，其 beanName 属性是在哪里处理的呢？这个其实比较特殊，是当场处理的，没用到 BeanNameGenerator，松哥后面单独说。

接下来我们详细看下上面这三个实现类。

2. AnnotationBeanNameGenerator

咱们直接来看最关键的 generateBeanName 方法吧：

@Override
public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
 if (definition instanceof AnnotatedBeanDefinition) {
  String beanName = determineBeanNameFromAnnotation((AnnotatedBeanDefinition) definition);
  if (StringUtils.hasText(beanName)) {
   // Explicit bean name found.
   return beanName;
  }
 }
 // Fallback: generate a unique default bean name.
 return buildDefaultBeanName(definition, registry);
}

这个方法首先判断 definition 是否为 AnnotatedBeanDefinition 类型，根据我们前面文章对 BeanDefinition 的介绍（七种 BeanDefinition，各显其能！），大家知道，AnnotatedBeanDefinition 的实现类主要是针对三种情况：@Bean 注解定义的 Bean、@Service/@Controller/@Component/@Repository 等注解标记的 Bean 以及系统的启动配置类，如果是这三种情况，那么就去调用 determineBeanNameFromAnnotation 方法，这个方法会尝试从注解中提取出来 beanName，如果不是上面三种情况，那么就调用 buildDefaultBeanName 方法去生成 beanName。

那我们先来看 determineBeanNameFromAnnotation 方法：

@Nullable
protected String determineBeanNameFromAnnotation(AnnotatedBeanDefinition annotatedDef) {
 AnnotationMetadata amd = annotatedDef.getMetadata();
 Set<String> types = amd.getAnnotationTypes();
 String beanName = null;
 for (String type : types) {
  AnnotationAttributes attributes = AnnotationConfigUtils.attributesFor(amd, type);
  if (attributes != null) {
   Set<String> metaTypes = this.metaAnnotationTypesCache.computeIfAbsent(type, key -> {
    Set<String> result = amd.getMetaAnnotationTypes(key);
    return (result.isEmpty() ? Collections.emptySet() : result);
   });
   if (isStereotypeWithNameValue(type, metaTypes, attributes)) {
    Object value = attributes.get("value");
    if (value instanceof String strVal) {
     if (StringUtils.hasLength(strVal)) {
      if (beanName != null && !strVal.equals(beanName)) {
       throw new IllegalStateException("Stereotype annotations suggest inconsistent " +
         "component names: '" + beanName + "' versus '" + strVal + "'");
      }
      beanName = strVal;
     }
    }
   }
  }
 }
 return beanName;
}

这个方法首先会去获取类上的注解信息，拿到 amd 之后，获取到所有的注解类型，然后进行遍历。

遍历的时候，首先获取到注解上的所有属性 attributes，当 attributes 不为空的时候，继续去读取当前注解的元注解，并将读取到的结果存入到 metaAnnotationTypesCache 集合中。这个是干嘛呢？大家知道，Spring 中用来标记 Bean 的注解大部分衍生自 @Component，甚至我们也可以自定义注解，那么如果自定义注解了，这个地方就没法判断了，因为每个人自定义出来的注解都不一样。所以，万变不离其宗，这里就去找各个注解的元注解。例如如果我们在类上添加的是 @Configuration，那么 @Configuration 的元注解有两个，分别是 @Component 和 @Indexed。

接下来的 isStereotypeWithNameValue 方法就是判断 type 是不是 @Component 或者 Jakarta 中自带的 @ManagedBean、@Named，亦或者 metaTypes 里是否包含 @Component。如果确定是 @Component 衍生出来的注解，亦或者是 @ManagedBean、@Named 注解标记的 Bean，那么就将其 value 属性读取出来，作为 beanName，如果包含多个有效注解，且各自配置的 beanName 不一致，就会抛出异常。

例如下面这种情况：

@Configuration("j")
@Component("a")
public class JavaConfig {
}

这两个 beanName 不一致，运行时就会出错。

同时，经过上面的分析，小伙伴也看到了，我们其实可以通过自定义注解为 Bean 设置名称，例如我有如下注解：

@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface MyBeanName {
    String value() default "";
}

这个注解衍生自 @Component，那么它的用法如下：

@MyBeanName("f")
public class JavaConfig {

}

那么 f 就是当前类生成的 beanName。

以上是从注解中去提取 beanName，但是注解中可能没有提供 beanName，那么就得调用 buildDefaultBeanName 方法去自动生成了，如下：

protected String buildDefaultBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
 return buildDefaultBeanName(definition);
}
protected String buildDefaultBeanName(BeanDefinition definition) {
 String beanClassName = definition.getBeanClassName();
 Assert.state(beanClassName != null, "No bean class name set");
 String shortClassName = ClassUtils.getShortName(beanClassName);
 return StringUtils.uncapitalizeAsProperty(shortClassName);
}

这个就很好懂了，先拿到 bean 的完整类名，然后提取出来 shortName，也就是去除包名之后的名字，然后首字母小写之后返回。

这就是 @Component 注解体系下的 beanName 生成流程。

3. FullyQualifiedAnnotationBeanNameGenerator

FullyQualifiedAnnotationBeanNameGenerator 类只是重写了 AnnotationBeanNameGenerator 的 buildDefaultBeanName 方法，如下：

@Override
protected String buildDefaultBeanName(BeanDefinition definition) {
 String beanClassName = definition.getBeanClassName();
 Assert.state(beanClassName != null, "No bean class name set");
 return beanClassName;
}

重写后的方法就是获取类的完整路径返回。

FullyQualifiedAnnotationBeanNameGenerator 默认情况下并不会直接使用，需要自己手动配置，像下面这样：

@Configuration
@ComponentScan(nameGenerator = FullyQualifiedAnnotationBeanNameGenerator.class)
public class JavaConfig {

}

此时，生成的 Bean 的默认名称就是类的全路径了。

4. DefaultBeanNameGenerator

这个是专门用来处理 XML 中默认的 beanName 的。这个在最近录制的 Spring 源码视频中已经详细介绍过了，这里就不再啰嗦了，感兴趣的小伙伴戳这里：Spring源码应该怎么学？。

5. @Bean 处理特殊情况

如果类是被 @Bean 注解标记的，那么处理情况就特殊一些，直接现场处理，方法在 org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForBeanMethod 位置：

private void loadBeanDefinitionsForBeanMethod(BeanMethod beanMethod) {
 // Consider name and any aliases
 List<String> names = new ArrayList<>(Arrays.asList(bean.getStringArray("name")));
 String beanName = (!names.isEmpty() ? names.remove(0) : methodName);

 // Register aliases even when overridden
 for (String alias : names) {
  this.registry.registerAlias(beanName, alias);
 }
}

从这里可以看到，如果一开始配置了 name 属性，那么就把 names 集合中的第一个值拿出来作为 beanName，集合中的其他值则当作别名来处理，如果没有配置 name 属性值，那么就使用方法名作为 beanName。