feat(Converter): add JsonEnumConverter class (#4209)

* feat: 增加 JsonEnumConverter 转换器

* test: 增加单元测试

* refactor: 移除代码

* chore: bump version 8.0.2

* feat: 增加枚举转换器标签

* revert: 恢复扩展方法

* chore: bump version 8.9.1-beta02

* doc: 更新注释文档

* refactor: 移除转化器使用 BB 内置的

* chore: bump version 8.1.5-beta01

* doc: 更新依赖包

* chore: bump version 8.1.4-beta01

* chore: 更新依赖包

* chore: 更新 Core 工程位置

Author: ArgoZhang

src/BootstrapBlazor.Core/BootstrapBlazor.Core.csproj

@@ -36,7 +36,7 @@
     <PackageReference Include="BootstrapBlazor.CherryMarkdown" Version="8.0.0" />
     <PackageReference Include="BootstrapBlazor.CodeEditor" Version="8.0.2" />
     <PackageReference Include="BootstrapBlazor.Dock" Version="8.1.7" />
-    <PackageReference Include="BootstrapBlazor.DockView" Version="8.1.3" />
+    <PackageReference Include="BootstrapBlazor.DockView" Version="8.1.4-beta01" />
     <PackageReference Include="BootstrapBlazor.DriverJs" Version="8.0.1" />
     <PackageReference Include="BootstrapBlazor.ElementIcon" Version="8.0.0" />
     <PackageReference Include="BootstrapBlazor.FileViewer" Version="8.0.3" />

src/BootstrapBlazor.Core/Extensions/EnumExtensions.cs

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>8.9.1-beta01</Version>
+    <Version>8.9.1-beta02</Version>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
@@ -63,10 +63,6 @@
     <None Include="wwwroot\src\**\*.*" />
   </ItemGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\BootstrapBlazor.Core\BootstrapBlazor.Core.csproj" />
-  </ItemGroup>
-
   <ItemGroup>
     <Using Include="BootstrapBlazor.Components" />
     <Using Include="Microsoft.AspNetCore.Components" />

src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

@@ -8,9 +8,8 @@
 namespace BootstrapBlazor.Core.Converter;
 
 /// <summary>
-/// 枚举类型转换器
+/// 枚举类型转换器 序列化时把枚举类型的 [Description] 标签内容序列化成字符串 推荐使用 <see cref="JsonEnumConverter"/> 转换器
 /// </summary>
-/// <remarks>序列化时把枚举类型序列化成字符串</remarks>
 public class JsonDescriptionEnumConverter<T> : JsonConverter<T> where T : struct, Enum
 {
     /// <summary>

src/BootstrapBlazor/BootstrapBlazor.csproj

@@ -0,0 +1,56 @@
+// Copyright (c) Argo Zhang ([email protected]). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace BootstrapBlazor.Core.Converter;
+
+/// <summary>
+/// JsonEnumConverter 枚举转换器
+/// </summary>
+public class JsonEnumConverter : JsonConverterAttribute
+{
+    /// <summary>
+    /// 构造函数
+    /// </summary>
+    public JsonEnumConverter() : base()
+    {
+
+    }
+
+    /// <summary>
+    /// 构造函数
+    /// </summary>
+    /// <param name="camelCase">Optional naming policy for writing enum values.</param>
+    /// <param name="allowIntegerValues">True to allow undefined enum values. When true, if an enum value isn't defined it will output as a number rather than a string.</param>
+    public JsonEnumConverter(bool camelCase, bool allowIntegerValues = true) : this()
+    {
+        CamelCase = camelCase;
+        AllowIntegerValues = allowIntegerValues;
+    }
+
+    /// <summary>
+    /// naming policy for writing enum values
+    /// </summary>
+    public bool CamelCase { get; private set; }
+
+    /// <summary>
+    /// True to allow undefined enum values. When true, if an enum value isn't defined it will output as a number rather than a string
+    /// </summary>
+    public bool AllowIntegerValues { get; private set; } = true;
+
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    /// <param name="typeToConvert"></param>
+    /// <returns></returns>
+    public override JsonConverter? CreateConverter(Type typeToConvert)
+    {
+        var converter = CamelCase
+                ? new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, AllowIntegerValues)
+                : new JsonStringEnumConverter(null, AllowIntegerValues);
+        return converter;
+    }
+}

src/BootstrapBlazor.Core/Converter/JsonDescriptionEnumConverter.cs renamed to src/BootstrapBlazor/Converter/JsonDescriptionEnumConverter.cs

@@ -12,6 +12,31 @@ namespace BootstrapBlazor.Components;
 /// </summary>
 public static class EnumExtensions
 {
+    /// <summary>
+    /// 获取 DescriptionAttribute 标签方法
+    /// </summary>
+    /// <param name="val"></param>
+    /// <returns></returns>
+    public static string ToDescriptionString<TEnum>(this TEnum val) where TEnum : Enum => typeof(TEnum).ToDescriptionString(val.ToString());
+
+    /// <summary>
+    /// 通过字段名称获取 DescriptionAttribute 标签值
+    /// </summary>
+    /// <param name="type"></param>
+    /// <param name="fieldName"></param>
+    /// <returns></returns>
+    public static string ToDescriptionString(this Type? type, string? fieldName)
+    {
+        var ret = string.Empty;
+        if (type != null && !string.IsNullOrEmpty(fieldName))
+        {
+            var t = Nullable.GetUnderlyingType(type) ?? type;
+            var attributes = t.GetField(fieldName)?.GetCustomAttribute<DescriptionAttribute>(true);
+            ret = attributes?.Description ?? fieldName;
+        }
+        return ret;
+    }
+
     /// <summary>
     /// 通过字段名称获取 DisplayAttribute/DescriptionAttribute 标签值
     /// </summary>

src/BootstrapBlazor/Converter/JsonEnumConverter.cs

@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <Version>8.0.2</Version>
+  </PropertyGroup>
+
+</Project>