如何为同类型Spring Bean动态提供不同.properties配置文件？

上下文信息 #

相关类代码 #

AnimalShelterConfiguration 类

@Configuration
public class AnimalShelterConfiguration {

    @Bean
    public List<Animal> animals(@Value("#{'${animals}'.split(',')}") List<String> animals) {
        return animals.stream()
                .map(animal -> animal())
                .collect(Collectors.toList());
    }

    @Bean
    public Animal animal() {
        return new Animal();
    }

}

Animal 类

public class Animal {

    @Value("${name}")
    private String name;

}

资源结构 #

+ src/main/resources
   + animal.properties
   + animals/
      + dog.animal.properties
      + cat.animal.properties

配置文件内容

• animal.properties：

animals=dog,cat

• dog.animal.properties：

name=dog

• cat.animal.properties：

name=cat

需求 #

• 根据animal.properties中定义的动物数量创建对应数量的Animal Bean，每个值关联animals/目录下对应的配置文件
• 每个Animal Bean需加载并注入对应专属.properties文件中的配置，使得@Value("${name}")能解析为对应的值（如dog和cat）
• 可新增任意数量ANIMAL.animal.properties文件，且每个文件内的属性名一致

问题 #

能否在Spring Boot中以少量配置实现该需求？已知ConfigurationProperties和PropertySource需静态值，不符合需求。能否通过Spring上下文注册Bean时，扫描*.animal.properties并为每个Bean提供不同的PropertySourcePlaceholderConfigurer实现？

解决方案 #

可以实现，不需要为每个Bean单独创建PropertySourcePlaceholderConfigurer（该类是全局生效的，重复创建会导致属性解析冲突）。推荐通过动态注册Bean并手动绑定属性的方式实现，步骤如下：

1. 修改配置类，实现动态Bean注册 #

创建（或修改）AnimalShelterConfiguration，实现BeanDefinitionRegistryPostProcessor和EnvironmentAware接口，完成动态扫描配置文件、注册Animal Bean的逻辑：

@Configuration
@PropertySource("classpath:animal.properties")
public class AnimalShelterConfiguration implements BeanDefinitionRegistryPostProcessor, EnvironmentAware {

    private Environment environment;

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // 读取animal.properties中配置的动物列表
        String animalsConfig = environment.getProperty("animals");
        if (animalsConfig == null) return;
        List<String> targetAnimals = Arrays.asList(animalsConfig.split(","));

        // 扫描animals目录下的所有*.animal.properties文件
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        try {
            Resource[] resources = resolver.getResources("classpath:animals/*.animal.properties");
            for (Resource resource : resources) {
                // 提取动物名称（如dog.animal.properties -> dog）
                String filename = resource.getFilename();
                String animalName = filename.substring(0, filename.indexOf(".animal.properties"));
                // 只处理animal.properties中指定的动物
                if (!targetAnimals.contains(animalName)) continue;

                // 加载当前动物的配置文件
                Properties props = new Properties();
                props.load(resource.getInputStream());

                // 创建Animal的Bean定义，并手动设置name属性
                GenericBeanDefinition animalBeanDef = new GenericBeanDefinition();
                animalBeanDef.setBeanClass(Animal.class);
                animalBeanDef.getPropertyValues().add("name", props.getProperty("name"));

                // 注册Bean，名称为「动物名+Animal」
                registry.registerBeanDefinition(animalName + "Animal", animalBeanDef);
            }

            // 注册包含所有Animal Bean的List<Animal> Bean
            GenericBeanDefinition listBeanDef = new GenericBeanDefinition();
            listBeanDef.setBeanClass(ArrayList.class);
            listBeanDef.setInstanceSupplier(() -> {
                List<Animal> animalList = new ArrayList<>();
                for (String animalName : targetAnimals) {
                    animalList.add((Animal) registry.getBean(animalName + "Animal"));
                }
                return animalList;
            });
            registry.registerBeanDefinition("animals", listBeanDef);

        } catch (IOException e) {
            throw new RuntimeException("加载动物配置文件失败", e);
        }
    }

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 无需额外处理
    }
}

2. 修改Animal类，添加属性setter #

因为要手动注入属性，需要给name字段添加setter方法：

public class Animal {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

方案优势 #

• 自动扫描animals/目录下的配置文件，仅处理animal.properties中指定的动物
• 每个Animal Bean的属性独立，不会出现配置覆盖问题
• 新增动物配置文件时，只需在animal.properties的animals列表中添加对应名称即可，无需修改代码

内容的提问来源于stack exchange，提问作者zlekonis