Spring?Boot如何配置yml配置文件定義集合、數(shù)組和Map

更新時間：2023年10月28日 14:32:41 作者：給自己一個?smile

這篇文章主要介紹了Spring?Boot?優(yōu)雅配置yml配置文件定義集合、數(shù)組和Map,包括Spring?Boot?yml配置文件定義基本數(shù)據(jù)類型和引用數(shù)據(jù)類型的方式，需要的朋友可以參考下

一、@value 獲取配置文件

在平時的yml配置文件中，我們經(jīng)常使用到配置基本數(shù)據(jù)類型的字符串，比如配置日志文件的寫法如下：

# 配置日志輸出級別
logging:
  # 指定logback配置文件的位置 
  config: classpath:logback-spring.xml
  # 文件日志要輸出的路徑
  path: E:/logs/springboot_server
  # 日志的輸出級別
  level:
    root: info

獲取屬性值的話可以通過@value 注解來實現(xiàn)，如下：

@Value("${logging.path}")
private String path;    // 獲取日志文件的輸出路徑

二、 List集合獲取配置文件

第一種方法

# 攔截器路徑攔截或者不攔截配置
interceptorconfig:
  path:
    #該路徑下任何類型請求均攔截
    include:
      - /api/v1/token/api_token
      - /api/v1/yibaotong/save

第二種方法

# 攔截器路徑攔截或者不攔截配置
interceptorconfig:
  path:
    #該路徑下任何類型請求均攔截
    include: [/api/v1/token/api_token,/api/v1/yibaotong/save]

總結

這里需要注意的是，定義List集合不能用@value 注解來獲取List集合的所有值，需要定義一個配置類bean，然后使用 @ConfigurationProperties 注解來獲取list集合值，做法如下：

@Data
@Component
@ConfigurationProperties(prefix = "interceptorconfig.path") // 配置文件的前綴
public class InterceptorPathBean
{
    /*
     * 需要攔截的路徑
     */
    private List<String> include;
}

三、定義對象list集合獲取配置文件

單個對象List

首先創(chuàng)建一個user對象如下：

@Data
public class User implements Serializable
{  
    private static final long serialVersionUID = 1L;
    private String appId;
    private String password;
}

然后yml配置文件的寫法如下：

jwt:
  userlist:
    - appId: YiBaoTong
      password: 123456
    - appId: ZhiKe
      password: 123456

定義配置bean使用@ConfigurationProperties注解獲取對象集合值：

@Data
@Component
@ConfigurationProperties(prefix = "jwt") // 配置 文件的前綴
public class JwtConfigBean
{
    /**
     * 用戶列表
     */
    private List<User> userlist;
}

List對象中包含List

定義配置bean使用@ConfigurationProperties注解獲取對象集合值：

@Data
@Component
@ConfigurationProperties(prefix = "jwt") // 配置 文件的前綴
public class JwtConfigBean {
    /**
     * 用戶列表
     */
    private List<UserTest> userList;
    @Data
    private static class UserTest {
        private String appId;
        private List<String> passwordList;
    }
}

yml 文件配置

jwt:
  userList:
    - appId: '121212'
      passwordList: '活動時間流程節(jié)點-PromoTimeValidNode,活動時間流程節(jié)點-PromoTimeValidNode2'
    - appId: 'werw3313'
      passwordList: '活動時間流程節(jié)點-PromoTimeValidNode,活動時間流程節(jié)點-PromoTimeValidNode2'

四、數(shù)組獲取配置文件

yaml 格式如下：

interceptorconfig:
  path:
    includes: /api/v1,/api/v2  #注意要用逗號分隔開

可以通過@value注解獲取數(shù)組值，如下：

@Value("${interceptorconfig.path.includes}")
private String[] includes;

也可以通過創(chuàng)建配置類bean，使用@ConfigurationProperties注解獲取，如下：

@Data
@Component
@ConfigurationProperties(prefix = "interceptorconfig.path") // 配置 文件的前綴
public class InterceptorPathBean
{  
    private String[] includes;
}
@Data
@Component
@ConfigurationProperties(prefix = "interceptorconfig.path") // 配置 文件的前綴
public class InterceptorPathBean
{  
    private String[] includes;
}

五、定義Map集合配置文件

yaml 格式如下：

interceptorconfig:
  path:
    maps: {name: 小明,age: 24}

或者寫成：

interceptorconfig:
  path:
    maps:
      name: 小明
      age: 24

通過創(chuàng)建配置類bean，使用@ConfigurationProperties注解獲取map值，如下：

@Data
@Component
@ConfigurationProperties(prefix = "interceptorconfig.path") // 配置 文件的前綴
public class InterceptorPathBean
{
    private Map<String , String> maps;
}

以上就是Spring Boot yml配置文件定義基本數(shù)據(jù)類型和引用數(shù)據(jù)類型的方式；