sftp使用方法

谁践踏了优雅 2023-09-27 20:51 120阅读 0赞

要谈 `sftp`（ `SSH File Transfer Protocol`），首先要谈 `ftp`（ `File Transfer Protocol`），大家都知道ftp是文件传输协议，它基于 `tcp`协议，可以用来发送文件。刚开始学web开发的时候，接触到一些免费的云空间，当时就是用的一个 `ftp`工具把项目传上去的。

定义：

sftp是Secure File Transfer Protocol的缩写，安全[文件传送协议][Link 1]。可以为传输文件提供一种安全的网络的加密方法。sftp 与 ftp 有着几乎一样的语法和功能。SFTP 为 [SSH][]的其中一部分，是一种传输档案至 Blogger 伺服器的安全方式。其实在SSH软件包中，已经包含了一个叫作SFTP(Secure File Transfer Protocol)的安全文件信息传输子系统，SFTP本身没有单独的[守护进程][Link 2]，它必须使用sshd守护进程（[端口][Link 3]号默认是22）来完成相应的连接和答复操作，所以从某种意义上来说，SFTP并不像一个[服务器][Link 4]程序，而更像是一个客户端程序。SFTP同样是使用加密传输认证信息和传输的数据，所以，使用SFTP是非常安全的。但是，由于这种传输方式使用了加密/[解密技术][Link 5]，所以[传输效率][Link 6]比普通的[FTP][]要低得多，如果您对[网络安全][Link 7]性要求更高时，可以使用SFTP代替FTP。

连接方法

windows中可以使用Core FTP，FileZilla, WinSCP， [Xftp][]来连接SFTP进行上传，下载文件，建立，删除目录等操作。

linux下直接在终端中输入：sftp username@remote ip(or remote host name)。出现验证时，只需填入正确的密码即可实现远程链接。登入成功后终端呈现出:sftp>….

在sftp的环境下的操作就和一般ftp的操作类似了，ls,rm,mkdir,dir,pwd,等指令都是对远端进行操作，如果要对本地操作，只需在上述的指令上加‘l’变为：lls,lcd, lpwd等。当然既然是ftp，当然得说它的上传和下载咯！

上传：put /path/filename(本地主机) /path/filename(远端主机)；

下载：get /path/filename(远端主机) /path/filename( 本地主机)。

另外提一下sftp在非正规端口（正规的是22号端口）登录：sftp -o port=1000 username@remote ip.

需要**注意**的是，用那个用户登陆就会登陆到那个用户的目录下，如用root登陆就是在/root 下，需要到哪个目录切换目录即可。比如要切换到 /home/wwwroot/lnmp.org 的网站目录下，直接在远程那边输入/home/wwwroot/lnmp.org 回车就切换过去了。

**注意**上传的文件的属主会设置为sftp登陆用户，如果要更改为www用户的话，需要在ssh里执行：chown www:www -R 网站目录 来更改属主和属组。

jsch简介

`jsch`是ssh的纯java实现。这么讲有点抽象，通俗说，你在[官网上][Link 8]down下来就是一个jar包，引入你的项目，就可以用来给一个同样开启了ssh服务的[服务器][Link 9]安全的传文件了（当然，你需要那台目标服务器的一些用户名和密码信息，不然就gg了）。

开始使用

*  第一步：首先在maven中央仓库中查一下怎么在pom中依赖，可以点[这里][Link 10]。

> tip: 如果你用的是`Gradle`等其它构建工具，就用其他方式依赖进项目。如果没用构件工具，直接把jar包添加到项目里吧。

maven的是这个(我用的是当前最新版本0.1.54)：

<dependency>
        <groupId>com.jcraft</groupId>
        <artifactId>jsch</artifactId>
        <version>0.1.54</version>
    </dependency>

复制

加到pom文件中就可以进行下一步了。

*  第二步：创建一个工具类：SFTPUtils.java， 内容如下
 *  import com.jcraft.jsch.\*;

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    import java.util.Properties;
    
    /**
     * SFTP工具类
     * 包含两个方法：
     * 一个创建一个sftp通道对象，并返回这个对象，通过这 个对象可以直接发送文件。
     * 另一个是用于关闭回话和通道的。
     */
    public class SFTPUtils {
      static private final Logger log = LoggerFactory.getLogger(SFTPUtils.class);
    
      static private Session session = null;
      static private Channel channel = null;
      static private int timeout = 60000; //超时数,一分钟
    
      /**
       * 传入一个通道对象
       * @param username 远程要连接的服务器的用户名
       * @param password 远程要连接的服务器的密码
       * @param ip 远程服务器ip
       * @param port 远程服务器的ssh服务端口
       * @return ChannelSftp返回指向这个通道指定的地址的channel实例
       * @throws JSchException
       */
      public static ChannelSftp getChannel(String username, String password, String ip, String port) throws JSchException {
        JSch jsch = new JSch(); // 创建JSch对象
        // 根据用户名，主机ip，端口获取一个Session对象
        session = jsch.getSession(username, ip, Integer.valueOf(aisle.getServerPort()));
        log.info("Session created...");
        if (password != null) {
          session.setPassword(password); // 设置密码
        }
        Properties config = new Properties();
        config.put("StrictHostKeyChecking", "no");
        session.setConfig(config); // 为Session对象设置properties
        session.setTimeout(timeout); // 设置timeout时间
        session.connect(); // 通过Session建立链接
        log.info("Session connected, Opening Channel...");
        channel = session.openChannel("sftp"); // 打开SFTP通道
        channel.connect(); // 建立SFTP通道的连接
        log.info("Connected successfully to ip :{}, ftpUsername is :{}, return :{}",
            ip,username, channel);
        return (ChannelSftp) channel;
      }
    
      /**
       * 关闭channel和session
       * @throws Exception
       */
      public static void closeChannel() throws Exception {
        if (channel != null) {
          channel.disconnect();
        }
        if (session != null) {
          session.disconnect();
        }
      }
    }

