Spring Integration如何实现FTP/SFTP带前缀的临时文件发送？

Great question! I’ve dealt with similar legacy system quirks before, so I totally get why the default suffix-based temp file approach isn’t working for you. Let’s walk through some more elegant solutions that play nicely with Spring Integration’s ecosystem, instead of rolling entirely custom logic.

1. 自定义消息处理器扩展前缀逻辑 #

Spring Integration的FileTransferringMessageHandler（FTP/SFTP出站适配器的核心组件）默认只支持后缀，但你可以通过继承它来添加前缀临时文件的逻辑，同时复用框架的会话管理、错误处理能力：

public class PrefixTempSftpMessageHandler extends SftpMessageHandler {

    private String temporaryFilePrefix = "S"; // 默认前缀

    public void setTemporaryFilePrefix(String temporaryFilePrefix) {
        this.temporaryFilePrefix = temporaryFilePrefix;
    }

    @Override
    protected void doPut(Message<?> message, String remoteDirectory) throws Exception {
        // 获取最终目标文件名
        String targetFileName = getFileNameGenerator().generateFileName(message);
        // 生成带前缀的临时文件名
        String tempFileName = this.temporaryFilePrefix + targetFileName;
        
        // 上传临时文件
        getRemoteFileTemplate().send(
                MessageBuilder.withPayload(message.getPayload())
                        .setHeader(FileHeaders.FILENAME, tempFileName)
                        .build(),
                remoteDirectory);
        
        // 重命名为最终文件名
        getRemoteFileTemplate().rename(
                remoteDirectory + "/" + tempFileName,
                remoteDirectory + "/" + targetFileName);
    }
}

然后在配置类中替换默认的SftpMessageHandler：

@Bean
public MessageHandler sftpOutboundHandler(SftpSessionFactory sessionFactory) {
    PrefixTempSftpMessageHandler handler = new PrefixTempSftpMessageHandler();
    handler.setSessionFactory(sessionFactory);
    handler.setRemoteDirectoryExpression(new LiteralExpression("/your/remote/path"));
    handler.setTemporaryFilePrefix("S"); // 设置你的业务前缀
    return handler;
}

2. 使用请求处理器增强器（RequestHandlerAdvice） #

如果不想修改处理器源码，可以用Spring Integration的RequestHandlerAdvice做AOP风格的拦截，实现临时文件的上传与重命名，灵活性更高：

public class TempPrefixAdvice extends AbstractRequestHandlerAdvice {

    private String tempPrefix = "S";
    private final RemoteFileTemplate<?> remoteFileTemplate;

    public TempPrefixAdvice(RemoteFileTemplate<?> remoteFileTemplate) {
        this.remoteFileTemplate = remoteFileTemplate;
    }

    @Override
    protected Object doInvoke(ExecutionCallback callback, Object target, Message<?> message) throws Exception {
        String originalFileName = message.getHeaders().get(FileHeaders.FILENAME, String.class);
        String tempFileName = tempPrefix + originalFileName;
        String remoteDir = (String) ((FileTransferringMessageHandler<?>) target).getRemoteDirectoryExpression().getValue();

        // 构建临时文件消息并发送
        Message<?> tempMessage = MessageBuilder.fromMessage(message)
                .setHeader(FileHeaders.FILENAME, tempFileName)
                .build();
        Object result = callback.execute(tempMessage);
        
        // 重命名为最终文件名
        remoteFileTemplate.rename(remoteDir + "/" + tempFileName, remoteDir + "/" + originalFileName);
        return result;
    }
}

配置时给默认处理器添加增强器，并禁用默认的后缀临时文件：

@Bean
public MessageHandler sftpOutboundHandler(SftpSessionFactory sessionFactory, RemoteFileTemplate<SftpClient.DirEntry> sftpTemplate) {
    SftpMessageHandler handler = new SftpMessageHandler();
    handler.setSessionFactory(sessionFactory);
    handler.setRemoteDirectoryExpression(new LiteralExpression("/your/remote/path"));
    handler.setTemporaryFileSuffix(""); // 关闭默认后缀逻辑
    handler.setAdviceChain(List.of(new TempPrefixAdvice(sftpTemplate))); // 添加前缀增强器
    return handler;
}

3. 封装RemoteFileTemplate工具类 #

如果更倾向于手动控制但想让代码更整洁，可以封装一个专用工具类，把前缀临时文件的逻辑固化：

@Component
public class SftpPrefixUploader {

    private final RemoteFileTemplate<SftpClient.DirEntry> sftpTemplate;
    private String tempPrefix = "S";

    public SftpPrefixUploader(RemoteFileTemplate<SftpClient.DirEntry> sftpTemplate) {
        this.sftpTemplate = sftpTemplate;
    }

    public void uploadWithPrefixTempFile(File file, String remoteDir, String targetFileName) {
        String tempFileName = tempPrefix + targetFileName;
        // 上传临时文件
        sftpTemplate.send(MessageBuilder.withPayload(file)
                .setHeader(FileHeaders.FILENAME, tempFileName)
                .build(), remoteDir);
        // 重命名为最终文件
        sftpTemplate.rename(remoteDir + "/" + tempFileName, remoteDir + "/" + targetFileName);
    }
}

方案对比 #

你当前用RemoteFileTemplate禁用临时文件自行处理的思路是可行的，但上面的方案1和2更贴合Spring Integration的组件模型，能复用框架的错误重试、会话池管理等特性；方案3则是对现有逻辑的优雅封装，减少零散代码。

具体选哪个取决于场景：如果需要完全融入Spring Integration的消息流，方案1或2更合适；如果只是简单的文件上传操作，方案3更轻便。

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