Unit Testing of Spring MVC Controllers1

我们的pom.xml文件相关的部分看起来如下：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.2.1</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.2.1</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest-all</artifactId>
    <version>1.3</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <artifactId>hamcrest-core</artifactId>
            <groupId>org.hamcrest</groupId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>1.9.5</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>3.2.3.RELEASE</version>
    <scope>test</scope>
</dependency>

让我们找出我们如何利用Spring MVC框架Spring MVC控制器测试编写单元测试。

写控制方法的单元测试

每一个单元测试，我们写测试控制器方法的行为包括：

　　1、我们请求发送到测试控制器的方法

　　2、我们确认我们已经收到了预期的响应

Spring MVC 框架测试有几个“核心”类，我们可以用在我们的测试中执行这些步骤。这些描述如下：

　　我们可以利用的 MockMvcRequestBuilders类的静态方法建立我们的请求。或者更具体的说，我们可以

创建请求的建设者。然后作为方法的参数来执行实际的请求专递到方法。

 　　该Mockmvc阶级是我们测试的主要入口点。我们可以通过调用它的执行请求(RequestBuilder requestbuilder)方法。

　　我们可以利用MockMvcResultMathers类的静态方法接收响应断言。

接下来我们看看一些例子，演示了如何我们可以在单元测试中使用这些类，我们将写下面的控制器方法的单元测试： 

　　第一控制器的方法呈现的页面列出待办事项条目。

　　第二控制器的方法呈现了一个页面，显示一个单做输入信息。

　　第三控制器的方法处理这是用来添加新的待办事项记录到数据库的表单提交。

绘制TODO条目列表页

让我们以在控制器的方法用来渲染todo条目列表页面执行的外观开始。

想象的行为

该控制器的方法是用来显示todo信息化实施的步骤：

　　1、处理GET请求发送到URL“/”

　　2、他得到的todo通过调用接口的todoservice findall()方法。此方法返回一个列表的todo对象

　　3、它增加了接收列表模型

　　4、它返回渲染视图的名称

TodoController 类相关的部分看起来如下：

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import java.util.List;

@Controller

public class TodoController{

　　private final TodoService service;

　　@RequestMapping(value="/",method=RequestMethod.GET)

　　public string findAll(Model model){

　　　　List<Todo> models=service.findAll();

　　　　model.addAttribute("todos",models);

　　　　return "todo/list";

　　}

}

现在我们已经准备好为这个方法编写一个单元测试。让我们来看看我们能做到。

测试：发现todo
我们可以写一个单元测试这个控制器的方法通过以下步骤:

　　1、创建测试数据，回来时，我们的服务调用的方法。我们使用的一个概念，称为测试数据生成器时，我们为我们的测试生成测试数据。

　　2、配置用于模拟对象返回创建的测试数据时，其findall()方法称为。

　　3、执行一个GET请求URL“/”。

　　4、确保HTTP状态码返回200。

　　5、确保返回的视图名称是“做/列表”。

　　6、确保请求转发到URL“/WEB-INF／JSP /待办事项列表。JSP”。

　　7、确保模型的属性称为：有两个项目。

　　8、确认模型的属性称为：包含正确的项目

　　9、验证我们的模拟对象的findall()方法被称为只有一次。

　　10、确保其他的模仿对象的方法没有在测试过程中被称为。

我们单位的源代码测试如下:

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import java.util.Arrays;

import static org.hamcrest.Matchers.*;
import static org.hamcrest.Matchers.is;
import static org.mockito.Mockito.*;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.model;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {TestContext.class, WebAppContext.class})
@WebAppConfiguration
public class TodoControllerTest {

    private MockMvc mockMvc;

    @Autowired
    private TodoService todoServiceMock;

    //Add WebApplicationContext field here

    //The setUp() method is omitted.

    @Test
    public void findAll_ShouldAddTodoEntriesToModelAndRenderTodoListView() throws Exception {
        Todo first = new TodoBuilder()
                .id(1L)
                .description("Lorem ipsum")
                .title("Foo")
                .build();

        Todo second = new TodoBuilder()
                .id(2L)
                .description("Lorem ipsum")
                .title("Bar")
                .build();

        when(todoServiceMock.findAll()).thenReturn(Arrays.asList(first, second));

        mockMvc.perform(get("/"))
                .andExpect(status().isOk())
                .andExpect(view().name("todo/list"))
                .andExpect(forwardedUrl("/WEB-INF/jsp/todo/list.jsp"))
                .andExpect(model().attribute("todos", hasSize(2)))
                .andExpect(model().attribute("todos", hasItem(
                        allOf(
                                hasProperty("id", is(1L)),
                                hasProperty("description", is("Lorem ipsum")),
                                hasProperty("title", is("Foo"))
                        )
                )))
                .andExpect(model().attribute("todos", hasItem(
                        allOf(
                                hasProperty("id", is(2L)),
                                hasProperty("description", is("Lorem ipsum")),
                                hasProperty("title", is("Bar"))
                        )
                )));

        verify(todoServiceMock, times(1)).findAll();
        verifyNoMoreInteractions(todoServiceMock);
    }
}

 渲染视图做首页

 在我们可以为我们的控制器的方法编写单元测试，我们必须仔细看看这方法的实现。
让我们找到我们的控制器的实现。 

 控制器的方法，是用来显示一个待办事项输入信息是通过以下步骤：
　　1、它处理GET请求发送到URL /做/ {id}”。的{id}是一个路径变量，其中包含所请求的任务项的标识。
　　2、获得所要求的待办事项条目通过调用的todoservice接口findbyid()方法和通过所要求的做的条目ID作为方法参数。这个方法返回发现做入门。如果没有做的条目被发现，该方法抛出一个todonotfoundexception。
　　3、它增加了发现做进入模型。
　　4、它返回渲染视图的名称。

我们的控制器方法的源代码如下：

 import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

@Controller
public class TodoController {

    private final TodoService service;

    @RequestMapping(value = "/todo/{id}", method = RequestMethod.GET)
    public String findById(@PathVariable("id") Long id, Model model) throws TodoNotFoundException {
        Todo found = service.findById(id);
        model.addAttribute("todo", found);
        return "todo/view";
    }
}

 
我们下一个问题是：
当一个todonotfoundexception扔？
在本教程的一部分，我们创建了一个异常解析器豆，用于处理我们的控制器类抛出的异常。该bean的配置如下：

@Bean
public SimpleMappingExceptionResolver exceptionResolver() {
    SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();

    Properties exceptionMappings = new Properties();

    exceptionMappings.put("net.petrikainulainen.spring.testmvc.todo.exception.TodoNotFoundException", "error/404");
    exceptionMappings.put("java.lang.Exception", "error/error");
    exceptionMappings.put("java.lang.RuntimeException", "error/error");

    exceptionResolver.setExceptionMappings(exceptionMappings);

    Properties statusCodes = new Properties();

    statusCodes.put("error/404", "404");
    statusCodes.put("error/error", "500");

    exceptionResolver.setStatusCodes(statusCodes);

    return exceptionResolver;
}

 我们可以看到，如果一个todonotfoundexception扔，我们的应用使误差/ 404′视图并返回HTTP状态代码404。
很明显，我们写了这两个测试控制器的方法：
我们要写一个测试，确保我们的程序是正确工作时做的条目不发现。
我们要写一个测试验证了我们的程序是正确工作时做的条目被发现。
让我们看看如何写这些测试。

试验1：做的条目不发现 

来自：http://java.dzone.com/articles/junit-testing-spring-mvc-1