Просмотр исходного кода

✨feat(JSON序列化): 新增自定义JsonProperty特性和转换器

喵你个旺呀 11 месяцев назад
Родитель
Сommit
d4daf01361

+ 20 - 0
Admin.NET/Admin.NET.Core/Attribute/CustomJsonPropertyAttribute.cs

@@ -0,0 +1,20 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+// 
+// 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+// 
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
+
+namespace Admin.NET.Core;
+
+/// <summary>
+/// 自定义Json转换字段名
+/// </summary>
+[AttributeUsage(AttributeTargets.Property)]
+public class CustomJsonPropertyAttribute : Attribute
+{
+    public string Name { get; }
+    public CustomJsonPropertyAttribute(string name)
+    {
+        Name = name;
+    }
+}

+ 188 - 0
Admin.NET/Admin.NET.Core/Utils/CustomJsonPropertyConverter.cs

@@ -0,0 +1,188 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+// 
+// 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+// 
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
+
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Admin.NET.Core;
+
+/// <summary>
+/// 自定义属性名称转换器
+/// </summary>
+public class CustomJsonPropertyConverter : JsonConverter<object>
+{
+    public static readonly JsonSerializerOptions Options = new()
+    {
+        Converters = { new CustomJsonPropertyConverter() },
+        DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    };
+
+    // 缓存类型信息避免重复反射
+    private static readonly ConcurrentDictionary<Type, IReadOnlyList<PropertyMeta>> PropertyCache = new();
+    
+    // 日期时间格式化配置
+    private readonly string _dateTimeFormat;
+    
+    public CustomJsonPropertyConverter(string dateTimeFormat = "yyyy-MM-dd HH:mm:ss")
+    {
+        _dateTimeFormat = dateTimeFormat;
+    }
+
+    public override bool CanConvert(Type typeToConvert)
+    {
+        return PropertyCache.GetOrAdd(typeToConvert, type => 
+            type.GetProperties()
+                .Where(p => p.GetCustomAttribute<CustomJsonPropertyAttribute>() != null)
+                .Select(p => new PropertyMeta(p))
+                .ToList().AsReadOnly()
+        ).Count > 0;
+    }
+
+    public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        var jsonDoc = JsonDocument.ParseValue(ref reader);
+        var instance = Activator.CreateInstance(typeToConvert);
+        var properties = PropertyCache.GetOrAdd(typeToConvert, BuildPropertyMeta);
+
+        foreach (var prop in properties)
+        {
+            if (jsonDoc.RootElement.TryGetProperty(prop.JsonName, out var value))
+            {
+                object propertyValue;
+                
+                // 特殊处理日期时间类型
+                if (IsDateTimeType(prop.PropertyType))
+                {
+                    propertyValue = HandleDateTimeValue(value, prop.PropertyType);
+                }
+                else
+                {
+                    propertyValue = JsonSerializer.Deserialize(
+                        value.GetRawText(), 
+                        prop.PropertyType, 
+                        options
+                    );
+                }
+                
+                prop.SetValue(instance, propertyValue);
+            }
+        }
+        
+        return instance;
+    }
+
+    public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
+    {
+        writer.WriteStartObject();
+        var properties = PropertyCache.GetOrAdd(value.GetType(), BuildPropertyMeta);
+
+        foreach (var prop in properties)
+        {
+            var propertyValue = prop.GetValue(value);
+            
+            writer.WritePropertyName(prop.JsonName);
+            
+            // 特殊处理日期时间类型
+            if (propertyValue != null && IsDateTimeType(prop.PropertyType))
+            {
+                writer.WriteStringValue(FormatDateTime(propertyValue));
+            }
+            else
+            {
+                JsonSerializer.Serialize(writer, propertyValue, options);
+            }
+        }
+        
+        writer.WriteEndObject();
+    }
+
+    private static IReadOnlyList<PropertyMeta> BuildPropertyMeta(Type type)
+    {
+        return type.GetProperties()
+            .Select(p => new PropertyMeta(p))
+            .ToList().AsReadOnly();
+    }
+
+    private object HandleDateTimeValue(JsonElement value, Type targetType)
+    {
+        var dateStr = value.GetString();
+        if (string.IsNullOrEmpty(dateStr)) return null;
+
+        var date = DateTime.Parse(dateStr);
+        return targetType == typeof(DateTimeOffset) 
+            ? new DateTimeOffset(date) 
+            : (object)date;
+    }
+
+    private string FormatDateTime(object dateTime)
+    {
+        return dateTime switch
+        {
+            DateTime dt => dt.ToString(_dateTimeFormat),
+            DateTimeOffset dto => dto.ToString(_dateTimeFormat),
+            _ => dateTime?.ToString()
+        };
+    }
+
+    private static bool IsDateTimeType(Type type)
+    {
+        var actualType = Nullable.GetUnderlyingType(type) ?? type;
+        return actualType == typeof(DateTime) || actualType == typeof(DateTimeOffset);
+    }
+
+    private class PropertyMeta
+    {
+        private readonly PropertyInfo _property;
+        private readonly Func<object, object> _getter;
+        private readonly Action<object, object> _setter;
+        
+        public string JsonName { get; }
+        public Type PropertyType => _property.PropertyType;
+
+        public PropertyMeta(PropertyInfo property)
+        {
+            _property = property;
+            JsonName = property.GetCustomAttribute<CustomJsonPropertyAttribute>()?.Name ?? property.Name;
+            
+            // 编译表达式树优化属性访问
+            var instanceParam = Expression.Parameter(typeof(object), "instance");
+            var valueParam = Expression.Parameter(typeof(object), "value");
+            
+            // Getter
+            var getterExpr = Expression.Lambda<Func<object, object>>(
+                Expression.Convert(
+                    Expression.Property(
+                        Expression.Convert(instanceParam, property.DeclaringType), 
+                        property),
+                    typeof(object)),
+                instanceParam);
+            _getter = getterExpr.Compile();
+            
+            // Setter
+            if (property.CanWrite)
+            {
+                var setterExpr = Expression.Lambda<Action<object, object>>(
+                    Expression.Assign(
+                        Expression.Property(
+                            Expression.Convert(instanceParam, property.DeclaringType), 
+                            property),
+                        Expression.Convert(valueParam, property.PropertyType)),
+                    instanceParam, valueParam);
+                _setter = setterExpr.Compile();
+            }
+        }
+
+        public object GetValue(object instance) => _getter(instance);
+        
+        public void SetValue(object instance, object value)
+        {
+            if (_setter != null)
+            {
+                _setter(instance, value);
+            }
+        }
+    }
+}