前言

最近在开发订单对账系统,先从各种支付平台获取订单销售数据,然后与公司商城订单数据进行对账兜底。总体上,各个支付平台提供数据的方式分为两类,一般以接口的方式提供实时数据,比如:webservice、NVP、restfull api,以文件服务的方式提供周期性数据,比如:SFTP。接口的方式比较简单,随便一个HTTP客户端库都能搞定,而SFTP文件下载服务就不一样了,至少需要满足三个条件,不然对接起来就相当麻烦。

  1. 支持密码认证
  2. 支持安全密钥认证
  3. 支持根据按文件命名策略检索文件,即支持正则检索文件

经过调研发现了一个非常好用,且文档全面的SFTP客户端库:

  1. GitHub
  2. 官方文档

这个库由componentpro出品,此公司还提供了其它的工具库,功能非常强大,如下:

从上面可以看出,不仅提供FTP client/server、SFTP client/server的库,还提供了Mail、Excel、SAML、PDF的库,真的是太强大了,经过实验也发现它的SFTP封装的真的好用。

如何封装

作者已经使用SFTP Library封装并实现了以上三点需求,代码结构如下:

这里就不赘述代码设计了,感兴趣请自行查看源码。

地址:https://github.com/justmine66/Samples/tree/master/SFTP/SFtpDownloader

如何使用

请先安装包:Install-Package SFTP.Downloader -Version 1.0.2,实际使用时,请使用最新版本。

1. 实现文件命名策略接口

public class FileNamingStrategy : IFileNamingStrategy
{
public string GetFileRegexName()
{
return $"test.csv";
}
}

2. 配置文件下载器

new ServiceCollection()
.AddSFtpServices(builder =>
{
// 1. 注册命名服务,用于按需检索文件。
builder.AddNamingStrategy<FileNamingStrategy>();
// 2. 认证方案(任选其一)
// 2.1 密码
builder.UsePwdAuthTScheme("sftp-host", "userName", "pwd", "/upload/");
// 2.2 安全密钥
builder.UseSecurityKeyAuthTScheme("sftp-host", "userName", "SFtpDownloader.test.ppk", "/upload/");
});

备注:当使用安全密钥认证方案时,请将私钥设置为嵌入式资源。

3. 使用文件下载器

private readonly ILogger _logger;
private readonly IFilesDownloader _downloader; public Engine(ILogger<Engine> logger, IFilesDownloader downloader)
{
_logger = logger;
_downloader = downloader;
} public async Task StartAsync(CancellationToken cancellationToken)
{
var files = await _downloader.DownloadAsync(1);
_logger.LogInformation($"The files downloaded: {files.Aggregate((x, y) => $"{x},{y}")}.");
}

当需要在运行时才能注入配置时,还可以传入参数options,比如:

var files = await _downloader.DownloadAsync(1, options: new SFtpOptions(){
Host = "sftp-host",UserName="userName",Password="pwd",RemoteDirectory="/upload"
});

示例github项目地址:https://github.com/justmine66/Samples/tree/master/SFTP/SFtpDownloader.Test

使用起来就是这么简单!!!

总结

本篇首先介绍了实现一个SFTP文件下载器,需要满足的基本需求,然后使用SFTP Library封装了一个既简单又好用的SFTP文件下载器,最后演示了如何使用此库。

最后

如果有什么疑问和见解,欢迎评论区交流。

如果你觉得本篇文章对您有帮助的话,感谢您的【推荐】。

如果你对dotnet感兴趣的话可以关注我,我会定期的在博客分享我的学习心得。

未经允许不得转载,转载请在明显位置给出出处及链接

