使用JSch实现SFTP文件传输

桃扇骨 2022-05-23 01:46 490阅读 0赞

maven依赖：

<dependency>
 <groupId>com.jcraft</groupId>
 <artifactId>jsch</artifactId>
 <version>0.1.51</version>
 </dependency>
 
 <dependency>
 <groupId>com.jcraft</groupId>
 <artifactId>jzlib</artifactId>
 <version>1.0.7</version>
 </dependency>

代码：

import com.jcraft.jsch.*;
    
    import java.io.InputStream;
    import java.io.OutputStream;
    import java.util.Properties;
    
    public class FtpJSch {
    
        private static ChannelSftp sftp = null;
        private static Session sshSession = null;
        private static Channel channel = null;
    
    
        public static FtpJSch getConnect(String host, String port, String userName, String password)
                throws JSchException {
            FtpJSch ftp = new FtpJSch();
            JSch jsch = new JSch();
    
            //获取sshSession  账号-ip-端口
            sshSession = jsch.getSession(userName, host, Integer.parseInt(port));
            //添加密码
            sshSession.setPassword(password);
            Properties sshConfig = new Properties();
            //严格主机密钥检查
            sshConfig.put("StrictHostKeyChecking", "no");
    
            sshSession.setConfig(sshConfig);
            //开启sshSession链接
            sshSession.connect();
            //获取sftp通道
            channel = sshSession.openChannel("sftp");
            //开启
            channel.connect();
    
            sftp = (ChannelSftp) channel;
            return ftp;
        }
    
        /**
         * @param in        输入流
         * @param directory 上传文件的路径
         * @return fileName 服务器上文件名
         */
        public void upload(InputStream in, String directory, String fileName) throws SftpException {
            sftp.cd(directory);
            sftp.put(in, fileName);
        }
    
        /**
         * @param directory 上传文件的路径
         * @return fileName 服务器上文件名
         */
        public OutputStream upload(String directory, String fileName) throws SftpException {
            sftp.cd(directory);
            return sftp.put(fileName);
        }
    
        /**
         * 下载文件
         *
         * @param directory        要下載的文件路徑
         * @param downloadFileName 下载的文件名
         * @param os               下载文件输出
         */
        public void download(String directory, String downloadFileName, OutputStream os) throws
                SftpException {
    
            sftp.cd(directory);
            sftp.get(downloadFileName, os);
    
        }
    
        /***
         * 下载到本地服务器
         * 2018年5月9日
         * directory: 指定目录
         * downloadFileName ：文件名称
         * dest： 本地目录
         */
    
        public void download(String directory, String downloadFileName, String dest) throws
                SftpException {
    
            sftp.cd(directory);
            sftp.get(directory + downloadFileName, dest);
    
        }
    
        public void close() {
            if (sftp != null) {
                sftp.disconnect();
            }
            if (channel != null) {
                channel.disconnect();
            }
            if (sshSession != null) {
                sshSession.disconnect();
            }
        }
    }

1、JSch中文乱码处理  
     使用jsch-0.1.51进行SFTP文件传输时，对中文处理会出现乱码，并且也无法通过setFileNameEncoding()方法来设置编码。  
     解决方案：  
         下载jsch-0.1.51源代码，在ChannelSFTP.java文件中找到SENDINIT( )方法，修改红色部分的内容  
           private void sendINIT() throws Exception \{  
    this.packet.reset();  
    putHEAD((byte)1, 5);  
    this.buf.putInt(3);   //修改为  this.buf.putInt(2);  
    getSession().write(this.packet, this, 9);  
  \}  
   
然后编译并更改jar中的对应class文件即可。

2、ChannelSftp类的主要API说明如下：

