.net 操作sftp服务器

因为项目的需要，整理了一段C#操作sftp的方法。

依赖的第三方类库名称为：SharpSSH 1.1.1.13.

代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Collections.Specialized;
using System.Configuration;
using Tamir.SharpSsh;
using System.IO;
using Tamir.SharpSsh.jsch;

namespace CET.Finance.SftpWinService.Common
{
    /// <summary>
    /// 访问Sftp服务器方法(凭证请在config文件中配置)
    /// </summary>
    public class SftpClient : IDisposable
    {
        #region Properties

        /// <summary>
        /// 主机名或IP
        /// </summary>
        public string HostName { get; private set; }
        /// <summary>
        /// 用户名
        /// </summary>
        public string UserName { get; private set; }
        /// <summary>
        /// 密码
        /// </summary>
        public string Password { get; private set; }

        /// <summary>
        /// 端口号(默认端口为22)
        /// </summary>
        public int Port { get; private set; }

        #endregion

        private static readonly string defRemotePath = "/";//默认操作是都是从根目录开始。
        private ChannelSftp m_sftp;
        private Session m_session;
        Channel m_channel;

        /// <summary>
        /// 从配置文件中加载凭证信息
        /// </summary>
        public SftpClient()
        {
            var config = ConfigurationManager.GetSection("SftpServer") as NameValueCollection;
            this.HostName = config["host_name"];
            this.UserName = config["user_name"];
            this.Password = config["password"];
            this.Port = Convert.ToInt32(config["port"] ?? "22");//默认端口为22
            this.ConnectSftp();
        }

        #region Events

        /// <summary>
        /// SFTP获取文件
        /// </summary>
        /// <param name="remotePath"></param>
        /// <param name="localPath"></param>
        /// <returns></returns>

        public bool Get(string remotePath, string localPath)
        {
            try
            {
                string fullRemotePath = defRemotePath + remotePath.TrimStart('/');
                Tamir.SharpSsh.java.String src = new Tamir.SharpSsh.java.String(fullRemotePath);
                Tamir.SharpSsh.java.String dst = new Tamir.SharpSsh.java.String(localPath);
                m_sftp.get(src, dst);
                return true;
            }
            catch
            {
                return false;
            }
        }

        /// <summary>
        ///SFTP存放文件
        /// </summary>
        /// <param name="localPath"></param>
        /// <param name="remotePath"></param>
        /// <returns></returns>
        public void Put(string localPath, string remotePath)
        {
            Tamir.SharpSsh.java.String src = new Tamir.SharpSsh.java.String(localPath);
            string fullRemotePath = defRemotePath + remotePath.TrimStart('/');
            Tamir.SharpSsh.java.String dst = new Tamir.SharpSsh.java.String(fullRemotePath);
            m_sftp.put(src, dst);
        }


        /// <summary>
        /// 删除SFTP文件
        /// </summary>
        /// <param name="remoteFile"></param>
        /// <returns></returns>

        public void Delete(string remoteFile)
        {
            string fullRemotePath = defRemotePath + remoteFile.TrimStart('/');
            m_sftp.rm(fullRemotePath);
        }
        /// <summary>
        /// 获取SFTP文件列表
        /// </summary>
        /// <param name="remotePath"></param>
        /// <param name="fileType">文件后缀名称(.txt)</param>
        /// <returns></returns>
        public List<string> GetFileList(string remotePath, string fileType)
        {
            List<string> objList = new List<string>();
            string fullRemotePath = defRemotePath + remotePath.TrimStart('/');
            if (DirExist(fullRemotePath))
            {
                Tamir.SharpSsh.java.util.Vector vvv = m_sftp.ls(fullRemotePath);
                foreach (Tamir.SharpSsh.jsch.ChannelSftp.LsEntry qqq in vvv)
                {
                    string sss = qqq.getFilename();
                    if (fileType.Contains(Path.GetExtension(sss)))
                    {
                        objList.Add(sss);
                    }
                }
            }
            return objList;
        }

        /// <summary>
        /// 目录是否存在
        /// </summary>
        /// <param name="dirName">目录名称必须从根开始</param>
        /// <returns></returns>
        public bool DirExist(string dirName)
        {
            try
            {
                m_sftp.ls(defRemotePath + dirName.TrimStart('/'));
                return true;
            }
            catch (Tamir.SharpSsh.jsch.SftpException)
            {
                return false;//执行ls命令时出错，则目录不存在。
            }
        }

        /// <summary>
        /// 创建目录
        /// </summary>
        /// <param name="dirName">目录名称必须从根开始</param>
        /// <returns></returns>
        public void Mkdir(string dirName)
        {
            Tamir.SharpSsh.java.util.Vector vvv = m_sftp.ls(defRemotePath);
            foreach (Tamir.SharpSsh.jsch.ChannelSftp.LsEntry fileName in vvv)
            {
                string name = fileName.getFilename();
                if (name == dirName)
                {
                    throw new Exception("dir is exist");
                }
            }
            m_sftp.mkdir(defRemotePath + dirName.TrimStart('/'));
        }

        /// <summary>
        /// 连接SFTP
        /// </summary>
        public void ConnectSftp()
        {
            JSch jsch = new JSch();   //利用java实现的通讯包
            m_session = jsch.getSession(this.UserName, this.HostName, this.Port);
            m_session.setHost(this.HostName);
            MyUserInfo ui = new MyUserInfo();
            ui.setPassword(this.Password);
            m_session.setUserInfo(ui);

            if (!m_session.isConnected())
            {
                m_session.connect();
                m_channel = m_session.openChannel("sftp");
                m_channel.connect();
                m_sftp = (ChannelSftp)m_channel;
            }
        }

        /// <summary>
        /// 断开SFTP
        /// </summary>
        public void DisconnectSftp()
        {
            if (m_session.isConnected())
            {
                m_channel.disconnect();
                m_session.disconnect();
            }
        }

        #endregion

        //登录验证信息
        private class MyUserInfo : UserInfo
        {
            String passwd;
            public String getPassword() { return passwd; }
            public void setPassword(String passwd) { this.passwd = passwd; }

            public String getPassphrase() { return null; }
            public bool promptPassphrase(String message) { return true; }

            public bool promptPassword(String message) { return true; }
            public bool promptYesNo(String message) { return true; }
            public void showMessage(String message) { }
        }

        public void Dispose()
        {
            this.DisconnectSftp();
            this.m_channel = null;
            this.m_session = null;
            this.m_sftp = null;
        }
    }

}

配置文件内容：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="SftpServer" type="System.Configuration.NameValueSectionHandler"/>
  </configSections>

  <SftpServer>
    <add key="host_name" value="127.0.0.1"/>
    <add key="user_name" value="test"/>
    <add key="password" value="123"/>
  </SftpServer>

</configuration>