JiuLing.CommonLibs 1.2.8

一个通用类库

一个通用类库，基于MIT License。

目前包含的功能有：Dictionary对象对比工具、枚举描述、字符串扩展、日志、通用模型、Cookie工具、网络请求工具、操作系统版本帮助类、随机数、MD5、SHA1、正则表达式、时间戳、线程帮助类、Guid帮助类、程序版本帮助类、命令行参数解析工具。

1️⃣ 项目初衷

新建项目后，经常发现连个string.IsEmpty()都没有、想要个Json的通用返回值吧，也没有:disappointed_relieved::disappointed_relieved:，当然，还有等等等等等等等等。。。所以我决定整理并集成一下自己平时用的比较多的一些工具类，然后发布到NuGet，以后走哪用哪啊有木有~~

2️⃣ 帮助文档

• 类库中以Utils结尾的类，都提供了静态方法，可以直接调用
• 类库中的命名空间和类名，尽量与.NET保持一致

Collections命名空间

该命名空间下是一些集合相关的类

• DictionaryComparer类：Dictionary对象对比工具

  var x = new Dictionary<string, string>();
  x.Add("a1", "b1");
  var y = new Dictionary<string, string>();
  y.Add("a1", "b1");
  Assert.IsTrue(_myComparer.Equals(x, y));
  

ExtensionMethods命名空间

该命名空间下是一些通用的扩展方法

• EnumExtension类：枚举类型的扩展方法

  public enum MyEnum
  {
      [System.ComponentModel.Description("一")]
      One,
      [System.ComponentModel.Description("二")]
      Two,
      Three
  }
  
  //获取枚举的描述信息，下面的例子将返回“一”
  MyEnum.One.GetDescription();
  //如果枚举字段没有设置Description特性，将返回自身的ToString()形式，下面的例子将返回“Three”
  MyEnum.Three.GetDescription();
  

• JsonExtension类：Json 的一些扩展方法(仅支持.NET 6，using System.Text.Json)

  由于在非MVC项目中，System.Text.Json 的json 操作无法支持设置通用JsonSerializerOptions，因此扩展一下。

  //设置通用JsonSerializerOptions
  JsonExtension.DefaultOptions = new JsonSerializerOptions();
  
  //String to model
  public static T? ToObject<T>(this string json);
  
  //Model to string
  public static string ToJson(this object value);
  

• ListExtendTools类：List的一些扩展方法

  List转DataTable

  var a=new List<T>();
  a.ToDataTable();
  

• StringExtension类：字符串类型的扩展方法

  "abc".IsEmpty();  //字符串是否为空
  "abc".IsNotEmpty();  //字符串是否不为空
  "https://jiuling.me".ToUri();  //将字符串转为Uri对象
  

Log命名空间

该命名空间下是一些通用的日志帮助类

• ILogger接口：负责简单的日志的写入

  ILogger logger = LogManager.GetLogger();
  // logger.SetLogDirectory("C:\\")      //设置日志文件的路径，默认为“程序集路径\log”
  //     .SetFileNameFormat("yyyyMMdd")  //设置日志文件名的格式，默认为“yyyy-MM-dd”
  //     .SetFileExpandedName(".txt");   //设置日志文件的扩展名，默认为“.log”
  logger.Write("test");
  

Model命名空间

该命名空间下是一些通用的数据模型

• JsonResult类：通用的Json返回值模型

  public class JsonResult
  {
      public int Code { get; set; }
      public string Message { get; set; }
  }
  

  public class JsonResult<T>
  {
      public int Code { get; set; }
      public string Message { get; set; }
      public T Data { get; set; }
  }
  

• AppUpgradeInfo类：通用的App自动更新所需的模型

  public class AppUpgradeInfo
  {
      /// <summary>
      /// 程序名称
      /// </summary>
      public string Name { get; set; }
      /// <summary>
      /// 版本号
      /// </summary>
      public int VersionCode { get; set; }
      /// <summary>
      /// 当前版本
      /// </summary>
      public string Version { get; set; }
      /// <summary>
      /// 程序运行的最小版本
      /// </summary>
      public string MinVersion { get; set; }
      /// <summary>
      /// 下载地址
      /// </summary>
      public string DownloadUrl { get; set; }
      /// <summary>
      /// 更新日志
      /// </summary>
      public string Log { get; set; }
      /// <summary>
      /// 文件签名类型（例如 MD5、SHA1 等）
      /// </summary>
      public string SignType { get; set; }
      /// <summary>
      /// 签名值
      /// </summary>
      public string SignValue { get; set; }
      /// <summary>
      /// 时间
      /// </summary>
      public DateTime CreateTime { get; set; }
  }
  