[dotnet] 封装一个同时支持密码/安全密钥认证的SFTP下载器,简单易用。的更多相关文章

  1. 转:【专题十一】实现一个基于FTP协议的程序——文件上传下载器

    引言: 在这个专题将为大家揭开下FTP这个协议的面纱,其实学习知识和生活中的例子都是很相通的,就拿这个专题来说,要了解FTP协议然后根据FTP协议实现一个文件下载器,就和和追MM是差不多的过程的,相信 ...

  2. 专题十一:实现一个基于FTP协议的程序——文件上传下载器

    引言: 在这个专题将为大家揭开下FTP这个协议的面纱,其实学习知识和生活中的例子都是很相通的,就拿这个专题来说,要了解FTP协议然后根据FTP协议实现一个文件下载器,就和和追MM是差不多的过程的,相信 ...

  3. 实现一个基于FTP协议的程序——文件上传下载器(十三)

    此为一个系列,后续会把内容补上...

  4. 基于iOS 10、realm封装的下载器

    代码地址如下:http://www.demodashi.com/demo/11653.html 概要 在决定自己封装一个下载器前,我本以为没有那么复杂,可在实际开发过程中困难重重,再加上iOS10和X ...

  5. Go/Python/Erlang编程语言对比分析及示例 基于RabbitMQ.Client组件实现RabbitMQ可复用的 ConnectionPool(连接池) 封装一个基于NLog+NLog.Mongo的日志记录工具类LogUtil 分享基于MemoryCache(内存缓存)的缓存工具类,C# B/S 、C/S项目均可以使用!

    Go/Python/Erlang编程语言对比分析及示例   本文主要是介绍Go,从语言对比分析的角度切入.之所以选择与Python.Erlang对比,是因为做为高级语言,它们语言特性上有较大的相似性, ...

  6. Node教程——封装一个token验证器

    重要说明 这个轮子是 使用 express@5.0 + MongoDB构建起来的一个 node后台通用的验证器,里面主要讲的就是使用jwt,token进行验证,当然你想使用session也没问题,但是 ...

  7. 自己封装一个Log模块

    Unity自己有log系统,为什么要自己封装一个 1.不好用,只能在pc上记录log文件,移动平台是没有的 2.在开发时期的log,不想在正式版里面出现.没有一个统一的开关来控制是不是要显示log,要 ...

  8. 使用libzplay库封装一个音频类

    装载请说明原地址,谢谢~~      前两天我已经封装好一个duilib中使用的webkit内核的浏览器控件和一个基于vlc的用于播放视频的视频控件,这两个控件可以分别用在放酷狗播放器的乐库功能和MV ...

  9. 网络游戏开发-服务器(01)Asp.Net Core中的websocket,并封装一个简单的中间件

    先拉开MSDN的文档,大致读一遍 (https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/websockets) WebSocket 是一 ...

随机推荐

  1. MongoDB与CouchDB 全方位对比

    http://blog.nosqlfan.com/html/1519.html 本文见于MongoDB官方网站,MongoDB与CouchDB 很相似,他们都是文档型存储,数据存储格式都是JSON型的 ...

  2. PHP判断客户端是否使用代理服务器及其匿名级别

    要判断客户端是否使用代理服务器,可以从客户端所发送的环境变量信息来判断. 具体来说,就是看HTTP_VIA字段,如果这个字段设置了,说明客户端使用了代理服务器. 匿名级别可以参考下表来判断. 给出一个 ...

  3. win8系统下,python 2.7安装xlrd,xlutils和xlwt的方法

    一.先到python的官网上下载压缩包 二.将压缩包解压 三.将打开cmd,进入到解压文件所在的位置 四.键入 python setup.py install

  4. 使用TortoiseGit操作分支的创建与合并

    第一步:创建本地分支 点击右键选择TortoiseGit,选择Create Branch…,在Branch框中填写新分支的名称(若选中”switch to new branch”则直接转到新分支上,省 ...

  5. ArcGis SOE(server object extensions)之REST Template初体验

    一.安装vs和arcgis server for .net(本例是vs2010.as 10),然后打开vs新建一个项目

  6. Spring4托管Hibernate5并利用HibernateTemplate进行数据库操作

    时隔半年,再次发布配置类的相关Blog,因为左手受伤原因先做一个简述. 首先利用idea创建一个Spring+SpringMVC+Hibernate项目,注意的是因为我们要完全放弃Hibernate以 ...

  7. shell脚本头,#!/bin/sh与#!/bin/bash的区别.

    因为今天写了个小脚本,死活不成功,总是报文件或者目录不存在,问了一下我们马同学的正常写法,发现只有脚本头的区别,也就是今天本文要讲的#!/bin/sh与#!/bin/bash. 本文参考:https: ...

  8. jenkins中集成commander应用

    jenkins中集成commander应用 jenkins 集成测试 promotion 最近参加公司的集成测试平台的开发,在开发中遇到了不少问题,两个星期的迭代也即将完成,在这也用这篇博客记录下开发 ...

  9. TensorFlow-谷歌深度学习库 图片处理模块

    Module: tf.image 这篇文章主要介绍TensorFlow处理图片这一块,这个模块和之前说过的文件I/O处理一样也是主要从python导过来的. 通过官方文档,我们了解到这个模块主要有一下 ...

  10. Java中 float、double使用注意问题

    在java中运行一下代码 System.out.println(2.00-1.10);输出的结果是:0.8999999999999999很奇怪,并不是我们想要的值0.9 再运行如下代码:System. ...