springboot yml配置文件定義list集合、數組和map以及使用中的錯誤

更新時間：2023年07月28日 09:14:11 作者：騎著蝸牛@you

這篇文章主要介紹了springboot yml配置文件定義list集合、數組和map以及使用中遇到的錯誤問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

1. 在平時的yml配置文件中

我們經常使用到配置基本數據類型的字符串，比如配置日志文件的寫法如下：

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

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

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

2. 下面說一下

如何在yml配置文件中定義list集合、對象集合、數組以及map集合等

2.1定義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;
}

如果使用@value注解會報錯；

2.2 定義對象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;
}

2.3 定義數組

格式如下：

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

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

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

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

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

2.4 定義map集合

如下：

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;
}