【问题标题】:Spring MVC test framework - JSON end point returns 406 only in testSpring MVC 测试框架 - JSON 端点仅在测试中返回 406
【发布时间】:2016-03-11 22:00:30
【问题描述】:

我已经使用 Hibernate 和 JPA 构建了一个有效的 Spring MVC Web 应用程序,它只有一个端点,只有在通过 Web 浏览器调用时才能成功返回 JSON。

我还通过了针对类的单元测试,尤其是映射端点的主控制器。

所以我的下一步是使用 Spring MVC 测试框架编写一些行为测试,以测试 JSON 端点及其所有工作部分(配置、控制器、服务、模型和存储库)。

我已经成功设置了一个测试,该测试使用我的应用程序配置,将东西注入/自动装配在一起,然后针对我的端点发出“GET”请求。我可以调试调用,从到达控制器端点,通过服务,到存储库,成功获取数据并返回正确的模型对象。但是,控制器随后返回 406 not accepted 响应,测试失败。

我已经花了 2 天时间解决这个问题,并且阅读了几乎所有博客文章和我可以接受的答案,但没有任何建议。

这是我的控制器:

@Controller
public class DataController {

    @Autowired
    private IService service;

    @RequestMapping(
            value = "/data",
            method = RequestMethod.GET,
            produces = "application/json"
    )
    public @ResponseBody
    ModelData getDataByCode(@RequestParam String code) {
        return service.getDataCode(code);
    }

}

服务:

@Service("dataService")
public class DataService implements IService {

    @Autowired
    private IDataRepository dataRepository;

    @Transactional
    public ModelData getDataByCode(String code){
        return dataRepository.getDataByCode(code);
    }
}

存储库:

@Repository("dataRepository")
public class DataRepository implements IDataRepository {

    @PersistenceContext
    private EntityManager entityManager;

    public ModelData getDataByCode(String code) throws IllegalStateException, PersistenceException {
        String selectJPAQueryBase = "Select data from ModelData data where data.code = %s";
        Query query = entityManager.createQuery(String.format(selectJPAQueryBase, code));
        return (ModelData) query.getSingleResult();
    }

}

与核心功能相关的依赖项:

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>3.2.14.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.6.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.6.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.6.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-oxm</artifactId>
            <version>3.2.14.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>4.2.0.Final</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-entitymanager</artifactId>
            <version>5.0.1.Final</version>
        </dependency>
        <dependency>
            <groupId>javax.transaction</groupId>
            <artifactId>jta</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>3.2.14.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>3.2.14.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>net.sourceforge.jtds</groupId>
            <artifactId>jtds</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-java</artifactId>
            <version>1.2.4</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-junit</artifactId>
            <version>1.2.4</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-all</artifactId>
            <version>1.3</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>3.2.14.RELEASE</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.jayway.jsonpath</groupId>
            <artifactId>json-path</artifactId>
            <version>0.8.1</version>
            <scope>test</scope>
        </dependency>

JPA 上下文:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.2.xsd
            http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">

    <context:annotation-config />

    <!-- where spring will start to look for classes that are annotated, allow this to find all annotated classes -->
    <context:component-scan base-package="com.app"/>

    <bean class="org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor" />

    <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="persistenceUnitName" value="punit"/>
        <property name="dataSource" ref="dataSource"/>
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                <property name="showSql" value="true"/>
            </bean>
        </property>
        <property name="jpaPropertyMap">
            <map>
                <entry key="hibernate.dialect" value="org.hibernate.dialect.SQLServer2008Dialect"/>
                <entry key="hibernate.hbm2ddl.auto" value="validate"/>
                <entry key="hibernate.format_sql" value="true"/>
            </map>
        </property>
    </bean>

    <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="entityManagerFactory"/>
    </bean>

    <tx:annotation-driven transaction-manager="transactionManager"/>

    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="net.sourceforge.jtds.jdbc.Driver"/>
        <property name="url" value="jdbc:jtds:sqlserver://0.0.0.0:1433/dbname"/>
        <property name="username" value="username"/>
        <property name="password" value="password"/>
    </bean>

</beans>

