首页 文章

使用Spring MVC和Mockito从MockMvc Test中没有JSON内容(来自null)

提问于
浏览
1

有一个代码库,它使用SpringMVC 4.0.3.RELEASE进行Restful Web Services .

Codebase包含一个功能齐全的Restful Web服务,我可以使用postman和curl验证工作 .

但是,当尝试使用MockMvc为特定的Restful Web Service编写单元测试时,我试图从单元测试中获取JSON内容时被阻止 .

我想知道它是配置问题还是我没有正确创建假对象的问题(因为这不依赖于tomcat而且是独立的) .

pom.xml中:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>4.0.3.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>4.0.3.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>4.0.3.RELEASE</version>
    <scope>test</scope>
</dependency>

<!-- A bunch of other Spring libs omitted from this post -->

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest-all</artifactId>
    <version>1.3</version>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>1.10.19</version>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>com.jayway.jsonpath</groupId>
    <artifactId>json-path-assert</artifactId>
    <version>0.9.1</version>
    <scope>test</scope>
</dependency>

WebConfig:

package com.myapp.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@EnableWebMvc
@Configuration
@ComponentScan("com.myapp.rest")
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.defaultContentType(MediaType.APPLICATION_JSON);
    }
}

ServletInitializer:

package com.myapp.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

import com.myapp.config.WebConfig;

public class ServletInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    protected Class<?>[] getServletConfigClasses() {
        return new Class[] { WebConfig.class };
    }

    @Override
    protected String[] getServletMappings() {
        return new String[] { "/" };
    }

    @Override
    protected Class<?>[] getRootConfigClasses() {
        return null;
    }
}

UserController的:

@RestController
@RequestMapping("/v2")
public class UserController {

    private final UserDAO dao;

    private HttpHeaders headers = null;

    @Autowired 
    public UserController(UserDAO dao) {
        this.dao = dao;
        headers = new HttpHeaders();
        headers.add("Content-Type", "application/json");
    }

    @RequestMapping(value = "users/{appId}", method = RequestMethod.GET, produces="application/json")
    @ResponseBody 
    public ResponseEntity<Object> getUserDetails(@PathVariable String appId) {
        Object jsonPayload = dao.getUser(appId);
        return new ResponseEntity<Object>(jsonPayload, headers, HttpStatus.OK);
    }
}

UserDAO的:

@Repository
public class UserDAO {

    private JdbcTemplate jdbcTemplate;

    @Autowired
    public UserDAO(@Qualifier("dataSourceDB") DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    // Finders methods (such as the getUser(appId)) which use Spring JDBC
}

WEB-INF / web.xml文件:

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

    <display-name>MyApp</display-name>

    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

    <servlet>
        <servlet-name>mvc-dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>mvc-dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/mvc-dispatcher-servlet.xml</param-value>
    </context-param>
</web-app>

WEB-INF / MVC-调度 - servlet.xml中:

<beans xmlns="http://www.springframework.org/schema/beans">

    <import resource="classpath:database.xml" />
    <context:component-scan base-package="com.myapp.rest" />
    <mvc:annotation-driven />

    <bean id="viewResolver"
        class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix">
            <value>/WEB-INF/pages/</value>
        </property>
        <property name="suffix">
            <value>.jsp</value>
        </property>
    </bean>
</beans>

SRC /主/资源/ database.xml:

<beans xmlns="http://www.springframework.org/schema/beans">
    <bean id="dataSourceDB" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName"><value>${jdbc.driver}</value></property>
        <property name="url"><value>${db.url}</value></property>
        <property name="username"><value>${db.username}</value></property>
        <property name="password"><value>${db.password}</value></property>
    </bean>
</beans>

我的实际单元测试:包com.myapp.rest.controllers;

RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:**/mvc-dispatcher-servlet.xml")
@WebAppConfiguration
public class UserControllerTest {

    private MockMvc mockMvc;

    @Mock
    private UserDAO dao;

