Spring Boot 2.3.x：如何将文件字符串列表转为配置属性

针对你遇到的问题，这里提供两种更简洁、解耦的实现方案，避免硬编码文件路径，完全通过配置驱动：

方案一：自定义PropertyEditor实现@Value直接注入 #

通过扩展Spring的PropertyEditor，让@Value支持将资源路径直接转换为List<String>：

1. 实现自定义PropertyEditor

public class ResourceToListPropertyEditor extends PropertyEditorSupport {
    private final ResourceLoader resourceLoader;

    public ResourceToListPropertyEditor(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @Override
    public void setAsText(String resourcePath) throws IllegalArgumentException {
        try {
            Resource resource = resourceLoader.getResource(resourcePath);
            // 按行读取文件内容并转为List
            List<String> lines = Files.readAllLines(resource.getFile().toPath());
            setValue(lines);
        } catch (IOException e) {
            throw new IllegalArgumentException("读取资源文件失败: " + resourcePath, e);
        }
    }
}

2. 注册PropertyEditor到Spring容器

@Configuration
public class PropertyEditorConfig {
    @Bean
    public CustomEditorConfigurer customEditorConfigurer(ResourceLoader resourceLoader) {
        CustomEditorConfigurer configurer = new CustomEditorConfigurer();
        Map<Class<?>, Class<? extends PropertyEditor>> editorMap = new HashMap<>();
        // 绑定List类型到自定义编辑器
        editorMap.put(List.class, ResourceToListPropertyEditor.class);
        configurer.setCustomEditors(editorMap);
        return configurer;
    }
}

3. 直接通过@Value注入

@Value("${app.list}")
private List<String> myList;

方案二：@ConfigurationProperties结合Converter #

利用Spring Boot的配置绑定机制，配合自定义Converter，实现配置属性到列表的自动转换：

1. 实现资源路径转List的Converter

@Component
public class ResourcePathToListConverter implements Converter<String, List<String>> {
    private final ResourceLoader resourceLoader;

    public ResourcePathToListConverter(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @Override
    public List<String> convert(String resourcePath) {
        try {
            Resource resource = resourceLoader.getResource(resourcePath);
            return Files.readAllLines(resource.getFile().toPath());
        } catch (IOException e) {
            throw new IllegalArgumentException("无法读取指定资源: " + resourcePath, e);
        }
    }
}

2. 创建配置属性类

@ConfigurationProperties(prefix = "app")
@Data // 需引入lombok，或手动生成getter/setter
public class AppProperties {
    private List<String> list;
}

3. 启用配置属性并注入使用
   在启动类或配置类上添加注解启用：

@SpringBootApplication
@EnableConfigurationProperties(AppProperties.class)
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

注入配置类后直接使用：

@Autowired
private AppProperties appProperties;

// 使用示例
public void doSomething() {
    List<String> list = appProperties.getList();
    // ...
}

方案优势 #

• 完全解耦：文件路径由application.yaml的app.list配置指定，代码无需硬编码
• 符合Spring生态：利用Spring内置的扩展机制，代码风格统一，易维护
• 灵活性高：支持classpath:、file:等Spring标准资源路径格式

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