Net命名空间

该命名空间下是网络相关的类

• BrowserDefaultHeader类：浏览器的默认Request headers (数据版本：2022-07-13)

  //Edge 浏览器
  public static Dictionary<string, string> EdgeHeaders;
  
  //Chrome 浏览器
  public static Dictionary<string, string> ChromeHeaders;
  
  //Firefox 浏览器
  public static Dictionary<string, string> FirefoxHeaders;
  

• CookieUtils类：Cookie相关的工具

  //将CookieContainer转换为指定格式的字符串形式，方便本地储存
  public static string CookieContainerToString(CookieContainer cookieContainer);
  
  //将指定格式的字符串转换为CookieContainer
  public static CookieContainer StringToCookieContainer(string cookies);
  

• HttpClientHelper类：网络请求类工具，使用HttpClient实现

  //异步发送一个GET请求，返回一个字符串
  public async Task<string> GetReadString(string url);
  
  //异步发送一个GET请求，返回一个字节数组
  public async Task<byte[]> GetReadByteArray(string url);
  
  //异步发送一个GET请求，返回一个文件的字节数组
  public async Task<byte[]> GetFileByteArray(string url, IProgress<float> progress = null, int bufferSize = 8192)
  
  //异步发送一个表单形式的Post请求，返回一个字符串
  public async Task<string> PostFormReadString(string url, IEnumerable<KeyValuePair<string, string>> data);
  
  //异步发送一个字符串形式的Post请求，返回一个字符串
  public async Task<string> PostStringReadString(string url, string data);
  
  //异步发送一个Json形式的Post请求（使用UTF8编码），返回一个字符串
  public async Task<string> PostJsonReadString(string url, string data);
  
  //异步发送一个表单形式的Post请求，返回一个字节数组
  public async Task<byte[]> PostFormReadByteArray(string url, IEnumerable<KeyValuePair<string, string>> data)
  

OS命名空间

该命名空间下是一些操作系统相关的类

• VersionUtils类：操作系统版本帮助类

  VersionUtils.IsWindows7;     //当前系统是否为Win7
  VersionUtils.IsWindows8;     //当前系统是否为Win8
  VersionUtils.IsWindows81;    //当前系统是否为Win8.1
  VersionUtils.IsWindows10;    //当前系统是否为Win10   
  

  //获取当前操作系统的版本，返回值为一个OSVersionEnum枚举值
  VersionUtils.GetOSVersion();
  
  public enum OSVersionEnum
  {
      [Description("Windows7")]
      Windows7,
      [Description("Windows8")]
      Windows8,
      [Description("Windows8.1")]
      Windows81,
      [Description("Windows10")]
      Windows10,
      [Description("未知")]
      Unknown,
  }
  

Random命名空间

该命名空间下是一些随机数相关的类

• RandomUtils类：随机数帮助类

  RandomUtils.GetOneByLength();    //返回一个长度为10的随机数
  RandomUtils.GetOneByLength(20);  //返回一个长度为20的随机数
  
  //方法定义  T GetOneFromList<T>(IList<T> input)
  //随机返回list中的一个元素
  var list = new List<string>();
  list.Add("a");
  list.Add("b");
  RandomUtils.GetOneFromList<string>(list);
  

Security命名空间

该命名空间下是一些安全相关的类

• MD5Utils类：MD5帮助类

  //默认编码格式
  public static Encoding DefaultEncoding = Encoding.UTF8;
  
  //计算字符串的32位 MD5 值（小写）
  string GetStringValueToLower(string input);
  //计算字符串的32位 MD5 值（大写）
  string GetStringValueToUpper(string input);
  
  //计算文件的 MD5 值（小写）
  string GetFileValueToUpper(string fileName);
  //计算文件的 MD5 值（大写）
  string GetFileValueToUpper(string fileName);
  

• SHA1Utils类：SHA1的帮助类

  //计算文件的 SHA1 值（小写）
  string GetFileValueToLower(string fileName);
  //计算文件的 SHA1 值（大写）
  string GetFileValueToUpper(string fileName);
  

Text命名空间

该命名空间下是一些文本处理的类

