wip:(mvc) 添加雪花Long类型Id的ModelBinder转换器，并添加到Mvc服务中

libaowei · Oct 4, 2023 · e962d15 · e962d15
1 parent ab559e9
commit e962d15
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 6 deletions.
diff --git a/samples/web/Liuliu.Demo.WebApi/appsettings.Development.json b/samples/web/Liuliu.Demo.WebApi/appsettings.Development.json
@@ -2,6 +2,8 @@
   "Logging": {
     "LogLevel": {
       "Default": "Debug",
+      "OSharp": "Debug",
+      "Liuliu": "Debug",
       "Microsoft": "Warning",
       "Microsoft.Hosting.Lifetime": "Warning"
     }
@@ -115,13 +117,14 @@
     },
     "Mvc": {
       "IsLowercaseJsonProperty": true,
-      "IsLowercaseUrls": true
+      "IsLowercaseUrls": true,
+      "IsLongIdModelBinder": false
     },
     "Cors": {
       "PolicyName": "MyCors",
       "AllowAnyHeader": true,
       "WithMethods": [ "POST", "PUT", "DELETE" ],
-      "WithOrigins": [ ],
+      "WithOrigins": [],
       "Enabled": true
     },
     "Redis": {

diff --git a/src/OSharp.AspNetCore/Mvc/ModelBinding/LongIdModelBinder.cs b/src/OSharp.AspNetCore/Mvc/ModelBinding/LongIdModelBinder.cs
@@ -0,0 +1,44 @@
+// -----------------------------------------------------------------------
+//  <copyright file="SnowflakeIdModelBinder.cs" company="OSharp开源团队">
+//      Copyright (c) 2014-2023 OSharp. All rights reserved.
+//  </copyright>
+//  <site>http://www.osharp.org</site>
+//  <last-editor>郭明锋</last-editor>
+//  <last-date>2023-10-05 0:19</last-date>
+// -----------------------------------------------------------------------
+
+using System.Globalization;
+
+
+namespace OSharp.AspNetCore.Mvc.ModelBinding
+{
+    public class LongIdModelBinder : IModelBinder
+    {
+        public Task BindModelAsync(ModelBindingContext bindingContext)
+        {
+            if (bindingContext == null)
+            {
+                throw new ArgumentNullException(nameof(bindingContext));
+            }
+
+            // 获取传入的ID值作为字符串
+            string valueAsString = bindingContext.ValueProvider.GetValue(bindingContext.ModelName).FirstValue;
+            if (string.IsNullOrEmpty(valueAsString))
+            {
+                return Task.CompletedTask;
+            }
+
+            if (long.TryParse(valueAsString, NumberStyles.Integer, CultureInfo.InvariantCulture, out long id))
+            {
+                // 成功解析为long，将其设置为模型的值
+                bindingContext.Result = ModelBindingResult.Success(id);
+            }
+            else
+            {
+                // 解析失败，返回错误
+                bindingContext.ModelState.TryAddModelError(bindingContext.ModelName, "Invalid Snowflake ID format.");
+            }
+            return Task.CompletedTask;
+        }
+    }
+}
diff --git a/src/OSharp.AspNetCore/Mvc/ModelBinding/LongIdModelBinderProvider.cs b/src/OSharp.AspNetCore/Mvc/ModelBinding/LongIdModelBinderProvider.cs
@@ -0,0 +1,29 @@
+// -----------------------------------------------------------------------
+//  <copyright file="LongIdModelBinderProvider.cs" company="OSharp开源团队">
+//      Copyright (c) 2014-2023 OSharp. All rights reserved.
+//  </copyright>
+//  <site>http://www.osharp.org</site>
+//  <last-editor>郭明锋</last-editor>
+//  <last-date>2023-10-05 1:26</last-date>
+// -----------------------------------------------------------------------
+
+namespace OSharp.AspNetCore.Mvc.ModelBinding
+{
+    public class LongIdModelBinderProvider : IModelBinderProvider
+    {
+        /// <summary>
+        /// Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder" /> based on <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext" />.
+        /// </summary>
+        /// <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext" />.</param>
+        /// <returns>An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder" />.</returns>
+        public IModelBinder GetBinder(ModelBinderProviderContext context)
+        {
+            if (context.Metadata.ModelType == typeof(long))
+            {
+                return new LongIdModelBinder();
+            }
+
+            return null;
+        }
+    }
+}
diff --git a/src/OSharp.AspNetCore/Mvc/MvcPackBase.cs b/src/OSharp.AspNetCore/Mvc/MvcPackBase.cs
@@ -11,6 +11,7 @@
 
 using OSharp.AspNetCore.Cors;
 using OSharp.AspNetCore.Mvc.Filters;
+using OSharp.AspNetCore.Mvc.ModelBinding;
 using OSharp.Core.Options;
 
 
@@ -46,7 +47,13 @@ public override IServiceCollection AddServices(IServiceCollection services)
         _corsInitializer.AddCors(services);
 
         OsharpOptions osharp = services.GetOsharpOptions();
-        services.AddControllersWithViews()
+        services.AddControllersWithViews(opts =>
+            {
+                if (osharp.Mvc?.IsLongIdModelBinder == true)
+                {
+                    opts.ModelBinderProviders.Insert(0, new LongIdModelBinderProvider());
+                }
+            })
             .AddControllersAsServices()
             .AddNewtonsoftJson(options =>
             {
@@ -80,4 +87,4 @@ public override void UsePack(WebApplication app)
 
         IsEnabled = true;
     }
-}
+}
diff --git a/src/OSharp/Core/Options/MvcOptions.cs b/src/OSharp/Core/Options/MvcOptions.cs
@@ -1,4 +1,4 @@
-// -----------------------------------------------------------------------
+// -----------------------------------------------------------------------
 //  <copyright file="MvcOptions.cs" company="OSharp开源团队">
 //      Copyright (c) 2014-2021 OSharp. All rights reserved.
 //  </copyright>
@@ -23,4 +23,9 @@ public class MvcOptions
     /// 获取或设置 是否URL小写，默认：false
     /// </summary>
     public bool IsLowercaseUrls { get; set; } = false;
-}
+
+    /// <summary>
+    /// 获取或设置 是否使用雪花Id模型绑定器，默认：false
+    /// </summary>
+    public bool IsLongIdModelBinder { get; set; } = false;
+}