【开源框架】| 通用工具类库

这是恰童鞋骚年的第223篇原创文章

---

本文介绍一个我的同事【懒得勤快】（人称勤快哥，我们叫他骚哥）写的一个.NET开源工具类库项目，包含一些常用的操作类，大都是静态类，加密解密，反射操作，硬件信息，字符串扩展方法，日期时间扩展操作，大文件拷贝，图像裁剪，验证码等常用封装。

1项目起因

这是我的同事【懒得勤快】从入坑编程多年来的代码积累，他把一些编程中常用的一些代码进行了封装，在后续的任何开发当中使用上它，避免重复地去造一些轮子，把重心转移到项目的推进，几乎可以做任何的事情。

他说现在项目中没了它，写逻辑代码还真有点困难。由于C#语言有个其他语言不可替代的特性：扩展方法，所以项目的实现90%以上都是通过扩展方法实现的，方便直接调用。

因此，我们可以看出，虽然他的网名叫【懒得勤快】，实际上，他比大多数人都勤快的多。另外，我司.NET Core项目中的核心工具类库也主要是引用了众多这个类库中的通用方法，很多骚操作都是从这个项目中直接复用的。

2项目简介

项目包含了日常编程多数的常用封装，可以说是一个万能框架，能够用于任何基于.NET平台（包括.NET Core）的项目当中。

功能主要覆盖：

数据库操作：内存表操作、关系实体映射等；

日期时间常用操作：农历操作、时间戳操作，时分秒转换等；

文件操作：大文件操作、文件压缩与解压、ini配置文件操作；

硬件操作：获取电脑各个硬件的性能指标；

Html操作：利用C#对html字符串进行“dom”操作，html的XSS净化、html标签操作；

日志组件：高并发可用的高性能日志记录；

多媒体文件操作：图片的各种处理；

网络操作：获取线程内唯一对象、Session和Cookie的扩展、获取IP地址详细信息、缓存操作；

NoSQL：仅封装了Redis的常用操作，mongodb的操作类客户端独立分开了；

反射操作：各种对对象的字段属性和方法的快捷方式；

加密安全：对字符串进行的扩展，包含AES、DES、MD5、hash、SHA1、加盐等；

字符串扩展：包含验证码生成、各种与字符串相关的扩展；

Win32API：包含于Windows系统接口相关的操作封装；

全局扩展：包含字符串扩展，类型转换，委托、循环操作、异步操作、正则等。

项目源代码托管于github，程序包发布于nuget，目前已有745个star以及30000余次下载，由此也可以说明大伙也挺喜欢这个工具组件的。

github地址（这里仅展示我司的开源社区仓库地址，他的个人仓库中的这个项目star数目有745个）：https://github.com/XiLife-OSPC/Masuit.Tools

值得一提的是，这个项目加入了反996的许可，即任何性质的外包公司或996公司需要使用本类库，请联系作者进行商业授权！其他企业或个人可随意使用不受限。

3安装程序包

.NET Framework ≥4.6.1

PM> Install-Package Masuit.Tools.Net

.NET Core 3.x

PM> Install-Package Masuit.Tools.Core

4特色功能示例

1、检验字符串是否是Email、手机号、URL、IP地址、身份证号

bool isEmail="3444764617@qq.com".MatchEmail();
bool isInetAddress = "114.114.114.114".MatchInetAddress();
bool isUrl = "http://masuit.com".MatchUrl();
bool isPhoneNumber = "15205201520".MatchPhoneNumber();
bool isIdentifyCard = "312000199502230660".MatchIdentifyCard();// 校验中国大陆身份证号

2、硬件检测（仅支持Windows平台）

float load = SystemInfo.CpuLoad;// 获取CPU占用率
long physicalMemory = SystemInfo.PhysicalMemory;// 获取物理内存总数
long memoryAvailable = SystemInfo.MemoryAvailable;// 获取物理内存可用率
double freePhysicalMemory = SystemInfo.GetFreePhysicalMemory();// 获取可用物理内存
Dictionary<string, string> diskFree = SystemInfo.DiskFree();// 获取磁盘每个分区可用空间
Dictionary<string, string> diskTotalSpace = SystemInfo.DiskTotalSpace();// 获取磁盘每个分区总大小
Dictionary<string, double> diskUsage = SystemInfo.DiskUsage();// 获取磁盘每个分区使用率
double temperature = SystemInfo.GetCPUTemperature();// 获取CPU温度
int cpuCount = SystemInfo.GetCpuCount();// 获取CPU核心数
IList<string> ipAddress = SystemInfo.GetIPAddress();// 获取本机所有IP地址
string localUsedIp = SystemInfo.GetLocalUsedIP();// 获取本机当前正在使用的IP地址
IList<string> macAddress = SystemInfo.GetMacAddress();// 获取本机所有网卡mac地址
string osVersion = SystemInfo.GetOsVersion();// 获取操作系统版本
RamInfo ramInfo = SystemInfo.GetRamInfo();// 获取内存信息