• RegexUtils类：正则表达式相关的类

  //文本是否与正则表达式匹配
  RegexUtils.IsMatch(111,@"\d{3}");
  
  //根据正则表达式替换；该示例返回：<xxx>
  RegexUtils.Replace("<test>",@"test","xxx");
  
  //返回正则表达式的第一个匹配项；返回test12
  RegexUtils.GetFirst("test123test456", @"test\d{2}");
  
  //返回正则表达式匹配到的所有项
  RegexUtils.GetAll(input, pattern);
  
  //根据正则表达式获取输入字符串中的所有匹配项；如果没有匹配到任何项，返回一个空列表,否则返回匹配到的所有项。
  List<string> GetOneGroupAllMatch("<div>a1</div><div>a2</div><div>a3</div>", @"<div>(?<value>[\s\S]*?)<\/div>");
  //返回值 new List<string>{ "a1", "a2", "a3" }
  
  //按照正则表达式分组名称返回第一个匹配项；如果没有匹配到任何项，success=false,否则result返回匹配到的数据。
  (bool success, string result) GetOneGroupInFirstMatch("name:jiuling;age:0;",@"name:(?<name>\w*);");
  //返回值 success=true,result="jiuling"
  
  //按照正则表达式分组名称返回所有匹配项；如果没有匹配到任何项，success=false,否则result返回一个IDictionary对象，其Key值为Group的名称 
  (bool success, IDictionary<string, string> result)=RegexUtils.GetMultiGroupInFirstMatch("name:jiuling;age:0;",@"name:(?<name>\w*);age:(?<age>\w*);");
  //返回值 success=true,result["name"]="jiuling",result["age"]="0"
  

• StartupCommandUtils类：启动参数解析工具类

  检查是否包含参数

  StartupCommandUtils.Initialize("-a test1 test2 -b");    
  bool result = StartupCommandUtils.HasCommand("-a");
  //result的值为True
  

  获取指定参数

  StartupCommandUtils.Initialize("-a test1 test2 -b -c test-c");
  IList<string> result = StartupCommandUtils.GetCommandValue("-a");
  //result包含"test1"和"test3"两个值
  

  尝试获取指定参数

  StartupCommandUtils.Initialize("-a test1 -b test");    
  bool result = StartupCommandUtils.TryGetCommandValue("-a", out args);
  //result为是否找到对应参数，args为获取到的参数值
  

• TimestampUtils类：时间戳相关的类

  //获取一个10位的时间戳
  TimestampUtils.GetLen10();
  
  //获取一个13位的时间戳
  TimestampUtils.GetLen13();
  
  //将时间转换为一个10位的时间戳   1626961721
  TimestampUtils.ConvertToLen10("2021-07-22 21:48:41");
  
  //将时间转换为一个13位的时间戳   1626961721000
  TimestampUtils.ConvertToLen13("2021-07-22 21:48:41");
  
  //将10位或13位的时间戳转换为一个DateTime对象（该方法会自动判断长度）   2021-07-22 21:48:41
  TimestampUtils.ConvertToDateTime(1626961721000)
  

Threading命名空间

该命名空间下是一些线程相关的类

• ThreadUtils类：线程帮助类

  //随机将线程挂起1-10秒
  ThreadUtils.SleepRandomSecond(1,10);
  
  //随机将线程挂起1-10毫秒
  ThreadUtils.SleepRandomMillisecond(2000, 5000);
  

根命名空间

• GuidUtils类：Guid帮助类

  //获取一个Guid，格式：9af7f46a-ea52-4aa3-b8c3-9fd484c2af12
  GuidUtils.GetFormatDefault();
  
  //获取一个Guid，格式：e0a953c3ee6040eaa9fae2b667060e09
  GuidUtils.GetFormatN();
  
  //获取一个Guid，格式：9af7f46a-ea52-4aa3-b8c3-9fd484c2af12
  GuidUtils.GetFormatD();
  
  //获取一个Guid，格式：{734fd453-a4f8-4c5d-9c98-3fe2d7079760}
  GuidUtils.GetFormatB();
  
  //获取一个Guid，格式：(ade24d16-db0f-40af-8794-1e08e2040df3)
  GuidUtils.GetFormatP();
  
  //获取一个Guid，格式：{0x3fa412e3,0x8356,0x428f,{0xaa,0x34,0xb7,0x40,0xda,0xaf,0x45,0x6f}}
  GuidUtils.GetFormatX();
  

• VersionUtils类：程序版本帮助类

  //检查当前版本是否需要更新
  bool CheckNeedUpdate(Version currentVersion, Version newVersion);
  
  //检查当前版本是否需要更新
  bool CheckNeedUpdate(string currentVersion, string newVersion);
  
  //检查当前版本是否需要更新。返回（是否需要自动更新，当前版本是否允许使用）
  (bool IsNeedUpdate, bool IsAllowUse) CheckNeedUpdate(Version currentVersion, Version newVersion, Version minVersion)
  
  //检查当前版本是否需要更新。返回（是否需要自动更新，当前版本是否允许使用）
  (bool IsNeedUpdate, bool IsAllowUse) CheckNeedUpdate(string currentVersion, string newVersion, string minVersion)
  

3️⃣ License

本项目基于MIT License