Springboot加载自定义yaml文件及复杂类型List/Map使用

springboot的版本：v2.2.1.RELEASE

因为springboot在项目启动的时候是不会自动将自定义（名字不是application*.yml）的配置文件加载到spring容器的，而使用@PropertySource(value = "classpath:test.yml")这样的方式是不能加载.yml文件的。所以我们需要使用另外的方式。

1.将yaml文件加载到spring容器

在springboot启动类（Application.java）中将自定义的yaml文件加载到spring容器

package com.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


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

    @Bean
    public static PropertySourcesPlaceholderConfigurer properties() {
        PropertySourcesPlaceholderConfigurer configurer = new         
        PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
	    yaml.setResources(new ClassPathResource("test1.yml"),new ClassPathResource("test2.yml"));
        configurer.setProperties(yaml.getObject());
        return configurer;
    }
}

这样就将自定义的test1.yml和test2.yml加载到了spring容器中。

2.yaml文件实例

具体的yaml文件的用法请参考：YAML 语言教程 - 阮一峰的网络日志

test1.yml

#test1 config
test1:
  test1List:
    - testId: admin
      testName: admin
    - testId: User
      testName: User

test2.yml

#test2 config
test2:
  test2List:
    - testId: User
      apis:
        api1: [get,post]
    - testId: admin
      apis:
        api1: [get,post]
        api2: [get,post]
        api3: [get,put]

3.将yml文件的内容注入到实体Bean

在定义了yaml文件后，我们需要定义与之数据结构相对应的实体bean（实在不知道可以先定义为Object然后调试看映射的数据皆结构，前提是定义的yaml文件的结构是正确的）。

将test1.yml注入到Test1Bean中

package com.springboot.common.beans;

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

import java.util.List;

@Data
@Component
@ConfigurationProperties(prefix = "test1") //指定首节点的名字然后自动匹配注入
public class Test1Bean {
    //test1.yml中test1为第一层节点下面是test1List
    private List<Test1IdBean> test1List;
}

Test1IdBean结构

package com.springboot.common.beans;

import lombok.Data;

@Data
public class Test1IdBean {
    private String testId;

    private String testName;
}

将test2.yml注入到Test2Bean中

package com.springboot.common.beans;

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

import java.util.List;

@Data
@Component
@ConfigurationProperties(prefix = "test2")
public class Test2Bean {
    private List<Test2ApiBean> test2List;
}

Test2ApiBean结构

package com.springboot.common.beans;

import lombok.Data;

import java.util.List;
import java.util.Map;

@Data
public class Test2ApiBean {
    private String testId;
    private Map<String, List<String>> apis;
}

至此已经大功告成，在springboot项目启动的收就会成功的将我们自定义yaml文件加载到spring容器，并自动注入我们定义的实体Bean中去。

4.使用

@Log4j2
@Component
public class SchemaYmlTest {
    @Autowired
    private Test1Bean test1Bean;

    @Autowired
    private Test2Bean test2Bean;

    public void testYml() {
        test1Bean.getTest1List().forEach(a -> System.out.println(a));

        test2Bean.getTest2List().forEach(a -> {System.out.printLn(a.getTestId)})
    }
}