3、大文件操作

FileStream fs = new FileStream(@"D:\boot.vmdk", FileMode.OpenOrCreate, FileAccess.ReadWrite);
{//fs.CopyToFile(@"D:\1.bak");//同步复制大文件fs.CopyToFileAsync(@"D:\1.bak");//异步复制大文件string md5 = fs.GetFileMD5Async().Result;//异步获取文件的MD5
}

4、HTML的防XSS处理

string html = @"<link href='/Content/font-awesome/css' rel='stylesheet'/><!--[if IE 7]><link href='/Content/font-awesome-ie7.min.css' rel='stylesheet'/><![endif]--><script src='/Scripts/modernizr'></script><div id='searchBox' role='search'><form action='/packages' method='get'><span class='user-actions'><a href='/users/account/LogOff'>退出</a></span><input name='q' id='searchBoxInput'/><input id='searchBoxSubmit' type='submit' value='Submit' /></form></div>";
string s = html.HtmlSantinizerStandard();//清理后：<div><span><a href="/users/account/LogOff">退出</a></span></div>

5、整理操作系统内存（仅支持Windows）

Windows.ClearMemorySilent();

6、任意禁止转换

NumberFormater nf = new NumberFormater(36);//内置2-62进制的转换
//NumberFormater nf = new NumberFormater("0123456789abcdefghijklmnopqrstuvwxyz");// 自定义进制字符，可用于生成验证码
string s36 = nf.ToString(12345678);
long num = nf.FromString("7clzi");
Console.WriteLine("12345678的36进制是：" + s36); // 7clzi
Console.WriteLine("36进制的7clzi是：" + num); // 12345678
var bin=12345678.ToBinary(36);//7clzi

7、纳秒级性能计数器

HiPerfTimer timer = HiPerfTimer.StartNew();
for (int i = 0; i < 100000; i++)
{//todo
}
timer.Stop();
Console.WriteLine("执行for循环100000次耗时"+timer.Duration+"s");

