springboot自定义配置文件 yml格式

最新推荐文章于 2025-12-30 19:24:56 发布

原创最新推荐文章于 2025-12-30 19:24:56 发布 · 313 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

spring 专栏收录该内容

14 篇文章

订阅专栏

本文介绍了如何在Spring Boot中实现自定义YAML配置加载，并通过继承`DefaultPropertySourceFactory`创建`YmlPropertyLoaderFactory`，然后使用`@ConfigurationProperties`注解将配置映射到实体类`CorsProperties`，实现配置的自动注入。配置文件包含跨域设置如允许的源、方法、头等。

第一步

继承DefaultPropertySourceFactory 重写createPropertySource方法

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.core.io.support.EncodedResource;

import java.io.IOException;
import java.util.List;

public class YmlPropertyLoaderFactory extends DefaultPropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        if (resource == null) {
            return super.createPropertySource(name, resource);
        }
        List<PropertySource<?>> sources = new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource());
        if (sources.size() == 0) {
            return super.createPropertySource(name, resource);
        }
        return sources.get(0);
    }
}

第二步

获取自定义配置实体类

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 * @author Zhm
 * @date 2022/5/31 11:03
 **/
@Data
@Component
@PropertySource(value = {"classpath:config.yml"}, factory = YmlPropertyLoaderFactory.class, ignoreResourceNotFound = true)
@ConfigurationProperties(prefix ="ly.cors")
public class CorsProperties {
    private List<String> allowedOrigins;
    private Boolean allowedCredentials;
    private List<String> allowedMethods;
    private List<String> allowedHeaders;
    private Long maxAge;
    private String filterPath;
}

第三步

新建yml配置文件

ly:
  cors:
    allowedCredentials: true
    allowedHeaders:
      - '*'
    allowedMethods:
      - GET
      - POST
      - DELETE
      - PUT
      - OPTIONS
      - HEAD
    allowedOrigins:
      - http://xxx.xxx.xxx
    filterPath: /**
    maxAge: 3600