如何基于文件动态配置Spring Integration SFTP的SftpSessionFactory

针对你提出的「根据文件名前缀匹配不同SFTP服务器，且不能硬编码配置」的需求，核心思路是通过动态管理SftpSessionFactory实例结合Spring Integration的SessionFactoryLocator接口实现动态选择，具体步骤如下：

1. 预加载并缓存SFTP会话工厂 #

服务启动时从配置服务器拉取所有SFTP配置，将每个配置对应的DefaultSftpSessionFactory实例存入Map，键对应文件名前缀（如"A"、"B"）：

@Configuration
public class SftpConfig {
    // 从配置服务器拉取所有SFTP配置的方法
    private Map<String, SftpValues> getAllSftpValues() {
        // 此处实现连接配置服务器获取配置的逻辑
        return new HashMap<>();
    }

    @Bean
    public Map<String, DefaultSftpSessionFactory> sftpSessionFactoryMap() {
        Map<String, SftpValues> sftpConfigMap = getAllSftpValues();
        Map<String, DefaultSftpSessionFactory> factoryMap = new HashMap<>();

        sftpConfigMap.forEach((prefix, sftpValues) -> {
            DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory();
            factory.setHost(sftpValues.getHost());
            factory.setUser(sftpValues.getUser());
            factory.setPassword(sftpValues.getPassword());
            factory.setPort(sftpValues.getPort());
            // 可按需添加超时、密钥等其他配置
            factoryMap.put(prefix, factory);
        });
        return factoryMap;
    }
}

2. 实现自定义SessionFactoryLocator #

通过这个接口，我们可以根据当前消息中的文件信息，动态匹配对应的SFTP会话工厂：

@Component
public class DynamicSftpSessionFactoryLocator implements SessionFactoryLocator<ChannelSftp.LsEntry> {
    private final Map<String, DefaultSftpSessionFactory> sessionFactoryMap;

    // 构造注入缓存的会话工厂Map
    public DynamicSftpSessionFactoryLocator(Map<String, DefaultSftpSessionFactory> sessionFactoryMap) {
        this.sessionFactoryMap = sessionFactoryMap;
    }

    @Override
    public SessionFactory<ChannelSftp.LsEntry> getSessionFactory(Message<?> message) {
        // 从消息 payload 中获取文件对象
        File file = (File) message.getPayload();
        String filename = file.getName();
        
        // 提取文件名前缀（此处取首字符，可根据实际规则调整）
        String prefix = filename.substring(0, 1).toUpperCase();
        
        // 匹配对应的会话工厂，无匹配时抛出明确异常或使用默认配置
        DefaultSftpSessionFactory factory = sessionFactoryMap.get(prefix);
        if (factory == null) {
            throw new IllegalArgumentException("未找到前缀[" + prefix + "]对应的SFTP配置");
        }
        return factory;
    }
}

3. 修改SFTP出站适配器配置 #

将原配置中固定的session-factory替换为自定义的session-factory-locator，让适配器动态选择会话工厂：

XML配置方式 #

<!-- 注入自定义的会话工厂定位器 -->
<bean id="dynamicSftpSessionFactoryLocator" class="com.yourpackage.DynamicSftpSessionFactoryLocator">
    <constructor-arg ref="sftpSessionFactoryMap"/>
</bean>

<!-- 修改SFTP出站适配器，使用动态定位器替代固定会话工厂 -->
<int-sftp:outbound-channel-adapter id="sftpOutboundAdapter" 
                                   session-factory-locator="dynamicSftpSessionFactoryLocator"
                                   channel="sftpChannel" 
                                   charset="UTF-8" 
                                   remote-directory="/"
                                   remote-file-separator="/"/>

Java配置方式（Spring Boot推荐） #

@Bean
public SftpMessageHandler sftpOutboundAdapter(DynamicSftpSessionFactoryLocator locator) {
    SftpMessageHandler handler = new SftpMessageHandler(locator);
    handler.setRemoteDirectoryExpression(new LiteralExpression("/"));
    handler.setFileNameGenerator(message -> ((File) message.getPayload()).getName());
    return handler;
}

@Bean
public IntegrationFlow sftpUploadFlow(SftpMessageHandler sftpOutboundAdapter) {
    return IntegrationFlows.from("sftpChannel")
            .handle(sftpOutboundAdapter)
            .get();
}

可选优化点 #

• 配置动态刷新：如果配置服务器的SFTP配置会动态更新，可以结合Spring Cloud Config的@RefreshScope或自定义配置监听，实现无需重启服务即可刷新会话工厂缓存。
• 前缀匹配逻辑扩展：可根据实际需求调整前缀提取规则（如取前2个字符、匹配特定前缀字符串等）。
• 异常兜底处理：针对未匹配到前缀的情况，可设置默认会话工厂，避免流程中断。

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