SSH2纯Java实现—JSch介绍和使用

介绍：

JSch 是SSH2的一个纯Java实现。它允许你连接到一个sshd 服务器，使用端口转发，X11转发，文件传输等等。你可以将它的功能集成到你自己的 程序中。同时该项目也提供一个J2ME版本用来在手机上直连SSHD服务器。

 

使用：

pom.xml文件引入相关依赖

<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.6</version>
</dependency>
<dependency>
    <groupId>com.jcraft</groupId>
    <artifactId>jsch</artifactId>
    <version>0.1.55</version>
</dependency>

代码实现

package cn.zxj.gkxt.core.util;


import com.jcraft.jsch.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.*;


/**
* JSch(Java Secure Channel)
* SSH2纯Java实现
* 连接至SSH服务器
*/
public class JschUtils {
    private static final Logger LOG = LoggerFactory.getLogger(JschUtils.class.getName());


    /**
     * main方法
     * 本地开发
     * @param args 输入参数
     */
    public static void main(String[] args) {
        String userName = System.getProperty("user.name");

        ChannelSftp sftp = connect("10.194.61.92", 22, "tomcat", "Gzyqzxj092@tomcatlinserver");

        
        // 上传文件至SFTP指定目录
        if (1 == 1) {
            upload("/home/tomcat/gkxt/static/sftpLibrary", "C:\\Users\\" + userName + "\\Documents\\demo.jpg", sftp);
        }
    }


    /**
     * 连接SFTP服务器
     * @param host 主机
     * @param port 端口
     * @param username 用户名
     * @param password 密码
     * @return ChannelSftp
     */
    public static ChannelSftp connect(String host, int port, String username,
                                      String password) {
        ChannelSftp sftp = null;


        try {
            // 初始化JCsh对象
            JSch jsch = new JSch();
            // 由用户名 | 主机ip | 端口号获取单个Session对象
            Session sshSession = jsch.getSession(username, host, port);
            LOG.info("Session created.");


            // 设置登录密码
            sshSession.setPassword(password);


            // 初始化Properties对象
            Properties sshConfig = new Properties();
            sshConfig.put("StrictHostKeyChecking", "no");


            // 为Session对象设置properties
            sshSession.setConfig(sshConfig);
            // 设置timeout
            sshSession.setTimeout(5000);
            sshSession.connect();
            LOG.info("Session connected.");
            LOG.info("Opening Channel.");


            // 指定获取Channel连接方式
            Channel channel = sshSession.openChannel("sftp");
            channel.connect();
            sftp = (ChannelSftp) channel;
            LOG.info("Connected to " + host + ".");
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
        return sftp;
    }


    /**
     * 上传文件
     * @param directory 上传的目录
     * @param uploadFile 要上传的文件
     * @param sftp ChannelSftp
     */
    public static void upload(String directory, String uploadFile, ChannelSftp sftp) {
        mkDir(directory, sftp);
        InputStream in = null;
        try {
            sftp.cd(directory);
            File file = new File(uploadFile);
            in = new FileInputStream(file);
            sftp.put(new FileInputStream(file), file.getName());
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                assert in != null;
                in.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }


    /**
     * 下载文件
     * @param directory 目录
     * @param downloadFile 下载的文件
     * @param sftp ChannelSftp
     */
    public static InputStream download(String directory, String downloadFile,
                                       ChannelSftp sftp) {
        InputStream in = null;
        try {
            sftp.cd(directory);
            in = sftp.get(downloadFile);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
        return in;
    }


    /**
     * 删除文件
     * @param directory 文件所在目录
     * @param deleteFile 要删除的文件
     * @param sftp ChannelSftp
     */
    public static void delete(String directory, String deleteFile, ChannelSftp sftp) {
        try {
            sftp.cd(directory);
            sftp.rm(deleteFile);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }


    /**
     * 列出目录下的文件
     * @param directory 要列出的目录
     * @param sftp ChannelSftp
     * @return Vector(动态数组)
     * @throws SftpException Sftp异常
     */
    public static Vector listFiles(String directory, ChannelSftp sftp) throws SftpException {
        return sftp.ls(directory);
    }



    /**
     * 获取目录名称
     * @param ls 目录数组
     * @return 目录名称集合
     */
    public static List<String> buildFiles(Vector ls) {
        if (ls != null) {
            List<String> list = new ArrayList<>();
            for (Object l : ls) {
                ChannelSftp.LsEntry f = (ChannelSftp.LsEntry) l;
                String nm = f.getFilename();
                if (".".equals(nm) || "..".equals(nm)) {
                    continue;
                }
                list.add(nm);
            }


            return list;
        }


        return null;
    }


    /**
     * 打开指定目录
     * @param directory 目录
     * @return boolean
     */
    public static boolean openDir(String directory, ChannelSftp sftp) {
        try {
            sftp.cd(directory);
            return true;
        } catch (SftpException e) {
            return false;
        }
    }


    /**
     * 按指定路径创建文件夹
     * @param dirName 文件夹路径
     * @param sftp ChannelSftp
     */
    public static void mkDir(String dirName, ChannelSftp sftp) {
        String[] dirs = dirName.split("/");
        try {
            String now = sftp.pwd();
            sftp.cd("/");
            for (String dir : dirs) {
                if (StringUtils.isNotEmpty(dir)) {
                    boolean dirExists = openDir(dir, sftp);
                    if (!dirExists) {
                        sftp.mkdir(dir);
                        sftp.cd(dir);
                    }
                }
            }
            sftp.cd(now);
        } catch (SftpException e) {
            e.printStackTrace();
        }
    }
}