Web.xml:

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

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:/jpaContext.xml</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>dataByCode</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/config/servlet-config.xml</param-value>
        </init-param>
    </servlet>

    <servlet-mapping>
        <servlet-name>dataByCode</servlet-name>
        <url-pattern>/data</url-pattern>
    </servlet-mapping>

</web-app>

Servlet 配置:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">

    <!-- allows POJO objects to just use annotations for simply hooking into spring framework -->
    <mvc:annotation-driven/>

    <!-- where spring will start to look annotated classes, keep this to controller level -->
    <context:component-scan base-package="com.app"/>

    <!-- load properties files and similar -->
    <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
        <property name="basename" value="properties"/>
    </bean>

    <!-- basic resolver to handle jsp pages, usually linked to returning html -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <property name="suffix" value=".jsp"/>
        <property name="order" value="2"/>
    </bean>

</beans>

失败的测试:

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration("classpath:jpaContext.xml")
public class GetDataCodeIntTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.webApplicationContext).build();
    }

    @Test
    public void getDataByCode() throws Exception {
        String code = "1234";
        this.mockMvc.perform(MockMvcRequestBuilders.get("/data").param("code", code))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.jsonPath("$.code").value(code));
    }

}

这里的关键是应用程序可以通过浏览器完美运行,但在控制器返回响应时使用 spring mvc 测试框架失败。


更新:

解决方案是将我的 servlet-config.xml 和 jpaContext 一起注入到@ContextConfiguration 中,之后测试完美运行。

有趣的是,我不能只从类路径中加载 servlet-config.xml,而且我不想维护特定于测试的版本,所以我将它移到了我的资源文件夹中。这是否是一个好主意我还不确定,但它现在可以在类路径中使用。

【问题讨论】:

  • 尝试设置@Consumes,如果你正在设置accept同时检查依赖as here described
  • 请问@Consumes应该放在哪里?
  • 我根据链接的答案更改了版本,但没有运气,测试中仍然是 406。另外,老实说,代码都适用于当前的依赖项,只是在 spring mvc 测试框架测试中失败了。
  • 抱歉,这是个糟糕的建议

标签: json spring hibernate jpa spring-mvc-test


【解决方案1】:

我认为您的问题是您误解了“内容类型”标头,结果由 REST 控制器产生。

其实你把

MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON)

表示您正在向控制器发送 JSON。 然而,您的控制器正在尝试在您的请求中接收参数而不是 JSON:

@RequestParam 字符串代码

这可能是您拥有此 406 的原因(这通常意味着您的请求标头中的默认值)。

【讨论】:

  • .andExpect(MockMvcResultMatchers.status().isOk()) 之前失败了。另外,我尝试过在测试中指定和不指定内容类型,但它仍然失败并出现 406。
  • 我很确定.andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON)) 检查从控制器发回的数据是 JSON 类型,这正是我想要检查的。或者至少返回请求中的标头的内容类型为“application/json”。
  • 虽然他指向结果,但我猜他的意思是接受标头而不是结果检查。删除 accept 部分,因为这不是浏览器将发送的(除非您使用 JS 并自己明确设置内容类型)。
  • 是的,我同意,那只是因为我正在尝试专门为请求设置标头内容类型。我已将其删除,结果相同,406 测试失败。我会调整细节以反映这一点。
【解决方案2】:

尝试将您的servletConfig.xml 添加到您的测试类的@ContextConfiguration

@ContextConfiguration({"classpath:jpaContext.xml", "classpath:path/to/servlet-context.xml"})

其中重要的一点是&lt;mvc:annotation-driven/&gt;

另外请注意,您可以稍微简化控制器,并使其用途更清晰,方法是注释它@RestController 而不是@Controller

【讨论】:

    【解决方案3】:

    尝试通过 @ContextConfiguration 添加你的 spring-context.xml 进行测试(例如:@ContextConfiguration("classpath:spring-context.xml")),用这个选项尝试你的代码,它有效。

    【讨论】:

      猜你喜欢
      • 2018-04-27
      • 2019-02-04
      • 1970-01-01
      • 2012-12-16
      • 2020-11-21
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2012-12-11
      相关资源
      最近更新 更多