复制

*  第三步：工具类都建好了，就直接用吧——创建测试类。

import com.gildata.gup.util.SFTPUtils;
    import com.jcraft.jsch.ChannelSftp;
    import com.jcraft.jsch.JSchException;
    import com.jcraft.jsch.SftpException;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    import java.io.File;
    import java.io.FileInputStream;
    import java.util.Vector;
    /**
    * sftp推送测试类
    */
    @Service
    public class SftpTest {
    private final Logger log = LoggerFactory.getLogger(SftpPushTest.class);
    /**
    * 文件推送的测试方法。
    * destDirPath 远程服务器要保存的文件夹路径
    * file  本地要推送的文件对象
    * username 远程服务器的用户名
    * password  远程服务器的密码
    * ip  远程服务器ip
    * port 远程服务器ssh服务端口
    */
    public void testSftp() throws SftpException {
    // 假设参数值
    String dstDirPath = "E:\\target";
    String username = "admin";
    String password = "admin";
    String ip = "127.0.0.1"; 
    String port = 21; 
    ChannelSftp channelSftp = null;
    String dstFilePath; // 目标文件名(带路径)，如： D:\\file\\file.doc,这个路径应该是远程目标服务器下要保存的路径
    try {
    // 一、 获取channelSftp对象
    channelSftp = SFTPUtils.getChannel(username, password, ip, port);
    // 二、 判断远程路径dstDirPath是否存在(通道配置的路径)
    try {
    Vector dir = channelSftp.ls(dstDirPath);
    if (dir == null) { // 如果路径不存在，则创建
    channelSftp.mkdir(dstDirPath);
    }
    } catch (SftpException e) { // 如果dstDirPath不存在，则会报错，此时捕获异常并创建dstDirPath路径
    channelSftp.mkdir(dstDirPath); // 此时创建路o如果再报错，即创建失败，则抛出异常
    e.printStackTrace();
    }
    // 三、 推送文件
    try {
    log.info("send the file : {}", file.getName());
    dstFilePath = dstDirPath + "\\" + file.getName();
    log.info("the file all path is :{}", dstFilePath);
    // 推送: dstFilePath——传送过去的文件路径(全路径),采用默认的覆盖式推送
    channelSftp.put(new FileInputStream(file), dstFilePath); // jsch触发推送操作的方法
    }  catch (SftpException e) {
    log.debug("An error occurred during sftp push, send data fail, the target path is :{}", dstDirPath);
    if (log.isDebugEnabled()) {
    e.printStackTrace();
    }
    }
    }  finally {
    // 处理后事
    if (channelSftp != null)
    channelSftp.quit();
    try {
    SFTPUtils.closeChannel();
    } catch (Exception e) {
    if (log.isDebugEnabled())
    e.printStackTrace();
    }
    }
    }
    }

复制

执行`testSftp`方法，就可以把file文件传到目标服务器的dstDirPath目录下了。

假设file文件在本地的路径为： `D:\\source\\sftp_learning.ppt`。而目标路径dstDirPath为： `E:\\target`，那么执行推送后，将会在ip为`ip`的远程设备下的`E:\\target`目录下找到`sftp_learning.ppt`文件。

问题？！

不过遗憾的是，window并不像linux一样自带了ssh服务。像上面的`E:\\target`这样的目录显然表明了这个远程设备是window系统。正常开发中，即使你的用户名、 密码、 端口都没有输错，程序也将会抛SftpException异常，那是因为你得目标服务器没有启用ssh服务。

怎么解决呢？

既然目标服务器是没有自带ssh服务的window，那就想办法在window下配置ssh服务咯。

一般而言，服务器通常跑在linux下，所以不用担心这个问题。笔者这次也是因为想在自己的window下本地测试一下，所以遇到了这个问题。如何在window下配置ssh服务，这又是另一个话题了。这次测试中，我用的是`Cygwin`工具。具体怎么使用，网上一搜一大把。如果读着支持笔者，就请关注我吧，我会尽快把`Cygwin`的使用心得分享给大家的！

[Link 1]: https://baike.baidu.com/item/%E6%96%87%E4%BB%B6%E4%BC%A0%E9%80%81%E5%8D%8F%E8%AE%AE
[SSH]: https://baike.baidu.com/item/SSH/10407
[Link 2]: https://baike.baidu.com/item/%E5%AE%88%E6%8A%A4%E8%BF%9B%E7%A8%8B/966835
[Link 3]: https://baike.baidu.com/item/%E7%AB%AF%E5%8F%A3
[Link 4]: https://baike.baidu.com/item/%E6%9C%8D%E5%8A%A1%E5%99%A8
[Link 5]: https://baike.baidu.com/item/%E8%A7%A3%E5%AF%86%E6%8A%80%E6%9C%AF/10808578
[Link 6]: https://baike.baidu.com/item/%E4%BC%A0%E8%BE%93%E6%95%88%E7%8E%87/7856651
[FTP]: https://baike.baidu.com/item/FTP/13839
[Link 7]: https://cloud.tencent.com/product/ns?from=20065&from_column=20065
[Xftp]: https://baike.baidu.com/item/Xftp
[Link 8]: https://link.jianshu.com/?t=http://www.jcraft.com/jsch/
[Link 9]: https://cloud.tencent.com/product/cvm?from=20065&from_column=20065
[Link 10]: https://link.jianshu.com/?t=http://www.mvnrepository.com/artifact/com.jcraft/jsch