为什么webflux的spring boot测试会忽略自定义jackson模块

Question

我正在使用Spring Boot 2.0.1和WebFlux路由器函数（不是基于注释的！）编写一个应用程序。对于我的一些数据对象，我编写了扩展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实例，但也没有使用。我想知道我是否错过了一个设置（虽然我尝试了很多注释…）或者如果我碰到了虫子。我在谷歌上做了很多搜索，但迄今为止，我找到的任何解决方案都没有帮助。此外，目前很少有ppl使用路由器功能：）。

感谢您的帮助！

更新：我尝试了2.0.2。版本和2.1.0。以及BUILD-20180509。结果总是一样的。

Answer 1

虽然Sébastien提供的解决方案在演示代码中完美运行，但在将其引入主端后，我遇到了一些问题。@SpringBootTest会拉入太多bean，这反过来又需要大量外部配置设置等。并且测试应该只涵盖路由和序列化。

然而，删除@SpringBootTest会让我再次没有自定义序列化。所以我玩了一会儿@AutoCongraph...注释，找到了一个集合，允许我在嘲笑/省略其他所有内容的同时测试路由和序列化。

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
}

Answer 2

为了正确考虑Jackson模块，您可以使用AutoConfigureWebTestClient，并按以下方式自动连接它，而不是在测试中手动创建WebTestClient：

@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\"}");
    }
}