Spring Integration SFTP私钥配置自定义JSch失效报错问题

当前写法失效的核心原因是DefaultSftpSessionFactory的参数校验逻辑存在明确的判断边界：

• 你通过new DefaultSftpSessionFactory(javaSecureChannel, true)传入预添加了私钥身份的JSch实例后，工厂初始化会话的前置校验不会自动扫描你提前放入JSch对象的Identity信息
• 该校验逻辑仅判断工厂自身持有的password、privateKey、privateKeyBytes、privateKeyPassphrase这几个认证相关属性是否有赋值，你没有给这些属性设值，就直接抛出either a password or a private key is required异常，代码根本不会走到后续调用JSch创建连接的步骤。

不需要手动创建预加载私钥的JSch实例，DefaultSftpSessionFactory本身已经封装了完整的私钥认证配置能力，直接调用工厂提供的set方法配置即可，适配你现有代码逻辑的实现如下：

private SessionFactory<ChannelSftp.LsEntry> createSftpSessionFactoryForPrivateKeyCredentials(
      SftpProperties sftpProperties, String sftpUser, String privateKey) {

    byte[] privateKeyBytes = privateKey.getBytes(StandardCharsets.UTF_8);
    // 直接使用默认构造方法实例化工厂，参数true表示使用共享会话模式
    DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(true);
    // 直接给工厂设置私钥字节数组，工厂内部会自动完成JSch的Identity加载
    factory.setPrivateKey(privateKeyBytes);
    // 如果你的私钥设置了访问密码，放开下方注释配置密码
    // factory.setPrivateKeyPassphrase("你的私钥访问密码");
    return setCommonConfigProperties(factory, sftpProperties, sftpUser);
}

如果你的私钥存储在本地文件中，不需要手动读取为字节流，可以直接配置私钥文件路径：

DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(true);
// 配置私钥文件的绝对路径
factory.setPrivateKey("/home/yourname/.ssh/id_rsa");
// 私钥有密码则配置对应密码
// factory.setPrivateKeyPassphrase("你的私钥访问密码");

• 传入的私钥必须是标准OpenSSH格式，PuTTY生成的.ppk格式私钥需要先转换为OpenSSH格式才能正常使用，否则会抛出无效私钥错误
• 如果有自定义JSch参数的需求（比如自定义HostKey校验规则、加密算法、代理配置等），优先使用DefaultSftpSessionFactory对外暴露的set方法完成配置，不要自行创建预配置的JSch实例传入，避免触发不必要的校验问题
• 如果私钥是配置在配置中心或环境变量中，注意转义问题，避免私钥内容里的换行符被转义导致私钥解析失败

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