Spring Boot测试：如何将application.yml参数注入Mock ServletContext

我刚好遇到过一模一样的场景！SpringRunner测试时用的Mock ServletContext是个模拟实现，默认不会自动读取application.yml里的上下文参数，而嵌入式Tomcat会处理这些参数，所以才会出现测试和运行时的差异。下面给你几种优雅的解决方式：

方法一：自定义ServletContextInitializer加载参数 #

这种方法适合所有用@SpringBootTest的测试场景，核心是通过初始化器把application.yml里的参数手动设置到Mock ServletContext中。

步骤1：创建自定义初始化器 #

这个类会从Spring环境中读取参数，然后设置到ServletContext里：

import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.env.Environment;
import org.springframework.web.context.ServletContextInitializer;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

public class ConfigurableServletContextInitializer implements ServletContextInitializer, ApplicationContextAware {

    private Environment environment;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) {
        this.environment = applicationContext.getEnvironment();
    }

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // 替换成你需要从application.yml读取的参数key
        String thirdPartyParam = environment.getProperty("third-party.config.key");
        servletContext.setInitParameter("third-party.config.key", thirdPartyParam);
        
        // 如果有多个参数，直接重复setInitParameter即可
        // servletContext.setInitParameter("another.param", environment.getProperty("another.param"));
    }
}

步骤2：在测试类中引入初始化器 #

在你的测试类上添加@ContextConfiguration注解指定初始化器，这样Spring启动测试上下文时就会自动执行参数注入：

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringRunner;

import javax.servlet.ServletContext;

import static org.junit.Assert.assertNotNull;

@RunWith(SpringRunner.class)
@SpringBootTest
@ContextConfiguration(initializers = ConfigurableServletContextInitializer.class)
public class YourServiceTest {

    @Autowired
    private ServletContext servletContext;

    @Test
    public void verifyServletContextHasParam() {
        String paramValue = servletContext.getInitParameter("third-party.config.key");
        assertNotNull("第三方库需要的参数未加载到Mock ServletContext", paramValue);
        // 可以进一步断言参数值是否符合预期
        // assertEquals("预期参数值", paramValue);
    }
}

方法二：针对WebMvc测试的快捷配置 #

如果你的测试是用@WebMvcTest针对Controller的场景，可以在@Before方法中直接给MockServletContext设置参数：

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.mock.web.MockServletContext;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.web.context.WebApplicationContext;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@RunWith(SpringRunner.class)
@WebMvcTest(YourController.class)
public class YourControllerTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    @Value("${third-party.config.key}")
    private String thirdPartyParam;

    private MockMvc mockMvc;

    @Before
    public void setupMockServletContext() {
        // 获取MockServletContext并注入参数
        MockServletContext servletContext = (MockServletContext) webApplicationContext.getServletContext();
        servletContext.setInitParameter("third-party.config.key", thirdPartyParam);
        
        // 初始化MockMvc
        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
    }

    @Test
    public void testControllerUsesThirdPartyParam() throws Exception {
        mockMvc.perform(get("/your-api-endpoint"))
                .andExpect(status().isOk());
        // 这里可以验证Controller调用第三方库时是否正确获取到参数
    }
}

方法三：批量加载参数（适合多参数场景） #

如果需要配置多个ServletContext参数，可以用@ConfigurationProperties批量绑定application.yml里的配置，再一次性注入到Mock ServletContext中：

步骤1：创建参数绑定类 #

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Map;

@Component
@ConfigurationProperties(prefix = "servlet.context.init-params")
public class ServletContextInitParams {
    private Map<String, String> params;

    // getter和setter
    public Map<String, String> getParams() {
        return params;
    }

    public void setParams(Map<String, String> params) {
        this.params = params;
    }
}

步骤2：在application.yml中配置参数 #

servlet:
  context:
    init-params:
      third-party.config.key: "your-param-value"
      another.third-party.param: "another-value"

步骤3：修改初始化器批量设置参数 #

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.context.ServletContextInitializer;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

public class BatchServletContextInitializer implements ServletContextInitializer {

    @Autowired
    private ServletContextInitParams initParams;

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // 批量设置所有参数
        initParams.getParams().forEach(servletContext::setInitParameter);
    }
}

最后在测试类中引入这个初始化器即可，和方法一的测试类配置一致。

这些方法都能让Mock ServletContext加载application.yml里的参数，替代硬编码的临时方案，保证测试和运行环境的配置一致性。

内容的提问来源于stack exchange，提问作者Rafael Rocha