使用MockIntegrationContext测试FTP出站适配器时类型不匹配问题

错误原因 #

当你用@ServiceActivator标注MessageHandler类型的Bean时，Spring Integration会自动创建一个**IntegrationConsumer类型的端点Bean**（默认命名规则是原Bean名称.serviceActivator），而mockIntegrationContext.substituteMessageHandlerFor()方法需要操作的是这个端点Bean，不是你直接定义的FtpMessageHandlerBean，因此会抛出类型不匹配的错误。

解决方法 #

方法1：使用正确的端点Bean名称替换 #

直接使用Spring Integration自动生成的端点Bean名称（原handler名称 + .serviceActivator）进行替换：

ArgumentCaptor<Message<?>> messageArgumentCaptor = ArgumentCaptor.forClass(Message.class);
MessageHandler mockMessageHandler = MockIntegration.mockMessageHandler(messageArgumentCaptor)
        .handleNext(m -> {});
// 使用自动生成的端点Bean名称
mockIntegrationContext.substituteMessageHandlerFor("ftpOutboundAdapter.serviceActivator", mockMessageHandler);

方法2：调整FTP适配器的定义方式（推荐） #

将FTP出站适配器整合到IntegrationFlow中，而非单独定义MessageHandlerBean，这样可以直接指定handler的ID，更便于测试和管理：

@Bean
public StandardIntegrationFlow integrationFlow(DefaultFtpSessionFactory ftpSessionFactory) {
    return IntegrationFlows.from(inputChannel())
        .transform(transformer())
        // 给handler指定唯一ID
        .handle(Ftp.outboundAdapter(ftpSessionFactory)
                .remoteDirectory("/remote-directory")
                .fileNameGenerator(message -> "output.txt"),
            e -> e.id("ftpOutboundHandler"))
        .get();
}

测试时直接使用指定的ID替换：

mockIntegrationContext.substituteMessageHandlerFor("ftpOutboundHandler", mockMessageHandler);

方法3：更简便的方案——替换输出通道而非Handler #

如果只是需要捕获输出的Payload，无需替换Handler，直接用MockChannel替换原outputChannel即可：

@Autowired
private MessageChannel inputChannel;

// 用MockBean替换原outputChannel
@MockBean
private MessageChannel outputChannel;

@Test
void testIntegrationFlow() {
    ArgumentCaptor<Message<?>> payloadCaptor = ArgumentCaptor.forClass(Message.class);
    // 模拟send操作
    doNothing().when(outputChannel).send(payloadCaptor.capture());

    // 发送测试消息
    inputChannel.send(MessageBuilder.withPayload("test-input").build());

    // 验证转换后的Payload
    assertThat(payloadCaptor.getValue().getPayload()).isEqualTo("expected-transformed-value");
}

总结 #

• 不需要强制调整FTP出站适配器的核心实现，只需调整Bean定义方式或替换时的目标Bean名称即可解决类型错误。
• 推荐使用IntegrationFlow整合所有组件的方式，更符合Spring Integration的设计理念，也便于测试和维护。
• 若仅需验证Payload，替换输出通道是最简便的方案。

内容的提问来源于stack exchange，提问作者mongol