为什么使用Webflux进行弹簧启动测试会忽略自定义杰克逊模块

Question

我正在使用Spring Boot 2.0.1和WebFlux路由器功能（ 不是基于注释！）编写应用程序。 对于我的某些数据对象，我编写了扩展StdSerializer自定义序列化StdSerializer 。 这些我在SimpleModule注册，并将该模块作为Bean公开。

当我运行应用程序时，此设置就像一个超级按钮。 实例化该Bean，并使用正确的序列化程序对REST响应进行序列化。

现在，我想编写一个测试来验证路由器功能及其背后的处理程序是否按预期工作。 我要模拟的处理程序背后的服务。 但是，在测试中，REST响应使用默认的序列化器 。

我创建了一个小型演示项目来重现该问题。 完整的代码可以在这里找到： http : //s000.tinyupload.com/?file_id=82815835861287011625

Gradle配置加载Spring Boot和一些依赖项以支持WebFlux和测试。

import io.spring.gradle.dependencymanagement.DependencyManagementPlugin
import org.springframework.boot.gradle.plugin.SpringBootPlugin

buildscript {
    ext {
        springBootVersion = '2.0.1.RELEASE'
    }
    repositories {
        mavenCentral()
        // To allow to pull in milestone releases from Spring
        maven { url 'https://repo.spring.io/milestone' }
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
        classpath("io.spring.gradle:dependency-management-plugin:1.0.5.RELEASE")

    }
}

apply plugin: 'java'
apply plugin: SpringBootPlugin
apply plugin: DependencyManagementPlugin


repositories {
    mavenCentral()

    // To allow to pull in milestone releases from Spring
    maven { url 'https://repo.spring.io/milestone' }
}

dependencyManagement {
    imports {
        mavenBom 'org.springframework.boot:spring-boot-dependencies:2.0.1.RELEASE'
    }
}

dependencies {
    compile 'org.springframework.boot:spring-boot-starter-webflux'

    compile 'org.slf4s:slf4s-api_2.12:1.7.25'

    testCompile 'org.springframework.boot:spring-boot-starter-test'
    testCompile 'org.springframework.boot:spring-boot-starter-json'
    testCompile 'junit:junit:4.12'
    testCompile "org.mockito:mockito-core:2.+"
}

数据对象有两个字段。

package com.example.model;

public class ReverserResult {
    private String originalString;
    private String reversedString;

    // ... constructor, getters
}

自定义序列化器以与默认序列化器完全不同的方式呈现数据对象。 原始字段名消失，数据对象的内容压缩为单个字符串。

@Component
public class ReverserResultSerializer extends StdSerializer<ReverserResult> {
    // ... Constructor ...

    @Override
    public void serialize(ReverserResult value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeStartObject();
        gen.writeFieldName("result");
        gen.writeString(value.getOriginalString() + "|" + value.getReversedString());
        gen.writeEndObject();
    }
}

序列化器包装在Jackson模块中，并作为bean公开。 运行实际应用程序时，已正确拾取此bean并将其添加到ObjectMapper 。

@Configuration
public class SerializerConfig {
    @Bean
    @Autowired public Module specificSerializers(ReverserResultSerializer reverserResultSerializer) {
        SimpleModule serializerModule = new SimpleModule();
        serializerModule.addSerializer(ReverserResult.class, reverserResultSerializer);

        return serializerModule;
    }
}

我还验证了该测试中确实存在该bean。 因此，我可以排除在测试期间创建的上下文缺少加载Bean的情况。

@RunWith(SpringRunner.class)
@SpringBootTest
public class ReverserRouteTest {
    @Autowired
    public ReverserRoutes reverserRoutes;

    @MockBean
    public ReverserService mockReverserService;

    @Autowired
    @Qualifier("specificSerializers")
    public Module jacksonModule;

    @Test
    public void testSerializerBeanIsPresent() {
        assertNotNull(jacksonModule);
    }