    @InjectMocks
    private UserController controller;

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);
        mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
    }

    @Test
    public void getUserDetails() throws Exception {
        String appId = "23bdr4560l";
        mockMvc.perform(get("/v2/users/{appId}",appId)
               .accept(MediaType.APPLICATION_JSON))
               .andExpect(content().contentType(MediaType.APPLICATION_JSON))
               .andExpect(status().isOk())
               .andDo(print());
    }
}

当我在本地调用我的构建时:

mvn clean install

生成到stdout的输出:

运行com.myapp.rest.controllers.UserControllerTest

MockHttpServletRequest:
         HTTP Method = GET
         Request URI = /v2/users/23bdr4560l
          Parameters = {}
             Headers = {Accept=[application/json]}

             Handler:
                Type = com.myapp.rest.controllers.UserController
              Method = public org.springframework.http.ResponseEntity<java.lang.Object> com.myapp.rest.controllers.UserController.getUserDetails(java.lang.String)

               Async:
   Was async started = false
        Async result = null

  Resolved Exception:
                Type = null

        ModelAndView:
           View name = null
                View = null
               Model = null

            FlashMap:

MockHttpServletResponse:
              Status = 200
       Error message = null
             Headers = {Content-Type=[application/json]}
        Content type = application/json
                Body = 
       Forwarded URL = null
      Redirected URL = null
             Cookies = []
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.728 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

注意JSON正文部分是如何为空/ null:

Body =

因此,在尝试使用jsonPath访问JSON有效内容时:

@Test
public void getUserDetails() throws Exception {
    String appId = "23bdr4560l";
    mockMvc.perform(get("/v2/users/{appId}",appId)
           .accept(MediaType.APPLICATION_JSON))
           .andExpect(content().contentType(MediaType.APPLICATION_JSON))
           .andExpect(status().isOk())
           .andExpect(jsonPath("$", hasSize(2)))
           .andDo(print());
}

收到以下错误:

Results :

Tests in error: 
  getUserDetails(com.myapp.rest.controllers.UserControllerTest): json can not be null or empty

Tests run: 1, Failures: 0, Errors: 1, Skipped: 0

我可能做错了什么?

显然,我需要模拟出响应,但是使用Google搜索,其他人使用MockMvc能够获得他们的测试JSON .

这是配置问题(我是否需要为我的单元测试添加某种类型的注释)?

我需要在我的测试中实例化控制器吗?

奇怪的是,实际的Rest Call使用postman和curl工作(返回一个有效的JSON)......

这个代码库没有@Service类/层,只是@RestController与@Repository对话(见上文) .

真的认为基于Spring MVC的Restful Web Services的测试支持会容易得多 .

我的想法已经不多了......

我最欣赏任何帮助...

3 回答

  • 0

    当您尝试像这样模拟bean时,它会尝试使用默认构造函数创建模拟 .

    @Mock
    private UserDAO dao
    

    它适用于实际的休息调用,因为您在运行时提供了依赖的 DataSource dataSource . 为 UserDAO 类提供有效的依赖模拟 .

  • 0

    由于您在嘲笑UserDAO,因此您需要为该调用提供一些模拟期望:

    Object jsonPayload = dao.getUser(appId);
    

    在Controller内部,默认情况下它将返回null . 为此,请在MockMvc调用之前使用测试中的Mockito.when()方法:

    when(dao.getUser(anyString())).thenReturn(json)
    

    其中json是你自己设置的一些硬编码的json对象 .

  • 0

    对于初学者,既然你正在使用 MockMvcBuilders.standaloneSetup(...) ,你实际上并没有使用Spring TestContext Framework(TCF)来加载你的 WebApplicationContext . 因此,只需在测试类中完全删除以下声明:

    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = "classpath:**/mvc-dispatcher-servlet.xml")
    @WebAppConfiguration
    

    此外,您可以完全忽略XML配置文件,因为没有 WebApplicationContext 就不会使用它们 .

    另外,TCF从不使用 web.xml 和Servlet初始值设定项,因此您也可以忽略它们 .

    然后,正如@Plog所提到的,你需要为你的模拟 UserDAO 设置期望;否则, dao.getUser(appId) 的调用始终返回 null ,这将导致一个空响应体 .

    问候,

    Sam(Spring TestContext Framework的作者)

相关问题