Spring Boot：如何避免配置文件中特定值按逗号拆分

问题背景 #

在Spring Boot应用的properties文件中有如下配置：

my.application.property=something, something else, yet another something, something,which,must,remain,whole,no,splitting,allowed

需要将该属性注入为字符串数组/列表，但要求最后一个值内部的逗号不被拆分，最终期望得到：

String[] myProps = {
  "something",
  "something else",
  "yet another something",
  "something,which,must,remain,whole,no,splitting,allowed"
};

已尝试以下方法但均无效：

• 使用反斜杠（\,）或双反斜杠（\\,）转义逗号
• 用双引号（""）、大括号（{}）或方括号（[]）包裹最后一个值
• 将最后一个值移至单独属性后引用，示例：

  other.prop="something,which,must,remain,whole,no,splitting,allowed"
  my.application.property=something, something else, yet another something, ${other.prop}
  

可行解决方案 #

方案1：通过SpEL结合split的limit参数直接注入 #

在@Value注解中使用SpEL调用String.split()方法，指定拆分的最大次数（即目标数组的长度），这样最后一个元素会完整保留所有内容：

@Value("#{'${my.application.property}'.split(', ', 4)}")
private String[] myProps;

这里的4是你期望的数组元素总数，split会仅拆分前3个, 分隔符，最后一部分不会被拆分。

方案2：自定义Converter实现智能拆分 #

如果不确定元素数量，但明确最后一个值需要保留内部逗号，可以自定义一个属性转换类：

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

@Component
public class LastElementPreservingConverter implements Converter<String, String[]> {
    @Override
    public String[] convert(String source) {
        int lastSplitPos = source.lastIndexOf(", ");
        if (lastSplitPos == -1) {
            return new String[]{source};
        }
        // 拆分前半部分，再拼接最后一个完整元素
        String[] firstSegments = source.substring(0, lastSplitPos).split(", ");
        String[] result = new String[firstSegments.length + 1];
        System.arraycopy(firstSegments, 0, result, 0, firstSegments.length);
        result[firstSegments.length] = source.substring(lastSplitPos + 2);
        return result;
    }
}

之后使用@ConfigurationProperties注入时，Spring会自动使用这个Converter处理属性：

@ConfigurationProperties(prefix = "my.application")
public class AppConfigProperties {
    private String[] property;

    // getter、setter方法
}

方案3：替换前序元素的分隔符（可选） #

如果可以修改原始配置的格式，将前三个元素的分隔符改为其他符号（比如分号），就可以直接指定@ConfigurationProperties的分隔符：

my.application.property=something; something else; yet another something; something,which,must,remain,whole,no,splitting,allowed

配置类中指定分隔符：

@ConfigurationProperties(prefix = "my.application", delimiter = ";")
public class AppConfigProperties {
    private String[] property;

    // getter、setter方法
}

此方案需要调整配置格式，仅适用于允许修改配置的场景。

内容的提问来源于stack exchange，提问作者Tomás Gray