根据配置文件 ConfigurationProperties读取List、Map、Object、List Object 参数

前言

在实际工程中，经常遇到有大段的硬编码数据，这些数据一般需要保存为List数组或者Map格式，但当这类型的硬编码数据达到一定量以后，就不适合放在代码文件中，而应该通过外部配置文件读取；
这方面SpringBoot也提供了相关的支持，这边我主要总结了导入List或Map类型数据的使用方式及注意事项。

List类型数据

application.properties 中数据示例

custom.config.config1.folders[0]=/root
custom.config.config1.folders[1]=/home/user1
custom.config.config1.folders[2]=/home/user2

注意事项

对于List类型的数据需注意元素下标顺序。

Properties类基于注解读取示例

@ConfigurationProperties(prefix = "custom.config.config1")
public class Config1Properties{
	private List<String> folders;
	...
	public void set (List<String> folders){
	   this.folders = folders; 
	}
}

注意事项

需注意前缀配置与变量名称与配置文件中的命名一致，
此外还需要注意生成该变量的get,set方法，尤其是其set方法是spring框架注入变量值的入口，必须保证其正确性；
此处之前还遇到一个问题，由于编辑器自动生成的set方法有static修饰符，导致注入失败。
这些问题对于后面的数据引入方式也有同样要求。

Map类型数据

application.properties数据实例

custom.config.config1.map.key1=value1
custom.config.config1.map.key2=value2
custom.config.config1.map.key3=value3
custom.config.config1.map.key4=value4
custom.config.config1.map.key5=value5
注：此处也可以采用custom.config.config1.map[key5]=value5的方式

Properties类实例

@ConfigurationProperties(prefix = "custom.config.config1")
public class Config1Properties{
	private Map<String, String> map;
	...
}

注意事项

同上。

Object类型数据

application.properties示例

custom.config.config1.server.host=host1
custom.config.config1.server.port=22
custom.config.config1.server.username=username1
custom.config.config1.server.password=password1

Properties类实例

@ConfigurationProperties(prefix = "custom.config.config1")
public class Config1Properties{
	private ServerProperties server;
	...
	public static class ServerProperties {
		private String host;
		private int port;
		private String username;
		private String password;
		...
	}
}

注意事项

同上。

Object List

application.properties

custom.config.config1.servers[0].host=host1
custom.config.config1.servers[0].port=22
custom.config.config1.servers[0].username=username1
custom.config.config1.servers[0].password=password1
custom.config.config1.servers[1].host=host2
custom.config.config1.servers[1].port=22
custom.config.config1.servers[1].username=username2
custom.config.config1.servers[1].password=password2

Properties类

@ConfigurationProperties(prefix = "custom.config.config1")
public class Config1Properties{
	private List<ServerProperties> servers;
	...
	public static class ServerProperties {
		private String host;
		private int port;
		private String username;
		private String password;
		...
	}
}

注意事项

同上。