Java SFTP

发表于 分类于 ， 阅读次数： 阅读次数： 145 评论数：
本文字数： 7.5k 阅读时长 ≈ 7 分钟

SFTP

SFTP是Secure File Transfer Protocol的缩写，安全文件传送协议。SFTP为SSH的一部份，是一种传输文件到服务器的安全加密的方式。

JSch

JSch是ssh的Java实现，从官网http://www.jcraft.com/jsch/ 下载jar包（jsch-0.1.55.jar），加入项目即可。

使用JSch连接SFTP

使用JSch连接SFTP服务器操作的步骤大致为：

  1. 使用ip、port、username、password等信息连接sftp，获取Session
  2. Session可以设置一系列属性，如超时时间等，通过Session建立链接
  3. Session建立连接后，打开SFTP通道Channel
  4. Channel连接之后便形成可用的ChannelSftp
  5. JSch封装了常用指令，如：sftp.put()、sftp.cd()、sftp.get()、sftp.ls()，可以进行操作
  6. 操作完成后，要关闭通道Channel和Session。

源码

  1. import com.jcraft.jsch.Channel;
  2. import com.jcraft.jsch.ChannelSftp;
  3. import com.jcraft.jsch.ChannelSftp.LsEntry;
  4. import com.jcraft.jsch.JSch;
  5. import com.jcraft.jsch.JSchException;
  6. import com.jcraft.jsch.Session;
  7. import com.jcraft.jsch.SftpException;
  9. import org.slf4j.Logger;
  10. import org.slf4j.LoggerFactory;
  12. import java.io.File;
  13. import java.io.FileInputStream;
  14. import java.io.FileOutputStream;
  15. import java.io.IOException;
  16. import java.util.Properties;
  17. import java.util.Vector;
  19. /**
  20.  * SFTP Utils
  21.  *
  22.  */
  23. public class SFTPUtils {
  24.     private static final Logger logger = LoggerFactory.getLogger(SFTPUtils.class);
  25.     private static int TIMEOUT = 60000; // 超时数为一分钟，默认是0，表示没有超时数，单位毫秒
  27.     private ChannelSftp sftp;
  29.     public static SFTPUtils getInstance(String host, int port, String username, String password) {
  30.         SFTPUtils instance = new SFTPUtils(host, port, username, password);
  31.         return instance;
  32.     }
  34.     private SFTPUtils(String host, int port, String username, String password) {
  35.         sftp = connect(host, port, username, password); // 获取连接
  36.     }
  38.     /**
  39.      * 连接sftp服务器,创建一个sftp通道对象，通过这 个对象可以直接发送文件。
  40.      *
  41.      * @param host
  42.      *            主机
  43.      * @param port
  44.      *            端口
  45.      * @param username
  46.      *            用户名
  47.      * @param password
  48.      *            密码
  49.      * @return
  50.      */
  51.     public ChannelSftp connect(String host, int port, String username, String password) {
  52.         ChannelSftp sftp = null;
  53.         try {
  54.             JSch jsch = new JSch();
  56.             Session sshSession = jsch.getSession(username, host, port);
  57.             sshSession.setPassword(password);
  58.             Properties sshConfig = new Properties();
  59.             sshConfig.put("StrictHostKeyChecking", "no");
  60.             sshSession.setConfig(sshConfig); // 为Session对象设置properties
  61.             sshSession.setTimeout(TIMEOUT); // 设置timeout时间
  62.             sshSession.connect(); // 通过Session建立链接
  63.             logger.info("SFTP Session connected.");
  65.             Channel channel = sshSession.openChannel("sftp"); // 打开SFTP通道
  66.             channel.connect(); // 建立SFTP通道的连接
  67.             sftp = (ChannelSftp) channel;
  68.             logger.info("Connected to " + host);
  69.         } catch (Exception e) {
  70.             logger.error(e.getMessage(), e);
  71.         }
  72.         return sftp;
  73.     }
  75.     /**
  76.      * 上传文件
  77.      *
  78.      * @param directory
  79.      *            上传的目录
  80.      * @param uploadFile
  81.      *            要上传的文件全路径
  82.      */
  83.     public boolean upload(String targetDirectory, String uploadFile) {
  84.         try {
  85.             Vector dir = sftp.ls(targetDirectory);
  86.             if (dir == null) { // 如果路径不存在，则创建
  87.                 sftp.mkdir(targetDirectory);
  88.             }
  90.             sftp.cd(targetDirectory);
  91.             File file = new File(uploadFile);
  92.             FileInputStream fileInputStream = new FileInputStream(file);
  93.             sftp.put(fileInputStream, file.getName());
  94.             fileInputStream.close();
  95.             return true;
  96.         } catch (Exception e) {
  97.             logger.error(e.getMessage(), e);
  98.             return false;
  99.         }
  100.     }
  102.     /**
  103.      * 下载文件
  104.      *
  105.      * @param directory
  106.      *            下载目录
  107.      * @param downloadFile
  108.      *            下载文件名
  109.      * @param saveFile
  110.      *            存在本地的文件全路径
  111.      */
  112.     public File downloadToFile(String directory, String downloadFile, String saveFile) {
  113.         try {
  114.             sftp.cd(directory);
  115.             File file = new File(saveFile);
  116.             FileOutputStream fileOutputStream = new FileOutputStream(file);
  117.             sftp.get(downloadFile, fileOutputStream);
  118.             fileOutputStream.close();
  119.             return file;
  120.         } catch (Exception e) {
  121.             logger.error(e.getMessage(), e);
  122.             return null;
  123.         }
  124.     }
  126.     /**
  127.      * 
  128.      * @param directory
  129.      *            下载目录
  130.      * @param downloadFile
  131.      *            下载文件名
  132.      * @param saveFilePath
  133.      *            存在本地的路径
  134.      * @return
  135.      */
  136.     public File downloadToDirectory(String directory, String downloadFile, String saveFilePath) {
  137.         try {
  138.             sftp.cd(directory);
  139.             File file = new File(saveFilePath + File.separator + downloadFile);
  140.             FileOutputStream fileOutputStream = new FileOutputStream(file);
  141.             sftp.get(downloadFile, fileOutputStream);
  142.             fileOutputStream.close();
  143.             return file;
  144.         } catch (Exception e) {
  145.             logger.error(e.getMessage(), e);
  146.             return null;
  147.         }
  148.     }
  150.     /**
  151.      * 下载文件
  152.      *
  153.      * @param downloadFilePath
  154.      *            下载的文件完整目录
  155.      * @param saveFile
  156.      *            存在本地的路径
  157.      */
  158.     public File download(String downloadFilePath, String saveFile) {
  159.         try {
  160.             int i = downloadFilePath.lastIndexOf('/');
  161.             if (i == -1)
  162.                 return null;
  163.             sftp.cd(downloadFilePath.substring(0, i));
  164.             File file = new File(saveFile);
  165.             FileOutputStream fileOutputStream = new FileOutputStream(file);
  166.             sftp.get(downloadFilePath.substring(i + 1), fileOutputStream);
  167.             fileOutputStream.close();
  168.             return file;
  169.         } catch (Exception e) {
  170.             logger.error(e.getMessage(), e);
  171.             return null;
  172.         }
  173.     }
  175.     /**
  176.      * 关闭会话和通道
  177.      */
  178.     public void disconnect() {
  179.         try {
  180.             sftp.getSession().disconnect();
  181.         } catch (JSchException e) {
  182.             logger.error(e.getMessage(), e);
  183.         }
  184.         sftp.quit();
  185.         sftp.disconnect();
  186.     }
  188.     /**
  189.      * 列出目录下的文件
  190.      *
  191.      * @param directory
  192.      *            要列出的目录
  193.      * @throws SftpException
  194.      */
  195.     public Vector<LsEntry> listFiles(String directory) throws SftpException {
  196.         return sftp.ls(directory);
  197.     }
  199.     public static void main(String[] args) throws IOException {
  200.         Logger logger = LoggerFactory.getLogger(SFTPUtils.class);
  202.         String host = "zhangzhiqiang.net";
  203.         int port = 22;
  204.         String username = "silent";
  205.         String password = "Citic123!";
  207.         // 服务器端可供操作的目录
  208.         String serverDirectory = "/upload";
  210.         SFTPUtils sf = null;
  211.         try {
  212.             sf = SFTPUtils.getInstance(host, port, username, password);
  214.             sf.upload(serverDirectory, "C:\\Users\\waiti\\Desktop\\b.xls"); // 上传文件
  215.             sf.downloadToFile(serverDirectory, "b.java", "C:\\Users\\waiti\\Desktop\\b3.java");
  216.             sf.downloadToDirectory(serverDirectory, "b.java", "C:\\Users\\waiti\\Desktop");
  218.             Vector<LsEntry> files = sf.listFiles(serverDirectory); // 查看文件列表
  219.             if (files != null) {
  220.                 for (LsEntry file : files) {
  221.                     System.out.println(file.getFilename());
  222.                 }
  223.             }
  224.         } catch (SftpException e) {
  225.             logger.error("SFTP Error!", e);
  226.         } finally {
  227.             if (sf != null) {
  228.                 sf.disconnect();
  229.             }
  230.         }
  231.     }
  232. }
欣赏此文？求鼓励，求支持！您的支持就是支持我更新的最大动力！
表情 | 预览
Powered By Valine
v1.3.10