    @Test
    public void testRouteAcceptsCall() {
        given(mockReverserService.reverse(anyString())).willReturn(new ReverserResult("foo", "bar"));

        WebTestClient client = WebTestClient.bindToRouterFunction(reverserRoutes.createRouterFunction()).build();
        client.get().uri("/reverse/FooBar").exchange().expectStatus().isOk();
    }

    @Test
    public void testRouteReturnsMockedResult() {
        given(mockReverserService.reverse(anyString())).willReturn(new ReverserResult("foo", "bar"));

        WebTestClient client = WebTestClient.bindToRouterFunction(reverserRoutes.createRouterFunction()).build();
        client.get().uri("/reverse/somethingcompletelydifferent")
                .exchange()
                .expectBody().json("{\"result\":\"foo|bar\"}");
    }
}

运行应用程序时的结果：

GET http://localhost:9090/reverse/FooBar

HTTP/1.1 200 OK
transfer-encoding: chunked
Content-Type: application/json;charset=UTF-8

{
  "result": "FooBar|raBooF"
}

运行测试的结果：

< 200 OK
< Content-Type: [application/json;charset=UTF-8]

{"originalString":"foo","reversedString":"bar"}

我也尝试创建自己的ObjectMapper实例，但也没有使用它。 我想知道我是否缺少设置（尽管我确实尝试了很多注释...）还是遇到了错误。 我在Google和SO上进行了大量搜索，但是到目前为止，我发现的解决方案都没有帮助。 此外，到目前为止，几乎没有人使用路由器功能:)。

任何帮助表示赞赏！

更新：我尝试了2.0.2.RELEASE和2.1.0.BUILD-20180509。 结果总是一样的。

Answer 1

除了可以在测试中手动创建WebTestClient ，您还可以利用@AutoConfigureWebTestClient并按如下所示@AutoConfigureWebTestClient进行自动@AutoConfigureWebTestClient ，以便正确考虑您的Jackson模块：

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureWebTestClient
public class ReverserRouteTest {    
    @MockBean
    public ReverserService mockReverserService;

    @Autowired
    @Qualifier("specificSerializers")
    public Module jacksonModule;

    @Autowired
    public WebTestClient client;

    @Test
    public void testSerializerBeanIsPresent() {
        assertNotNull(jacksonModule);
    }

    @Test
    public void testRouteAcceptsCall() {
        given(mockReverserService.reverse(anyString())).willReturn(new ReverserResult("foo", "bar"));

        client.get().uri("/reverse/FooBar").exchange().expectStatus().isOk();
    }

    @Test
    public void testRouteReturnsMockedResult() {
        given(mockReverserService.reverse(anyString())).willReturn(new ReverserResult("foo", "bar"));

        client.get().uri("/reverse/somethingcompletelydifferent")
                .exchange()
                .expectBody().json("{\"result\":\"foo|bar\"}");
    }
}

Answer 2

尽管Sébastien提出的解决方案在演示代码中运行完美，但将其引入主应用程序后却遇到了一些问题。 @SpringBootTest会引入过多的bean，这反过来又需要大量的外部配置设置，等等。并且测试仅应覆盖路由和序列化。

但是，删除@SpringBootTest将使我再次没有自定义序列化。 因此，我对@AutoConfigure ...批注进行了一些测试，发现了一个允许我在模拟/忽略其他所有内容的同时测试路由和序列化的设置。

完整代码可在GitHub https://github.com/DerEros/demo-webflux-test-issue/tree/with-webfluxtest获得 。

相关更改在这里。 希望这对其他人也有帮助。

@RunWith(SpringRunner.class)
@WebFluxTest
@AutoConfigureWebClient
@Import({SerializerConfig.class, ReverserResultSerializer.class, ReverserRoutes.class, ReverseHandler.class, ReverserConfig.class})
public class ReverserRouteTest {
    @MockBean
    public ReverserService mockReverserService;

    @Autowired
    @Qualifier("specificSerializers")
    public Module jacksonModule;

    @Autowired
    public WebTestClient client;

    // Tests; no changes here
}