double time = HiPerfTimer.Execute(() =>
{for (int i = 0; i < 100000; i++){//todo}
});
Console.WriteLine("执行for循环100000次耗时"+time+"s");

8、单机产生唯一有序的短ID

var token=Stopwatch.GetTimestamp().ToBinary(36);var set = new HashSet<string>();
double time = HiPerfTimer.Execute(() =>
{for (int i = 0; i < 1000000; i++){set.Add(Stopwatch.GetTimestamp().ToBinary(36));}
});
Console.WriteLine(set.Count==1000000);//True
Console.WriteLine("产生100w个id耗时"+time+"s");//1.6639039s

9、产生分布式唯一有序的短ID

var sf = SnowFlake.GetInstance();
string token = sf.GetUniqueId();// rcofqodori0w
string shortId = sf.GetUniqueShortId(8);// qodw9728var set = new HashSet<string>();
double time = HiPerfTimer.Execute(() =>
{for (int i = 0; i < 1000000; i++){set.Add(SnowFlake.GetInstance().GetUniqueId());}
});
Console.WriteLine(set.Count == 1000000); //True
Console.WriteLine("产生100w个id耗时" + time + "s"); //2.6891495s

10、农历转换

ChineseCalendar.CustomHolidays.Add(DateTime.Parse("2018-12-31"),"元旦节");//自定义节假日
ChineseCalendar today = new ChineseCalendar(DateTime.Parse("2018-12-31"));
Console.WriteLine(today.ChineseDateString);// 二零一八年十一月廿五
Console.WriteLine(today.AnimalString);// 生肖：狗
Console.WriteLine(today.GanZhiDateString);// 干支：戊戌年甲子月丁酉日
Console.WriteLine(today.DateHoliday);// 获取按公历计算的节假日
...

11、LINQ表达式树扩展

Expression<Func<string, bool>> where1 = s => s.StartsWith("a");
Expression<Func<string, bool>> where2 = s => s.Length > 10;
Func<string, bool> func = where1.And(where2).Compile();
bool b=func("abcd12345678");//trueExpression<Func<string, bool>> where1 = s => s.StartsWith("a");
Expression<Func<string, bool>> where2 = s => s.Length > 10;
Func<string, bool> func = where1.Or(where2).Compile();
bool b=func("abc");// true

12、模板引擎

var tmp = new Template("{{name}}，你好！");
tmp.Set("name", "万金油");
string s = tmp.Render();//万金油，你好！var tmp = new Template("{{one}},{{two}},{{three}}");
string s = tmp.Set("one", "1").Set("two", "2").Set("three", "3").Render();// 1,2,3var tmp = new Template("{{name}}，{{greet}}！");
tmp.Set("name", "万金油");
string s = tmp.Render();// throw 模版变量{{greet}}未被使用

13、List转DataTable

var list = new List<MyClass>()
{new MyClass(){Name = "张三",Age = 22},new MyClass(){Name = "李四",Age = 21},new MyClass(){Name = "王五",Age = 28}
};
var table = list.Select(c => new{姓名=c.Name,年龄=c.Age}).ToList().ToDataTable();// 将自动填充列姓名和年龄

14、文件压缩与解压

基于.NET Framework

MemoryStream ms = SevenZipCompressor.ZipStream(new List<string>()
{@"D:\1.txt","http://ww3.sinaimg.cn/large/87c01ec7gy1fsq6rywto2j20je0d3td0.jpg",
});//压缩成内存流SevenZipCompressor.Zip(new List<string>()
{@"D:\1.txt","http://ww3.sinaimg.cn/large/87c01ec7gy1fsq6rywto2j20je0d3td0.jpg",
}, zip);//压缩成zip
SevenZipCompressor.UnRar(@"D:\Download\test.rar", @"D:\Download\");//解压rar
SevenZipCompressor.Decompress(@"D:\Download\test.tar", @"D:\Download\");//自动识别解压压缩包
SevenZipCompressor.Decompress(@"D:\Download\test.7z", @"D:\Download\");

基于.NET Core

首先是注入

services.AddSevenZipCompressor(); // Startup.cs中注入Compressor// 构造函数注入
private readonly ISevenZipCompressor _sevenZipCompressor;
public Test(ISevenZipCompressor sevenZipCompressor)
{_sevenZipCompressor = sevenZipCompressor;
}

其次使用方式同.NET Framework版

15、FTP客户端

FtpClient ftpClient = FtpClient.GetAnonymousClient("192.168.2.2");//创建一个匿名访问的客户端
//FtpClient ftpClient = FtpClient.GetClient("192.168.2.3","admin","123456");// 创建一个带用户名密码的客户端
ftpClient.Delete("/1.txt");// 删除文件
ftpClient.Download("/test/2.txt","D:\\test\\2.txt");// 下载文件
ftpClient.UploadFile("/test/22.txt","D:\\test\\22.txt",(sum, progress) =>
{Console.WriteLine("已上传："+progress*1.0/sum);
});//上传文件并检测进度
List<string> files = ftpClient.GetFiles("/");//列出ftp服务端文件列表
...

16、加密解密

var enc="123456".MDString();// MD5加密
var enc="123456".MDString("abc");// MD5加盐加密
var enc="123456".MDString2();// MD5两次加密
var enc="123456".MDString2("abc");// MD5两次加盐加密
var enc="123456".MDString3();// MD5三次加密
var enc="123456".MDString3("abc");// MD5三次加盐加密string aes = "123456".AESEncrypt();// AES加密为密文
string s = aes.AESDecrypt(); //AES解密为明文
string aes = "123456".AESEncrypt("abc");// AES密钥加密为密文
string s = aes.AESDecrypt("abc"); //AES密钥解密为明文string enc = "123456".DesEncrypt();// DES加密为密文
string s = enc.DesDecrypt(); //DES解密为明文
string enc = "123456".DesEncrypt("abcdefgh");// DES密钥加密为密文
string s = enc.DesDecrypt("abcdefgh"); //DES密钥解密为明文RsaKey rsaKey = RsaCrypt.GenerateRsaKeys();// 生成RSA密钥对
string encrypt = "123456".RSAEncrypt(rsaKey.PublicKey);// 公钥加密
string s = encrypt.RSADecrypt(rsaKey.PrivateKey);// 私钥解密

17、实体校验

public class MyClass
{[IsEmail]public string Email { get; set; }[IsPhone]public string PhoneNumber { get; set; }[IsIPAddress]public string IP { get; set; }[MinValue(0, ErrorMessage = "年龄最小为0岁"), MaxValue(100, ErrorMessage = "年龄最大100岁")]public int Age { get; set; }[ComplexPassword]//密码复杂度校验public string Password { get; set; }
}

18、邮件发送

new Email()
{SmtpServer = "smtp.masuit.com",// SMTP服务器SmtpPort = 25, // SMTP服务器端口EnableSsl = true,//使用SSLUsername = "admin@masuit.com",// 邮箱用户名Password = "123456",// 邮箱密码Tos = "10000@qq.com,10001@qq.com", //收件人Subject = "测试邮件",//邮件标题Body = "你好啊",//邮件内容
}.SendAsync(s =>
{Console.WriteLine(s);// 发送成功后的回调
});// 异步发送邮件

19、敏感信息掩码

"13123456789".Mask(); // 131****5678
"admin@masuit.com".MaskEmail(); // a****n@masuit.com

20、更多请点击本文底部“阅读原文”了解更多通用工具方法接口，解锁Masuit.Tools的各类骚操作！

5小结

喜欢这个项目的话就点击本文底部“阅读原文”，Star、Fork、Follow素质三连关注一下吧。

往期精彩回顾

.NET开源分表框架：EFCore.Sharding

.NET开源AI生态：SciSharp Stack

基于CanalSharp的ASP.NET Core组件

如果本文对你有用，

不妨点个“在看”或者转发朋友圈

????点击阅读原文，素质三连