当前位置：首页 > news >正文

Spring Boot 优雅配置yml配置文件定义集合、数组和Map

news 2025/8/18 3:14:36

一、@value 获取配置文件

在平时的yml配置文件中，我们经常使用到配置基本数据类型的字符串，比如配置日志文件的写法如下：

# 配置日志输出级别
logging:# 指定logback配置文件的位置 config: classpath:logback-spring.xml# 文件日志要输出的路径path: E:/logs/springboot_server# 日志的输出级别level:root: info

获取属性值的话可以通过@value 注解来实现，如下：

@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

首先创建一个user对象如下：

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

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

jwt:userlist:- appId: YiBaoTongpassword: 123456- appId: ZhiKepassword: 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;@Dataprivate static class UserTest {private String appId;private List<String> passwordList;}}

yml 文件配置

jwt:userList:- appId: '121212'passwordList: '活动时间流程节点-PromoTimeValidNode,活动时间流程节点-PromoTimeValidNode2'- appId: 'werw3313'passwordList: '活动时间流程节点-PromoTimeValidNode,活动时间流程节点-PromoTimeValidNode2'

四、数组获取配置文件

yaml 格式如下：

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

可以通过@value注解获取数组值，如下：

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

也可以通过创建配置类bean，使用@ConfigurationProperties注解获取，如下：

@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

通过创建配置类bean，使用@ConfigurationProperties注解获取map值，如下：

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