Merge pull request #1 from Crequency/dev=main

Dynesshely · web-flow · commit a7cc8855b93d · 2022-12-17T06:54:15.000+08:00
[Pull Request] 一些小优化, 新的版本规则
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+## Ignore for Rider files
+.idea/
+
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -12,3 +12,5 @@ add_subdirectory ("Math")
 add_subdirectory ("Encode")
 
 add_subdirectory ("Test")
+
+add_definitions ("cpp.hint")
diff --git a/Common.Algorithm.Interop/Common.Algorithm.Interop.csproj b/Common.Algorithm.Interop/Common.Algorithm.Interop.csproj
@@ -20,7 +20,7 @@
 
         <AssemblyVersion>$(Version)</AssemblyVersion>
         <FileVersion>$(Version)</FileVersion>
-        <Version>1.1.$([System.DateTime]::UtcNow.Date.Subtract($([System.DateTime]::Parse("2005-07-16"))).TotalDays).$([System.Math]::Floor($([System.DateTime]::UtcNow.TimeOfDay.TotalMinutes)))</Version>
+        <Version>1.2.$([System.DateTime]::UtcNow.Date.Subtract($([System.DateTime]::Parse("2005-06-06"))).TotalDays).$([System.Math]::Floor($([System.DateTime]::UtcNow.TimeOfDay.TotalMinutes)))</Version>
 
     </PropertyGroup>
 
diff --git a/Common.Algorithm.Interop/Environment.cs b/Common.Algorithm.Interop/Environment.cs
@@ -2,35 +2,47 @@
 
 #pragma warning disable SYSLIB0014 // 类型或成员已过时
 
