使用应用程序属性动态创建bean

Question

在我的默认SpringBoot应用程序中，它具有spring-boot-starter-执行器依赖项，调用/执行器/健康（带有show-细节：true）返回以下信息

{
  "status": "UP",
  "components": { ... },
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 2000396742656,
        "free": 581706977280,
        "threshold": 10485760,
        "exists": true
      }
    },
    "ping": { "status": "UP" }
  }
}

但是，我的机器上有两个驱动器，所以我想查看它们的磁盘空间详细信息。所以我添加了一个配置文件：

@Configuration
public class DiskSpaceConfig {
  @Bean
  public AbstractHealthIndicator driveC() {
    return new DiskSpaceHealthIndicator(new File("C:/"), DataSize.ofMegabytes(100));
  }

  @Bean
  public AbstractHealthIndicator driveD() {
    return new DiskSpaceHealthIndicator(new File("D:/"), DataSize.ofMegabytes(100));
  }
}

现在，我的健康endpoint返回以下数据

{
  "status": "UP",
  "components": { ... },
    "diskSpace": { "status": "UP", "details": { ... } },
    "driveC": { "status": "UP", "details": { ... } },
    "driveD": { "status": "UP", "details": { ... } },
    "ping": { "status": "UP" }
  }
}

（稍后我将考虑如何抑制默认的“diskSpace”条目）

然而，由于我可能想在不同的机器上运行我的应用程序，我想配置磁盘驱动器，以便在我的应用程序中进行动态检查。yml文件。

media:
  health:
    drives:
      - name: driveC
        path: "C:/"
      - name: driveD
        path: "D:/"

还加上

@Slf4j
@Component
@ConfigurationProperties(prefix = "media.health")
@Data
public class MediaHealthConfigLoader {
  private List<DriveConfig> drives;

  @PostConstruct
  public void postProcessBeanFactory() {
    log.info("Found {} configured drives", drives.size());
  }
}

@Data
public class DriveConfig {
  private String name;
  private String path;
}

@Configuration
@EnableConfigurationProperties
public class DiskSpaceConfig {
}

配置在启动期间加载并记录到控制台。

然而，我的问题是，如何动态创建这些bean并将它们添加到bean上下文中？我想我需要去豆工厂。我试过以下方法：

@Slf4j
@Configuration
@EnableConfigurationProperties
@RequiredArgsConstructor
public class DiskSpaceConfig {
  private final MediaHealthConfigLoader mediaHealthConfigLoader;
  private final BeanFactory beanFactory;

  @PostConstruct
  public void createDiskSpaceHealthIndicators() {
    ArrayList<AbstractHealthIndicator> beans = new ArrayList<>();
    if (mediaHealthConfigLoader.getDrives() != null) {
      log.info("Creating {} dynamic DiskSpaceHealthIndicators", mediaHealthConfigLoader.getDrives().size());
      mediaHealthConfigLoader.getDrives().forEach(drive -> {
        DiskSpaceHealthIndicator indicator = new DiskSpaceHealthIndicator(new File(drive.getPath()), DataSize.ofMegabytes(100));
        log.info("Created indicator with name={} for path={}: bean={}", drive.getName(), drive.getPath(), indicator);
        
        // -> I would like to do something like: beanFactory.addBean(drive.getName(), indicator)
      });
    }
  }
}

然而，我的beanFactory只有getter，因此无法添加新创建的bean。

我还尝试使用BeanFactoryPostProcessor连接到bean创建中，但是，在执行回调时，配置属性（或加载它们的类）似乎还没有准备好。

@Slf4j
@Component
@RequiredArgsConstructor
public class DynamicHealthIndicatorFactory implements BeanFactoryPostProcessor {
  private final MediaHealthConfigLoader mediaHealthConfigLoader;

  @Override
  public void postProcessBeanFactory(final ConfigurableListableBeanFactory beanFactory) throws BeansException {
    // mediaHealthConfigLoader is null here :-(

    mediaHealthConfigLoader.getDrives().forEach(drive -> {
        DiskSpaceHealthIndicator newBean = new DiskSpaceHealthIndicator(new File(drive.getPath()), DataSize.ofMegabytes(100));
        beanFactory.initializeBean(newBean, drive.getName());
        beanFactory.registerSingleton(drive.getName(), newBean);
    });
  }
}

或者

@Slf4j
@Component
@ConfigurationProperties(prefix = "media.health") // commenting out the same annotation on MediaHealthConfigLoader
public class DynamicHealthIndicatorFactory implements BeanFactoryPostProcessor {
  private List<DriveConfig> drives;

  @Override
  public void postProcessBeanFactory(final ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
    // drives is null here :-(
    drives.forEach(drive -> {
        DiskSpaceHealthIndicator newBean = new DiskSpaceHealthIndicator(new File(drive.getPath()), DataSize.ofMegabytes(100));
        beanFactory.initializeBean(newBean, drive.getName());
        beanFactory.registerSingleton(drive.getName(), newBean);
    });
  }
}

但是，这两种方法都会导致NullPointerExceptions，因为在生命周期的这个点上，属性和自动构建的bean都准备好了。

我肯定我不是第一个尝试这样做的人，但我似乎没有找到正确的搜索词来找到解决方案。

Answer 1

这应该适用于ref:gist应用程序

@Configuration
@EnableConfigurationProperties
@AllArgsConstructor
class DiskSpaceConfig {
    private final MediaHealthConfigLoader mediaHealthConfigLoader;
    private final ConfigurableListableBeanFactory beanFactory;

    @PostConstruct
    public void registerBeans(){
        mediaHealthConfigLoader.getDrives().forEach(drive -> {
            DiskSpaceHealthIndicator newBean = new DiskSpaceHealthIndicator(new File(drive.getPath()), DataSize.ofMegabytes(100));
            beanFactory.initializeBean(newBean, drive.getName());
            beanFactory.registerSingleton(drive.getName(), newBean);
        });
    }
}

如果需要，可以禁用默认磁盘空间

management:
  health:
    diskspace:
      enabled: false