【Spring Boot】5. @ConfigurationProperties(prefix=xx) 单元测试注入

谁借莪１个温暖的怀抱￠ 2021-09-21 10:46 460阅读 0赞

> springboot单元测试中，@ConfigurationProperties(prefix=“xx”) 注入

今天在对写单元测试时，发现用@ConfigurationProperties(prefix=“xx”) 注入配置的类，无法获取到配置的内容，简单模拟一下：

首先是配置类，通过@ConfigurationProperties注入配置，生成两个Bean，用于标识不同的信息模块。

@Configuration
    public class MsgTemplateConfig { 
    
        @Bean(name = "DAILY")
        @ConfigurationProperties(prefix = "alarm.message.daily")
        MsgTemplate dailyMsgTemplate() { 
            return new MsgTemplate();
        }
    
        @Bean(name = "ERROR")
        @ConfigurationProperties(prefix = "alarm.message.error")
        MsgTemplate errorMsgTemplate() { 
            return new MsgTemplate();
        }
    }
    
    public class MsgTemplate { 
    
        public MsgTemplate() { 
        }
    
        private String content;
        private String title;
    
        // 忽略 get/set 方法
    }

业务逻辑类，根据输入的Key，选择不同的Bean进行处理，这里注意：`对于@Autowired 标注作用于 Map 类型时，如果 Map 的 key 是 String 类型，则 Spring 会将容器中所有符合 Map 的 value 对应的类型的 Bean 增加进 Map 中，用 Bean 的 id 或 name 作为 Map 的 key`。

@Component
    public class MsgHandler { 
    
        // 因此这里会注入两个 Bean
        // 1. key = DAILY, Bean = dailyMsgTemplate
        // 2. key = ERROR, Bean = errorMsgTemplate
        private Map<String, MsgTemplate> msgTemplateMap;
    
        @Autowired
        public MsgHandler(Map<String, MsgTemplate> msgTemplateMap) { 
            this.msgTemplateMap = msgTemplateMap;
        }
    
        public String handler(String key) { 
            MsgTemplate msgTemplate = msgTemplateMap.get(key);
            return msgTemplate.getContent();
        }
    
    }

然而，我在进行单元测试时，却报错，单元测试代码：

@RunWith(SpringRunner.class)
    @SpringBootTest(classes = { MsgHandler.class, MsgTemplateConfig.class})
    public class MsgHandlerTest { 
    
        @Autowired
        private MsgHandler msgHandler;
    
        @Test
        public void testHandler() { 
            assertEquals("daily_content", msgHandler.handler("DAILY"));
        }
    }

报错：

![在这里插入图片描述][20200910205456452.png_pic_center]

打了个断点，发现map里面有Bean注入，但是都是为null：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FwcGx5aW5n_size_16_color_FFFFFF_t_70_pic_center]

一开始是以为测试的配置文件中没有，但后面发现测试配置文件中都有对应的配置项：

alarm.message.daily.content=daily_content
    alarm.message.error.content=error_content
    
    alarm.message.daily.title=daily_title
    alarm.message.error.title=error_title

然后突然想到了`@Value`标签注入的类，在单元测试中，都能拿到相应的值，因此打了断点进行验证，发现，对于`@Value` 注入的值，在构造函数时，已经进行了赋值操作，而对于由 `@ConfigurationProperties(prefix="x")` 这种方法进行赋值的，在构造函数时，为空值，是在构建之后，再通过`setXxx()` 的方法对Bean的值进行修改，因此考虑是不是单元测试模拟时，没有根据配置文件进行了赋值操作，所以尝试加上 `@EnableAutoConfiguration` 注解， 加上之后，发现测试可以通过：

@RunWith(SpringRunner.class)
    @SpringBootTest(classes = { MsgHandler.class, MsgTemplateConfig.class})
    @EnableAutoConfiguration
    public class MsgHandlerTest { 
    
        @Autowired
        private MsgHandler msgHandler;
    
        @Test
        public void testHandler() { 
            assertEquals("daily_content", msgHandler.handler("DAILY"));
        }
    }

测试结果：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FwcGx5aW5n_size_16_color_FFFFFF_t_70_pic_center 1]

但是对于其中的原理暂时不知，先做记录，后续找时间阅读源码找寻答案。

[20200910205456452.png_pic_center]: /images/20210920/b3d1487a09f74ba7bb0eb2076536f46a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FwcGx5aW5n_size_16_color_FFFFFF_t_70_pic_center]: /images/20210920/d6d9b58ad6724901a33137bb0b02a841.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FwcGx5aW5n_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20210920/0cd9eda1960541c68df97c92e18dbb6d.png