我們在使用spring框架進行開發時,有時候需要在properties文件中配置集合內容并注入到代碼中使用。本篇文章的目的就是給出一種可行的方式。
1.注入
通常來說,我們都使用@Value注解來注入properties文件中的內容,注入集合類時,我們也使用@Value來注入。
properties文件中的內容如下:
1
2
3
|
my.set=foo,bar my.list=foo,bar my.map={ "foo" : "bar" } |
分別是我們要注入的Set,List,Map中的內容。
注入方式如下:
1
2
3
4
5
6
|
@Value ( "#{${my.map}}" ) private Map<String, String> map; @Value ( "#{'${my.set}'}" ) private Set<String> set; @Value ( "#{'${my.list}'}" ) private List<String> list; |
2.驗證
我們寫一個單測類來驗證上面的注入是否可行。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
@RunWith (SpringRunner. class ) @SpringBootTest (webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = PropertiesTest.ClassUsingProperties. class ) @TestPropertySource (locations = "classpath:test.properties" ) public class PropertiesTest { @Autowired private ClassUsingProperties classUsingProperties; @Test public void testInjectCollectionFieldsUsingPropertiesFile() { Map<String, String> map = classUsingProperties.getMap(); Set<String> set = classUsingProperties.getSet(); List<String> list = classUsingProperties.getList(); asserts(map, set, list); } private void asserts(Map<String, String> map, Set<String> set, List<String> list) { Assert.assertEquals(map.get( "foo" ), "bar" ); Assert.assertTrue(set.contains( "foo" )); Assert.assertTrue(set.contains( "bar" )); Assert.assertTrue(list.contains( "foo" )); Assert.assertTrue(list.contains( "bar" )); } @Data @Component public static class ClassUsingProperties { @Value ( "#{${my.map}}" ) private Map<String, String> map; @Value ( "#{'${my.set}'}" ) private Set<String> set; @Value ( "#{'${my.list}'}" ) private List<String> list; } } |
test.properties中的內容已經在上面給出,位置在test文件夾下的resources文件夾下面(maven項目的文件夾結構)。
3.原理
在我們使用的@Value注解中,每一個開頭都有個#,這其實就是說明我們使用了SpEL,如果直接使用SpEL,
就是下面的代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
ExpressionParser parser = new SpelExpressionParser(); Map<String, String> map = (Map<String, String>) parser .parseExpression({ 'foo' : 'bar' }") .getValue(Map. class ); Set<String> set = (Set<String>) parser .parseExpression( "'foo,bar'" ) .getValue(Set. class ); List<String> list = (List<String>) parser .parseExpression( "'foo,bar'" ) .getValue(List. class ); |
我們也使用單元測試來驗證:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@Test @SuppressWarnings ( "unchecked" ) public void testInitCollectionUsingSpEL() { ExpressionParser parser = new SpelExpressionParser(); Map<String, String> map = (Map<String, String>) parser .parseExpression( "{'foo':'bar'}" ) .getValue(Map. class ); Set<String> set = (Set<String>) parser .parseExpression( "'foo,bar'" ) .getValue(Set. class ); List<String> list = (List<String>) parser .parseExpression( "'foo,bar'" ) .getValue(List. class ); asserts(map, set, list); } |
asserts方法的代碼已經在驗證使用@Value注解方式的單元測試中給出。
4.總結
我們用@Value注解把properties文件中的內容注入了集合類,注解中以#開頭,其實就是使用了SpEL。
Spring-Boot的版本是2.2.1.RELEASE,之所以要說這個,是因為一開始使用1.x版本時無法注入Set和List。
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持服務器之家。
原文鏈接:https://blog.csdn.net/m0_38063172/article/details/108696361