<table style="background:#FFFFFF;"> 
 <tbody> 
 <tr> 
 <td>方法名</td> 
 <td>方法说明</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(String src, String dst)</td> 
 <td>将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。采用默认的传输模式：OVERWRITE</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(String src, String dst, int mode)</td> 
 <td>将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。指定文件传输模式为mode（mode可选值为：ChannelSftp.OVERWRITE，ChannelSftp.RESUME，ChannelSftp.APPEND）。</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(String src, String dst, SftpProgressMonitor monitor)</td> 
 <td>将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。采用默认的传输模式：OVERWRITE，并使用实现了SftpProgressMonitor接口的monitor对象来监控文件传输的进度。</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(String src, String dst,SftpProgressMonitor monitor, int mode)&nbsp;</td> 
 <td>将本地文件名为src的文件上传到目标服务器，目标文件名为dst，若dst为目录，则目标文件名将与src文件名相同。指定传输模式为mode,并使用实现了SftpProgressMonitor接口的monitor对象来监控文件传输的进度。</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(InputStream src, String dst)</td> 
 <td>将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE</td> 
 <td colspan="2">&nbsp;</td> 
 </tr> 
 <tr> 
 <td>public void put(InputStream src, String dst, int mode)</td> 
 <td>将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode</td> 
 </tr> 
 <tr> 
 <td>public void put(InputStream src, String dst, SftpProgressMonitor monitor)</td> 
 <td>将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE。并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。</td> 
 </tr> 
 <tr> 
 <td>public void put(InputStream src, String dst,SftpProgressMonitor monitor, int mode)&nbsp;</td> 
 <td>将本地的input stream对象src上传到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode。并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。</td> 
 </tr> 
 <tr> 
 <td>public OutputStream put(String dst)</td> 
 <td>该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。采用默认的传输模式：OVERWRITE</td> 
 </tr> 
 <tr> 
 <td>public OutputStream put(String dst, final int mode)</td> 
 <td>该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode</td> 
 </tr> 
 <tr> 
 <td>public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode)&nbsp;</td> 
 <td>该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode。并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。</td> 
 </tr> 
 <tr> 
 <td>public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode, long offset)</td> 
 <td>该方法返回一个输出流，可以向该输出流中写入数据，最终将数据传输到目标服务器，目标文件名为dst，dst不能为目录。指定文件传输模式为mode。并使用实现了SftpProgressMonitor接口的monitor对象来监控传输的进度。offset指定了一个偏移量，从输出流偏移offset开始写入数据。</td> 
 </tr> 
 <tr> 
 <td>get(String src, String dst)</td> 
 <td>下载文件到本地，src为目标服务器上的文件，不能为目录，dst为本地文件路径。若dst为目录，则本地文件名与目标服务器上的文件名一样。</td> 
 </tr> 
 <tr> 
 <td>get(String src, String dst ,SftpProgressMonitor monitor)</td> 
 <td>同get(String src, String dst)，只是该方法允许传入传输进度的监控对象monitor。</td> 
 </tr> 
 <tr> 
 <td>get(String src, String dst ,SftpProgressMonitor monitor ,int mode)</td> 
 <td>同get(String src, String dst ,SftpProgressMonitor monitor)，同时，该方法增加了mode参数，允许指定文件传输模式</td> 
 </tr> 
 <tr> 
 <td>rm(String path)</td> 
 <td>删除文件，path不能为目录，删除目录使用rmdir</td> 
 </tr> 
 <tr> 
 <td>rmdir(String path)</td> 
 <td>删除目录，但是只能删除空目录</td> 
 </tr> 
 <tr> 
 <td>rename(String oldpath, String newpath)</td> 
 <td>如果oldPath为目录，不要求目录必须为空 如果newpath为目录，则newpath必须不能存在，如果已经存在该目录，则会出现重名或者移动失败 1、重命名文件或者目录 2、移动文件或者目录</td> 
 </tr> 
 <tr> 
 <td>ls(String path)</td> 
 <td>列出指定目录下的所有文件和子目录。该方法返回Vector对象，该列表具体存放的是LsEntry对象</td> 
 </tr> 
 </tbody> 
</table>