基于类所属包自定义Bean名称生成器的实现及Spring库中的配置方法

嘿，看来你遇到了Spring库Bean命名冲突的问题，我来帮你一步步解决！

一、完善自定义Bean名称生成器，实现按包前缀命名 #

你写的AnnotationBeanNameGenerator子类思路是对的，而且完全可以拿到Bean所属的包信息——通过BeanDefinition的getBeanClassName()方法就能获取类的全限定名，进而解析出包路径，判断是否属于你的库的目标包，再决定是否添加前缀。

修改后的代码如下：

public class CustomBeanNameGenerator extends AnnotationBeanNameGenerator {
    // 替换成你的Spring库的核心包路径
    private static final String LIBRARY_BASE_PACKAGE = "com.yourteam.yourlibrary";

    @Override
    public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
        String beanClassName = definition.getBeanClassName();
        // 判断当前Bean是否属于你的库的目标包
        if (beanClassName != null && beanClassName.startsWith(LIBRARY_BASE_PACKAGE)) {
            // 添加自定义前缀，替换成你想要的唯一标识
            return "LIB_PREFIX-" + super.generateBeanName(definition, registry);
        }
        // 非目标包的Bean保持默认命名规则
        return super.generateBeanName(definition, registry);
    }
}

这样就能精准给你库中指定包下的所有Bean自动加上前缀，完美避开客户端的Bean命名冲突。

二、Spring Boot测试项目中的配置方法 #

在你的2.3.1版本Spring Boot测试项目里，直接在启动类上指定这个生成器即可：

@SpringBootApplication(nameGenerator = CustomBeanNameGenerator.class)
public class TestLibraryApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestLibraryApplication.class, args);
    }
}

启动后，你可以通过ApplicationContext的getBeanDefinitionNames()方法验证Bean名称是否已添加前缀。

三、Spring库中的配置方式（关键！） #

因为你的库是给其他应用依赖的，不能依赖启动类配置，需要通过配置类让客户端应用自动识别：

步骤1：创建库的配置类，指定Bean名称生成器 #

写一个配置类，通过@ComponentScan指定你的库的包路径和自定义生成器：

@Configuration
@ComponentScan(
        basePackages = "com.yourteam.yourlibrary",
        nameGenerator = CustomBeanNameGenerator.class
)
public class LibraryBeanNamingAutoConfig {
    // 无需额外代码，核心是通过@ComponentScan绑定生成器和目标包
}

步骤2：让客户端应用自动加载该配置 #

有两种常用方式：

• 方式一（推荐Spring Boot客户端）：在你的库的src/main/resources/META-INF/spring目录下创建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，内容为配置类的全限定名：

  com.yourteam.yourlibrary.config.LibraryBeanNamingAutoConfig
  

  这样客户端应用只要依赖你的库，Spring Boot就会自动加载这个配置，无需客户端额外配置。
• 方式二（兼容所有Spring应用）：让客户端在自己的扫描配置中显式引入你的库配置类，比如：

  @SpringBootApplication(scanBasePackageClasses = {LibraryBeanNamingAutoConfig.class, ClientApplication.class})
  public class ClientApplication {
      public static void main(String[] args) {
          SpringApplication.run(ClientApplication.class, args);
      }
  }
  

补充：处理@Bean注解手动注册的Bean #

上面的生成器只处理@Component、@Service、@Repository等注解扫描的Bean。如果你的库中有通过@Bean手动注册的Bean，默认是用方法名作为Bean名称，需要手动添加前缀：

@Configuration
public class SomeLibraryBeanConfig {
    @Bean(name = "LIB_PREFIX-customManualBean")
    public CustomManualBean customManualBean() {
        return new CustomManualBean();
    }
}

如果想要批量处理，也可以通过BeanDefinitionRegistryPostProcessor实现，但手动指定名称更简单直接，也更清晰。

备注：内容来源于stack exchange，提问作者Sunil