Spring MVC Controller 單元測試

2019-11-14 21:06:15

字體：大中小

來源：轉載

供稿：網友

SPRing MVC Controller 單元測試

簡介
Controller層的單元測試可以使得應用的可靠性得到提升，雖然這使得開發的時間有所增加，有得必失，這里我認為得到的比失去的多很多。
Sping MVC3.2版本之后的單元測試方法有所變化，隨著功能的提升，單元測試更加的簡單高效。
這里以4.1版本為例，記錄Controller的單元測試流程。非常值得參考的是Spring MVC Showcase(https://github.com/spring-projects/spring-mvc-showcase)，它當前的版本使用的是4.1.0，以后會有所變動，為了使項目能夠運行，請以它更新的配置為參考。
我用的IDE是IntelliJ IDEA13，我個人認為比Eclipse好用很多，是付費的，很貴！
項目結構
使用maven構建項目，項目結構如下：
在Controller層的測試不需要寫單獨的Spring config，可以直接使用src/main/java中的.xml
這里記錄一下，Spring Mvc context的配置策略：
好多的小伙伴都會在一個文件(e.g spring-mvc.xml）中配置很多的東西，來看看showcase中web的配置結構
WEB-INF
web.xml (文件)
spring （文件夾）
root-context.xml （文件，放置能夠被servlet和filter共享使用的資源）
appServlet （目錄）
controllers.xml（文件，與Controller相關的配置）
servlet-context.xml （文件，放置有servlet使用的資源）

Spring mvc是對Servlet的包裝，使其能夠結構化，流程化。

 1 <web-app xmlns="http://java.sun.com/xml/ns/javaee" 2  3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4  5 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 6  7 version="3.0"> 8  9 <!-- The definition of the Root Spring Container shared by all Servlets and Filters -->10 11 <context-param>12 13 <param-name>contextConfigLocation</param-name>14 15 <param-value>/WEB-INF/spring/root-context.xml</param-value>16 17 </context-param>18 19 <!-- Creates the Spring Container shared by all Servlets and Filters -->20 21 <listener>22 23 <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>24 25 </listener>26 27 <filter>28 29 <filter-name>csrfFilter</filter-name>30 31 <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>32 33 <async-supported>true</async-supported>34 35 </filter>36 37 <filter-mapping>38 39 <filter-name>csrfFilter</filter-name>40 41 <url-pattern>/*</url-pattern>42 43 </filter-mapping>44 45 <!-- Processes application requests -->46 47 <servlet>48 49 <servlet-name>appServlet</servlet-name>50 51 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>52 53 <init-param>54 55 <param-name>contextConfigLocation</param-name>56 57 <param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>58 59 </init-param>60 61 <load-on-startup>1</load-on-startup>62 63 <async-supported>true</async-supported>64 65 </servlet>66 67 <servlet-mapping>68 69 <servlet-name>appServlet</servlet-name>70 71 <url-pattern>/</url-pattern>72 73 </servlet-mapping>74 75 <!-- Disables Servlet Container welcome file handling. Needed for compatibility with Servlet 3.0 and Tomcat 7.0 -->76 77 <welcome-file-list>78 79 <welcome-file></welcome-file>80 81 </welcome-file-list>82 83 </web-app>

可以看到分開配置，使得文件的作用更加的明了。

這部分的配置文件是來配置web context 的，項目中還有其他的module ，如DAO，Service，他們對應的applicationContext文件會被放在src/main/resource目錄下。

完善的單元測試當然還有service的單元測試，這里就不說了，但是Controller的單元測試還需要調用service和DAO，要注意Service和DAO的applicationContext的引入。

Controller 單元測試
在測試類中包含這三個注釋，看起表面意思不難理解他們的作用，主要理解ContextConfiguration的使用。
@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration //默認是src/main/webapp
@ContextConfiguration("file:src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml")
注意：這里的@ContextConfiguration只解析了servlet-context.xml，如果項目中還存在其他模塊的applicationContext，也需要把他們引進來否則得到的Service就是null的。
例如
@ContextConfiguration({
"file:src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml",
“classpath*: springxml/**.xml”
})
在加上其他的一點代碼就可以完成一個Controller的單元測試，下面是一個例子，更多例子請參考showcase中的內容。
package pairwinter.spring.mvc.controller.test;import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup;import org.junit.Before;import org.junit.Test;import org.junit.runner.RunWith;import org.springframework.samples.mvc.AbstractContextControllerTests;import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;import org.springframework.test.web.servlet.MockMvc;@RunWith(SpringJUnit4ClassRunner.class)@WebAppConfiguration@ContextConfiguration({"file:src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml",“classpath*: springxml/**.xml”})public class ControllerTests{@Autowiredprivate WebApplicationContext wac;private MockMvc mockMvc;@Beforepublic void setup() throws Exception {this.mockMvc = webAppContextSetup(this.wac).build();}@Testpublic void controllerExceptionHandler() throws Exception {this.mockMvc.perform(get("/test")).andExpect(status().isOk());}}