Java 读取树状结构的.yaml文件

1. 编写yaml配置文件

以省市乡三级结构为例，配置文件如下：

administrative:
  divisions:
    - code: BJ
      name: 北京
      children:
        - code: BJ01
          name: 东城区
          children:
            - code: BJ0101
              name: 东华门街道
            - code: BJ0102
              name: 交道口街道
            - code: BJ0103
              name: 和平里街道
        - code: BJ02
          name: 西城区
          children:
            - code: BJ0201
              name: 西长安街街道
            - code: BJ0202
              name: 新街口街道
            - code: BJ0203
              name: 月坛街道
    - code: SH
      name: 上海
      children:
        - code: SH01
          name: 黄浦区
          children:
            - code: SH0101
              name: 南京东路街道
            - code: SH0102
              name: 外滩街道
            - code: SH0103
              name: 半淞园路街道
        - code: SH02
          name: 徐汇区
          children:
            - code: SH0201
              name: 天平路街道
            - code: SH0202
              name: 徐家汇街道
            - code: SH0203
              name: 斜土街道

2. 创建实体类

import lombok.Data;
import com.sun.istack.internal.NotNull;
import org.springframework.validation.annotation.Validated;

import java.util.List;

@Validated
@Data
public class AdministrativeDivision {
    private final String code;
    private final String name;
    private final List<AdministrativeDivision> children;

    public AdministrativeDivision(@NotNull String code, @NotNull String name, List<AdministrativeDivision> children) {
        this.code = code;
        this.name = name;
        this.children = children;
    }
}

3. 创建配置类读取配置文件

import com.zjp.demo.pojo.AdministrativeDivision;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;

import java.util.List;

@ConfigurationProperties(prefix = "administrative")
@ConstructorBinding
public class AdministrativeDivisionsConfig {
    private final List<AdministrativeDivision> divisions;

    public AdministrativeDivisionsConfig(List<AdministrativeDivision> divisions) {
        this.divisions = divisions;
    }

    public List<AdministrativeDivision> getDivisions() {
        return divisions;
    }
}

4. 在启动类加 @EnableConfigurationProperties 注解

@SpringBootApplication
@EnableConfigurationProperties(AdministrativeDivisionsConfig.class)
public class DemoApplication {

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

5. 测试

import com.zjp.demo.config.AdministrativeDivisionsConfig;
import com.zjp.demo.pojo.AdministrativeDivision;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@Slf4j
@SpringBootTest
class AaDemoApplicationTests {
    @Autowired
    AdministrativeDivisionsConfig administrativeDivisionsConfig;

    @Test
    public void test1() {
        List<AdministrativeDivision> divisions = administrativeDivisionsConfig.getDivisions();
        System.out.println(divisions);
    }
}

输出结果为：

[AdministrativeDivision(code=BJ, name=北京, children=[AdministrativeDivision(code=BJ01, name=东城区, children=[AdministrativeDivision(code=BJ0101, name=东华门街道, children=null), AdministrativeDivision(code=BJ0102, name=交道口街道, children=null), AdministrativeDivision(code=BJ0103, name=和平里街道, children=null)]), AdministrativeDivision(code=BJ02, name=西城区, children=[AdministrativeDivision(code=BJ0201, name=西长安街街道, children=null), AdministrativeDivision(code=BJ0202, name=新街口街道, children=null), AdministrativeDivision(code=BJ0203, name=月坛街道, children=null)])]), AdministrativeDivision(code=SH, name=上海, children=[AdministrativeDivision(code=SH01, name=黄浦区, children=[AdministrativeDivision(code=SH0101, name=南京东路街道, children=null), AdministrativeDivision(code=SH0102, name=外滩街道, children=null), AdministrativeDivision(code=SH0103, name=半淞园路街道, children=null)]), AdministrativeDivision(code=SH02, name=徐汇区, children=[AdministrativeDivision(code=SH0201, name=天平路街道, children=null), AdministrativeDivision(code=SH0202, name=徐家汇街道, children=null), AdministrativeDivision(code=SH0203, name=斜土街道, children=null)])])]