c# - System.Text.Json 将字典序列化为数组
问题描述
是否可以使用 System.Text.Json 将字典序列化(和反序列化)为数组?
而不是{ "hello": "world" }
我需要将我的字典序列化为{ "key": "hello", "value": "world" }
最好,而不必在我的类的字典属性上设置属性。
使用 newtonsoft.json 可以这样:
class DictionaryAsArrayResolver : DefaultContractResolver
{
protected override JsonContract CreateContract(Type objectType)
{
if (objectType.GetInterfaces().Any(i => i == typeof(IDictionary) ||
(i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IDictionary<,>))))
{
return base.CreateArrayContract(objectType);
}
return base.CreateContract(objectType);
}
}
解决方案
您可以使用为要序列化为数组的每个字典类型JsonConverterFactory
制造特定的 a 来执行此操作。JsonConverter<T>
这是一个适用于每个实现的类的转换器IDictionary<TKey, TValue>
:
public class DictionaryConverterFactory : JsonConverterFactory
{
public override bool CanConvert(Type typeToConvert)
{
return typeToConvert.IsClass && typeToConvert.GetDictionaryKeyValueType() != null && typeToConvert.GetConstructor(Type.EmptyTypes) != null;
}
public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
{
var keyValueTypes = typeToConvert.GetDictionaryKeyValueType();
var converterType = typeof(DictionaryAsArrayConverter<,,>).MakeGenericType(typeToConvert, keyValueTypes.Value.Key, keyValueTypes.Value.Value);
return (JsonConverter)Activator.CreateInstance(converterType);
}
}
public class DictionaryAsArrayConverter<TKey, TValue> : DictionaryAsArrayConverter<Dictionary<TKey, TValue>, TKey, TValue>
{
}
public class DictionaryAsArrayConverter<TDictionary, TKey, TValue> : JsonConverter<TDictionary> where TDictionary : class, IDictionary<TKey, TValue>, new()
{
struct KeyValueDTO
{
public TKey Key { get; set; }
public TValue Value { get; set; }
}
public override TDictionary Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
var list = JsonSerializer.Deserialize<List<KeyValueDTO>>(ref reader, options);
if (list == null)
return null;
var dictionary = typeToConvert == typeof(Dictionary<TKey, TValue>) ? (TDictionary)(object)new Dictionary<TKey, TValue>(list.Count) : new TDictionary();
foreach (var pair in list)
dictionary.Add(pair.Key, pair.Value);
return dictionary;
}
public override void Write(Utf8JsonWriter writer, TDictionary value, JsonSerializerOptions options)
{
JsonSerializer.Serialize(writer, value.Select(p => new KeyValueDTO { Key = p.Key, Value = p.Value }), options);
}
}
public static class TypeExtensions
{
public static IEnumerable<Type> GetInterfacesAndSelf(this Type type)
{
if (type == null)
throw new ArgumentNullException();
if (type.IsInterface)
return new[] { type }.Concat(type.GetInterfaces());
else
return type.GetInterfaces();
}
public static KeyValuePair<Type, Type>? GetDictionaryKeyValueType(this Type type)
{
KeyValuePair<Type, Type>? types = null;
foreach (var pair in type.GetDictionaryKeyValueTypes())
{
if (types == null)
types = pair;
else
return null;
}
return types;
}
public static IEnumerable<KeyValuePair<Type, Type>> GetDictionaryKeyValueTypes(this Type type)
{
foreach (Type intType in type.GetInterfacesAndSelf())
{
if (intType.IsGenericType
&& intType.GetGenericTypeDefinition() == typeof(IDictionary<,>))
{
var args = intType.GetGenericArguments();
if (args.Length == 2)
yield return new KeyValuePair<Type, Type>(args[0], args[1]);
}
}
}
}
然后将工厂添加到JsonSerializerOptions.Converters
本地如下:
var options = new JsonSerializerOptions
{
Converters = { new DictionaryConverterFactory() },
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
};
var json = JsonSerializer.Serialize(dictionary, options);
var dictionary2 = JsonSerializer.Deserialize<TDictionary>(json, options);
或全局在 ASP.NET Core 中,如如何在 asp.net core 3 中设置 json 序列化程序设置?:
services.AddControllers().AddJsonOptions(options =>
{
options.JsonSerializerOptions.Converters.Add(new DictionaryConverterFactory());
options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
});
DictionaryAsArrayConverter<TKey, TValue>
如果您只想将某些字典类型序列化为数组,也可以直接使用底层的单个转换器。
笔记:
JsonSerializer
PropertyNamingPolicy
目前在序列化时不尊重KeyValuePair<TKey, TValue>
(参见Issue #1197),所以我不得不引入 aKeyValueDTO
来获取外壳"key"
并"value"
根据您的问题要求。我没有为非泛型
IDictionary
类型实现转换器。这可以作为答案的扩展来完成。有关转换器工厂模式的更多信息,请参阅如何在 .NET 中为 JSON 序列化编写自定义转换器:示例工厂模式转换器
等价于
DefaultContractResolver
inSystem.Text.Json
--JsonClassInfo
和JsonPropertyInfo
-- 的类型是internal。System.Text.Json #42001 中有一个 DefaultContractResolver的开放增强等效项,要求提供一个公共等效项。
演示小提琴在这里。
推荐阅读
- .net - Azure 工件中的随机 NuGet 包
- javascript - 如何使用 jQuery/JavaScript 在标题右侧生成一个元素?
- c++ - 如何在 C++ 中使用 packaged_task 实现异步等待循环?
- ios - 处理 WebView 中的通知单击
- node.js - 使用异步 - 等待与 socket.io nodejs
- flutter - 在 Flutter 中集成 getstream 活动提要
- git - 如何在不检查存储库的情况下从 refs/heads/xyz 获取分支名称?
- javascript - konva js试图将圆形属性变量传递给函数
- python - Django框架中的循环导入
- javascript - 使用 Javascript Request fetch 向 RouteXL 发送 x-www-form-urlencoded 请求