Springboot读取properties配置文件的List、Map格式的配置项(属性)

最近收到有小伙伴咨询Springboot项目怎样读取application.properties文件的List、Map等复杂对象格式属性，笔者针对这个问题，写了个demo来演示，希望对需要的小伙伴有帮助。

首先，不管是什么框架的java项目，读取properties文件属性，实际就相当于把properties文件当做Map对象读取其中属性而已，明白了这个道理后，那么在此通过下面demo来作为演示实现过程。

一、properties文件里构造数据

这里构造1个员工对象格式的结构化数据，员工对象里有id(主键),name(姓名),no(编号)等普通字符串类型的属性，员工还可以有多个角色，也就是List格式的role属性，再构造1个部门属性dept，部门属性下面又有deptCode(部门编码)，deptName(部门名称)和org(业务组织)属性，业务组织属性下面又有List对象属性。这整体上是一个嵌套比较复杂的格式了，虽然文字描述可能有点苍白，下面用代码最能描述这种数据格式。

1.员工信息类

因为是读取properties配置文件属性，所以此处起名寓意配置类，当然名字无所谓

@Data
@Component
@PropertySource("classpath:test.properties")
@ConfigurationProperties(prefix = "employee")
public class UserConfig implements Serializable{

    /**
	 * 
	 */
	private static final long serialVersionUID = 7519565773190844250L;

	private String id;
	
	private String no;
	
	private String name;
	
	private Dept dept;
	
	private List role = new ArrayList<>();
}

2.员工角色类

定义角色的最基本的2个属性：角色编码和角色名称

@Data
public class Role implements Serializable{

	/**
	 * 
	 */
	private static final long serialVersionUID = 7501454692763596524L;
	
	public String roleCode;
	public String roleName;
}

3.员工部门类

部门有最基本的部门编码和部门名称属性，再构造个业务组织属性org，员工可以归属于多个业务组织，故用List对象属性

@Data
public class Dept implements Serializable{
	/**
	 * 
	 */
	private static final long serialVersionUID = 7793669734278774263L;
	
	private String deptCode;
	
	private String deptName;
	
	private List org;
}

4.业务组织类

对于组织结构比较复杂的并且有地域属性的集团公司会按照城市有业务组织属性

@Data
public class Org implements Serializable{
	/**
	 * 
	 */
	private static final long serialVersionUID = 4764818569094789258L;
	
	private String businessOrgId;
	private String businessPosId;
	private String businessCityId;
}

5.properties配置文件

配置文件里的配置项分别对应于上面的员工对象的各个属性以及子集属性，可以看出id，no，name是员工的常规属性，role是List类型的对象集合，org是部门dept属性下的List类型的对象集合。

employee.id="1001"
employee.no="111"
employee.name="zhangsan"
employee.role[0].roleCode="CXSZY"
employee.role[0].roleName="admin1"

employee.role[1].roleCode="CXSJL"
employee.role[1].roleName="admin2"

employee.dept.deptCode="101"
employee.dept.deptName="XiaoShouBu"
employee.dept.org[0].businessOrgId="CSJL001"
employee.dept.org[0].businessPosId="001"
employee.dept.org[0].businessCityId="400002"

6.读取配置文件

写个controller，注入上面第1步定义的配置类UserConfig，定义1个测试方法test（注意配置类上面的各个注解，此处不再赘述）在postman上运行这个接口方法，在代码里打断点以及日志如下截图，可以看到，properties配置文件里的List对象格式的配置项都正常读取到Java代码 了。

这个案例就演示到这里，需要的小伙伴快去试试吧