-namespace Algorithm.Interop
+namespace Common.Algorithm.Interop
 {
-    public class Environment
+    public static class Environment
     {
 
         /// <summary>
         /// 核心文件路径
         /// </summary>
-        public const string dll_path = "./Core/";
+        public const string DllPath = "./Core/";
 
         /// <summary>
         /// 云端 DLL 存储路径
         /// </summary>
-        public const string cloudUrl = "https://source.catrol.cn/lib/Algorithm/Core/";
+        private static string _cloudUrl = "https://source.catrol.cn/lib/Algorithm/Core/";
 
         /// <summary>
         /// 库版本
         /// </summary>
-        public const string version = "v1.0";
+        private static string _version = "v1.0";
 
         /// <summary>
         /// 核心文件文件名
         /// </summary>
-        private readonly static List<string> CoreFiles = new()
+        private static readonly List<string> CoreFiles = new()
         {
             "Math.dll",
             "Hash.dll"
         };
 
+        /// <summary>
+        /// 更新云端存储链接
+        /// </summary>
+        /// <param name="url"></param>
+        public static void UpdateCloudStorageUrl(string url) => _cloudUrl = url;
+
+        /// <summary>
+        /// 更新云端存储版本
+        /// </summary>
+        /// <param name="ver"></param>
+        public static void UpdateCloudStorageVersion(string ver) => _version = ver;
+
         /// <summary>
         /// 检查环境是否就绪, 核心文件是否存在
         /// </summary>
@@ -39,7 +51,7 @@ public static bool CheckEnvironment()
         {
             foreach (string fn in CoreFiles)
             {
-                if (!File.Exists(Path.GetFullPath($"{dll_path}{fn}")))
+                if (!File.Exists(Path.GetFullPath($"{DllPath}{fn}")))
                     return false;
             }
             return true;
@@ -51,19 +63,19 @@ public static bool CheckEnvironment()
         /// </summary>
         public static void InstallEnvironment(InstallMethod im = InstallMethod.WebClient)
         {
-            if(!Directory.Exists(dll_path))
-                Directory.CreateDirectory(dll_path);
+            if (!Directory.Exists(DllPath))
+                Directory.CreateDirectory(DllPath);
             switch (im)
             {
                 case InstallMethod.WebClient:
                     WebClient wc = new();
                     foreach (string fn in CoreFiles)
                     {
-                        if (!File.Exists($"{dll_path}{fn}"))
+                        if (!File.Exists($"{DllPath}{fn}"))
                         {
                             wc.DownloadFile(
-                                new Uri($"{cloudUrl}{version}/{fn}", UriKind.Absolute),
-                                Path.GetFullPath($"{dll_path}{fn}"));
+                                new Uri($"{_cloudUrl}{_version}/{fn}", UriKind.Absolute),
+                                Path.GetFullPath($"{DllPath}{fn}"));
                         }
                     }
                     wc.Dispose();
@@ -77,19 +89,19 @@ public static void InstallEnvironment(InstallMethod im = InstallMethod.WebClient
         /// </summary>
         public static async Task InstallEnvironmentAsync(InstallMethodAsync im = InstallMethodAsync.WebClientAsync)
         {
-            if (!Directory.Exists(dll_path))
-                Directory.CreateDirectory(dll_path);
+            if (!Directory.Exists(DllPath))
+                Directory.CreateDirectory(DllPath);
             switch (im)
             {
                 case InstallMethodAsync.WebClientAsync:
                     var wc = new WebClient();
                     foreach (string fn in CoreFiles)
                     {
-                        if (!File.Exists($"{dll_path}{fn}"))
+                        if (!File.Exists($"{DllPath}{fn}"))
                         {
                             await wc.DownloadFileTaskAsync(
-                                new Uri($"{cloudUrl}{version}/{fn}", UriKind.Absolute),
-                                Path.GetFullPath($"{dll_path}{fn}"));
+                                new Uri($"{_cloudUrl}{_version}/{fn}", UriKind.Absolute),
+                                Path.GetFullPath($"{DllPath}{fn}"));
                         }
                     }
                     wc?.Dispose();
diff --git a/Common.Algorithm.Interop/Exceptions/BasicException.cs b/Common.Algorithm.Interop/Exceptions/BasicException.cs
@@ -1,4 +1,4 @@
-﻿namespace Algorithm.Interop.Exceptions
+﻿namespace Common.Algorithm.Interop.Exceptions
 {
     public class BasicException : Exception
     {
diff --git a/Common.Algorithm.Interop/Exceptions/HashException.cs b/Common.Algorithm.Interop/Exceptions/HashException.cs
@@ -1,4 +1,4 @@
-﻿namespace Algorithm.Interop.Exceptions
+﻿namespace Common.Algorithm.Interop.Exceptions
 {
     public class HashException : BasicException
     {
diff --git a/Common.Algorithm.Interop/Hash.cs b/Common.Algorithm.Interop/Hash.cs
@@ -1,75 +1,83 @@
-﻿using Algorithm.Interop.Exceptions;
+﻿using Common.Algorithm.Interop.Exceptions;
 using System.Runtime.InteropServices;
 using System.Text;
 
-namespace Algorithm.Interop
+namespace Common.Algorithm.Interop
 {
     /// <summary>
     /// 文件哈希类
     /// </summary>
-    public class Hash
+    public static class Hash
     {
         /// <summary>
         /// DLL 路径
         /// </summary>
-        private const string dll_path = Environment.dll_path;
+        private const string DllPath = Environment.DllPath;
 
         #region 扩展库函数导入 [DLLImport Hash.dll]
 
         /// <summary>
         /// 调用扩展库进行 Hash
         /// </summary>
         /// <param name="src">元数据</param>
+        /// <param name="output">输出</param>
+        /// <param name="length">长度</param>
         /// <returns>哈希后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_str")]
         private static extern void hash_str(byte[] src, byte[] output, int length);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_128_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_128_str")]
         private static extern void hash_compress_128_str(byte[] src, byte[] output);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_64_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_64_str")]
         private static extern void hash_compress_64_str(byte[] src, byte[] output);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_32_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_32_str")]
         private static extern void hash_compress_32_str(byte[] src, byte[] output);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_16_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_16_str")]
         private static extern void hash_compress_16_str(byte[] src, byte[] output);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_8_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_8_str")]
         private static extern void hash_compress_8_str(byte[] src, byte[] output);
 
         /// <summary>
         /// 调用扩展库进行 Hash 压缩
         /// </summary>
         /// <param name="src">哈希数据</param>
+        /// <param name="output">输出</param>
         /// <returns>哈希压缩后的数据</returns>
-        [DllImport($"{dll_path}Hash.dll", EntryPoint = "hash_compress_4_str")]
+        [DllImport($"{DllPath}Hash.dll", EntryPoint = "hash_compress_4_str")]
         private static extern void hash_compress_4_str(byte[] src, byte[] output);
 
         #endregion
@@ -80,34 +88,33 @@ public class Hash
         /// 统一调用哈希压缩
         /// </summary>
         /// <param name="mid">源压缩中间哈希值</param>
-        /// <param name="rst">哈希压缩值储存地址</param>
         /// <param name="clv">哈希压缩级别</param>
         private static byte[] Compress(ref byte[] mid, CompressLevel clv)
         {
             switch (clv)
             {
                 case CompressLevel.x128:
-                    byte[] ans128 = new byte[128];
+                    var ans128 = new byte[128];
                     hash_compress_128_str(mid, ans128);
                     return ans128;
                 case CompressLevel.x64:
-                    byte[] ans64 = new byte[64];
+                    var ans64 = new byte[64];
                     hash_compress_64_str(mid, ans64);
                     return ans64;
                 case CompressLevel.x32:
-                    byte[] ans32 = new byte[32];
+                    var ans32 = new byte[32];
                     hash_compress_32_str(mid, ans32);
                     return ans32;
                 case CompressLevel.x16:
-                    byte[] ans16 = new byte[16];
+                    var ans16 = new byte[16];
                     hash_compress_16_str(mid, ans16);
                     return ans16;
                 case CompressLevel.x8:
-                    byte[] ans8 = new byte[8];
+                    var ans8 = new byte[8];
                     hash_compress_8_str(mid, ans8);
                     return ans8;
                 case CompressLevel.x4:
-                    byte[] ans4 = new byte[4];
+                    var ans4 = new byte[4];
                     hash_compress_4_str(mid, ans4);
                     return ans4;
                 default: return Array.Empty<byte>();
@@ -139,14 +146,15 @@ public static CompressLevel HashCompressLevelParse(string compressed,
         /// 进行字符串哈希
         /// </summary>
         /// <param name="str">字符串</param>
+        /// <param name="clv">压缩级别</param>
         /// <returns>哈希后的Byte数组</returns>
         public static byte[] FromString(string str,
             CompressLevel clv = CompressLevel.x64)
         {
-            byte[] array = Encoding.UTF8.GetBytes(str);     //  源字符串转 byte[]
-            byte[] mid = new byte[2048];                    //  存储哈希值
+            var array = Encoding.UTF8.GetBytes(str);     //  源字符串转 byte[]
+            var mid = new byte[2048];                    //  存储哈希值
             hash_str(array, mid, array.Length);             //  哈希运算
-            byte[] rst = Compress(ref mid, clv);            //  哈希压缩运算
+            var rst = Compress(ref mid, clv);            //  哈希压缩运算
             return rst;                                     //  返回哈希压缩值
         }
 
@@ -155,15 +163,16 @@ public static byte[] FromString(string str,
         /// </summary>
         /// <param name="str">字符串</param>
         /// <param name="rmLink">是否移除连字符</param>
+        /// <param name="clv">压缩级别</param>
         /// <returns>十六进制哈希字符串</returns>
         public static string FromString2Hex(string str, bool rmLink = false,
             CompressLevel clv = CompressLevel.x64)
         {
-            byte[] array = Encoding.UTF8.GetBytes(str);     //  源字符串转 byte[]
-            byte[] mid = new byte[2048];                    //  存储哈希值
+            var array = Encoding.UTF8.GetBytes(str);     //  源字符串转 byte[]
+            var mid = new byte[2048];                    //  存储哈希值
             hash_str(array, mid, array.Length);             //  哈希运算
-            byte[] rst = Compress(ref mid, clv);            //  哈希压缩运算
-            string ans = BitConverter.ToString(rst);        //  哈希压缩运算转十六进制字符串
+            var rst = Compress(ref mid, clv);            //  哈希压缩运算
+            var ans = BitConverter.ToString(rst);        //  哈希压缩运算转十六进制字符串
             return rmLink ? ans.Replace("-", "") : ans;     //  返回字符串, 据参数删除连字符
         }
 
@@ -215,7 +224,9 @@ public enum HashMode
         /// </summary>
         public enum CompressLevel
         {
+            // ReSharper disable InconsistentNaming
             x128 = 5, x64 = 4, x32 = 3, x16 = 2, x8 = 1, x4 = 0
+            // ReSharper restore InconsistentNaming
         }
 
         #endregion
diff --git a/Common.Algorithm.UnitTest/HashTest.cs b/Common.Algorithm.UnitTest/HashTest.cs
diff --git a/cpp.hint b/cpp.hint

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Algorithm.Interop.Exceptions`
	`1`	`+namespace Common.Algorithm.Interop.Exceptions`
`2`	`2`	`{`
`3`	`3`	`public class BasicException : Exception`
`4`	`4`	`{`