Merge pull request PCL-Community#132 from whitecat346/feature/uuid

refactor(uuid): 重构Uuid生成实现

Author: whitecat346

PCL.Neo.Core/PCL.Neo.Core.csproj

@@ -4,6 +4,7 @@
         <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
+        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     </PropertyGroup>
 
     <ItemGroup>
@@ -25,6 +26,7 @@
 
     <ItemGroup>
       <PackageReference Include="System.Runtime.InteropServices" Version="4.3.0" />
+      <PackageReference Include="Uuids" Version="2.0.0" />
     </ItemGroup>
 
 </Project>

PCL.Neo.Core/Utils/Uuid.cs

@@ -1,19 +1,64 @@
+using System.Security.Cryptography;
+using System.Text;
 using System.Text.RegularExpressions;
 
 namespace PCL.Neo.Core.Utils;
 
 public static partial class Uuid // TODO: implement different way of genereate uuid
 {
-    private const string DefaultUuid = "00000000-0000-0000-0000-000000000000";
+    public enum UuidGenerateType
+    {
+        Guid,
+        Standard,
+        MurmurHash3
+    }
 
-    public static string GenerateOfflineUuid(string username)
+    /// <summary>
+    /// Generate UUID base on input username. If username is empty or invalid,
+    /// throw <see cref="ArgumentException"/>.
+    /// </summary>
+    /// <param name="username">Username to generate UUID.</param>
+    /// <param name="type">Type of UUID generation.</param>
+    /// <returns>Generated UUID.</returns>
+    /// <exception cref="ArgumentException">
+    /// If <paramref name="username"/> is invalid or empty.
+    /// </exception>
+    public static string GenerateUuid(string username, UuidGenerateType type)
     {
-        if (string.IsNullOrEmpty(username) || !IsValidUsername(username))
-            return DefaultUuid;
-        var guid = new Guid(MurmurHash3.Hash(username));
-        return guid.ToString();
+        if (string.IsNullOrEmpty(username) ||
+            !IsValidUsername(username))
+        {
+            throw new ArgumentException("Username is invalid.");
+        }
+
+        var fullName = $"OfflinePlayer:{username}";
+
+        var uuid = type switch
+        {
+            UuidGenerateType.Guid => new Guid(MD5.HashData(Encoding.UTF8.GetBytes(fullName))).ToString(),
+            UuidGenerateType.Standard => StadardVer(fullName),
+            UuidGenerateType.MurmurHash3 => new Guid(MurmurHash3.Hash(fullName)).ToString(),
+            _ => throw new ArgumentOutOfRangeException(nameof(type), type, null)
+        };
+
+        uuid = uuid.Replace("-", string.Empty);
+
+        return uuid;
     }
 
+    private static string StadardVer(string name)
+    {
+        var hash = MD5.HashData(Encoding.UTF8.GetBytes(name));
+
+        hash[6] = (byte)((hash[6] & 0x0F) | 0x30); // Version 3
+        hash[8] = (byte)((hash[8] & 0x3F) | 0x80); // Variant 1 (RFC 4122)
+
+        return new Uuids.Uuid(hash).ToString();
+    }
+
+    [GeneratedRegex("^[a-zA-Z0-9_]+$")]
+    private static partial Regex ValidUsernameRegex();
+
     public static bool IsValidUsername(string username)
     {
         return !string.IsNullOrEmpty(username) &&
@@ -22,11 +67,12 @@ public static bool IsValidUsername(string username)
     }
 
     // MurmurHash3算法实现
+
     private static class MurmurHash3
     {
         public static byte[] Hash(string str)
         {
-            var bytes = System.Text.Encoding.UTF8.GetBytes(str);
+            var bytes = Encoding.UTF8.GetBytes(str);
             const uint seed = 144;
             const uint c1 = 0xcc9e2d51;
             const uint c2 = 0x1b873593;
@@ -80,7 +126,4 @@ private static uint Fmix(uint h)
             return h;
         }
     }
-
-    [GeneratedRegex("^[a-zA-Z0-9_]+$")]
-    private static partial Regex ValidUsernameRegex();
 }

PCL.Neo.Tests/Utils/UuidTest.cs

@@ -0,0 +1,23 @@
+using PCL.Neo.Core.Utils;
+using System;
+
+namespace PCL.Neo.Tests.Utils
+{
+    [TestFixture]
+    [TestOf(typeof(Uuid))]
+    public class UuidTest
+    {
+        [Test]
+        public void UuidGenerateTest()
+        {
+            var name = "WhiteCat";
+            var uuid1 = Uuid.GenerateUuid(name, Uuid.UuidGenerateType.Guid);
+            var uuid2 = Uuid.GenerateUuid(name, Uuid.UuidGenerateType.Standard);
+            var uuid3 = Uuid.GenerateUuid(name, Uuid.UuidGenerateType.MurmurHash3);
+
+            Console.WriteLine(uuid1);
+            Console.WriteLine(uuid2);
+            Console.WriteLine(uuid3);
+        }
+    }
+}