SpringBoot:使用spring-boot-test对web应用做单元测试时如何测试Filter?

对SpringBoot的Web应用做单元测试时,一般会使用spring-boot-test,pom.xml中会添加如下内容:

XML 复制代码
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
		</dependency>

代码举例如下:

java 复制代码
import static org.junit.jupiter.api.Assertions.assertEquals;

import javax.annotation.Resource;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.DefaultMockMvcBuilder;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import com.test.protobuf.App;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = App.class)
public class WebAppTester {

	@Resource
	private WebApplicationContext ctx = null;

	private MockMvc mockMvc = null;

	@Before
	public void setupMockMvc() throws Exception {
		DefaultMockMvcBuilder builder = MockMvcBuilders.webAppContextSetup(ctx);

		this.mockMvc = builder.build();
	}

	@Test
	public void test01() throws Exception {
		String result = doHttpAsyncTest(mockMvc, "/admin/health", "", null);

		assertEquals("ok", result);
	}

	public String doHttpAsyncTest(MockMvc mockMvc, String uri, String httpBody, HttpHeaders httpHeaders)
			throws Exception {

		MockHttpServletRequestBuilder builder = MockMvcRequestBuilders.post(uri)
				.contentType(MediaType.APPLICATION_JSON);

		if (httpHeaders != null) {
			builder.headers(httpHeaders);
		}

		MvcResult result = mockMvc.perform(builder.content(httpBody)).andReturn();
		String httpRespBody = mockMvc.perform(MockMvcRequestBuilders.asyncDispatch(result))
				.andExpect(MockMvcResultMatchers.status().isOk())
				.andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON)).andReturn()
				.getResponse().getContentAsString();

		return httpRespBody;
	}

}

如果应用中以如下方式添加了Filter的话,使用以上代码无法测试这些Filter:

java 复制代码
import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class TestFilter implements Filter {

	private String checkUrl = "/";

	@Override
	public void init(FilterConfig config) throws ServletException {
		String checkUrl = config.getInitParameter("checkUrl");

		if (checkUrl != null) {
			this.checkUrl = checkUrl;
		}
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {

		HttpServletRequest httpReqt = (HttpServletRequest) request;
		String reqtUrl = httpReqt.getRequestURI();

		if (!reqtUrl.startsWith(checkUrl)) {
			chain.doFilter(request, response);

			return;
		}

		HttpServletResponse httpResp = (HttpServletResponse) response;
		httpResp.setStatus(200);
		httpResp.setContentType("text/plain");
		httpResp.getWriter().write("ok");

		return;
	}

}
java 复制代码
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterRegistrationConfig {

	public FilterRegistrationBean<TestFilter> testFilter() {
		FilterRegistrationBean<TestFilter> reg = new FilterRegistrationBean<TestFilter>();

		reg.setFilter(new TestFilter());
		reg.addInitParameter("checkUrl", "/admin/");
		reg.setName("TestFilter");

		return reg;
	}
}

如果想把这些Filter也测试到,需要在setupMockMvc方法中将Filter注册并初始化一下,代码如下:

java 复制代码
import com.test.protobuf.App;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = App.class)
public class WebAppTester {

	@Resource
	private WebApplicationContext ctx = null;

	private MockMvc mockMvc = null;

	@Resource
	private FilterRegistrationBean<?>[] filterRegistrationBean = null;

	@Before
	public void setupMockMvc() throws Exception {
		DefaultMockMvcBuilder builder = MockMvcBuilders.webAppContextSetup(ctx);

		for (FilterRegistrationBean<?> bean : filterRegistrationBean) {

			MockFilterConfig filterConfig = new MockFilterConfig();
			for (Entry<String, String> params : bean.getInitParameters().entrySet()) {
				filterConfig.addInitParameter(params.getKey(), params.getValue());
			}

			Filter filter = bean.getFilter();
			filter.init(filterConfig);

			builder.addFilter(filter, bean.getUrlPatterns().toArray(new String[0]));
		}

		this.mockMvc = builder.build();
	}
......
}
相关推荐
seventeennnnn1 小时前
谢飞机的Java高级开发面试:从Spring Boot到分布式架构的蜕变之旅
spring boot·微服务架构·java面试·分布式系统·电商支付
超级小忍2 小时前
服务端向客户端主动推送数据的几种方法(Spring Boot 环境)
java·spring boot·后端
时间会给答案scidag3 小时前
报错 400 和405解决方案
vue.js·spring boot
Wyc724093 小时前
SpringBoot
java·spring boot·spring
ladymorgana5 小时前
【Spring Boot】HikariCP 连接池 YAML 配置详解
spring boot·后端·mysql·连接池·hikaricp
GJCTYU7 小时前
spring中@Transactional注解和事务的实战理解附代码
数据库·spring boot·后端·spring·oracle·mybatis
风象南8 小时前
SpringBoot敏感配置项加密与解密实战
java·spring boot·后端
写不出来就跑路9 小时前
暑期实习感悟与经验分享:从校园到职场的成长之路
java·开发语言·经验分享·spring boot
程序员张313 小时前
Maven编译和打包插件
java·spring boot·maven
灵犀学长14 小时前
EasyExcel之SheetWriteHandler:解锁Excel写入的高阶玩法
spring boot·excel