Spring Cloud Data Flow自定义应用配置属性白名单显示问题

看起来你在配置Spring Cloud Data Flow（SCDF）自定义应用的属性白名单时踩了小坑，我来帮你梳理问题所在和解决步骤：

1. 先确认配置文件的位置 #

首先要保证你的spring-configuration-metadata-whitelist.properties放在了src/main/resources/META-INF目录下——这是Spring Boot和SCDF约定的固定位置，放错了的话SCDF根本读不到这个配置，自然不会生效。

2. 调整白名单配置的写法 #

你现在同时配置了configuration-properties.classes和configuration-properties.names，这会导致SCDF优先加载指定类的所有属性，而你单独指定的my.prop1和my.prop2反而被覆盖或未被正确识别。

如果你的需求是只让这两个必填属性显示在仪表盘里，直接删掉configuration-properties.classes这一行，只保留：

configuration-properties.names=my.prop1,my.prop2

这样SCDF就只会把这两个属性暴露给仪表盘。

3. 检查配置类的属性定义是否规范 #

这一步很关键，很多时候属性不显示是因为配置类写法不符合Spring Boot要求：

• 确保配置类上标注了@ConfigurationProperties(prefix = "my")（前缀要和你的属性名对应）
• 每个属性都要有对应的getter和setter方法（Spring Boot需要通过getter生成配置元数据）
• 给必填属性加上@NotNull或@NotBlank注解，这样SCDF仪表盘会标记它们为必填项

举个正确的配置类示例：

@ConfigurationProperties(prefix = "my")
public class MySourceProperties {
    @NotNull(message = "prop1是必填项")
    private String prop1;

    @NotBlank(message = "prop2不能为空")
    private String prop2;

    // 其他非必填属性可在这里定义，但因白名单未包含，仪表盘不会显示

    // 必须添加getter和setter
    public String getProp1() {
        return prop1;
    }

    public void setProp1(String prop1) {
        this.prop1 = prop1;
    }

    public String getProp2() {
        return prop2;
    }

    public void setProp2(String prop2) {
        this.prop2 = prop2;
    }
}

4. 可选：手动生成配置元数据文件 #

如果上面的步骤还没解决问题，可以手动创建META-INF/spring-configuration-metadata.json文件，明确告诉SCDF这两个属性的信息：

{
  "properties": [
    {
      "name": "my.prop1",
      "type": "java.lang.String",
      "description": "自定义源的必填属性1",
      "required": true
    },
    {
      "name": "my.prop2",
      "type": "java.lang.String",
      "description": "自定义源的必填属性2",
      "required": true
    }
  ]
}

这个文件会和白名单配置配合，让仪表盘更准确地识别并显示这两个必填属性。

5. 最后验证打包内容 #

打包应用后，打开jar包确认META-INF目录下的这两个文件都存在——有时候构建工具（比如Maven/Gradle）会不小心排除这些文件，导致配置不生效。

按照这些步骤调整后，重新部署你的自定义应用到SCDF，应该就能在创建流的属性对话框里看到这两个必填项了。

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