C# Newtonsoft自定义JsonConverter的实现
在C#中，我们使用Newtonsoft来对JSON对象或字段串进行序列化和反序列化的操作，但在某些场景下，需要在映射过程中需要对属性进行更改。
1、JsonProperty
JsonProperty用于指定特定字段的名称，将一个字段指定为另一个字段，示例如下：
public class UserInfo
{
[JsonProperty("用户名")]
public string Name { get; set; }
[JsonProperty("年龄")]
public string Age { get; set; }
}
var tom = new UserInfo{Name = 'Tom', Age = 20};
var jsonstr = JsonConvert.SerializeObject(tom);
var json = JsonConvert.DeserializeObject<UserInfo>(jsonstr);
这时jsonstr的值就是{“用户名”:“Tom”,“年龄”:20};
但是这会有个问题，json对象的Name和Age都是null;
原因是指定的字段名不匹配，也就是说json字符串中字段名要与JsonProperty的值相同才能正确的映射。
2、自定义JsonConverter
public class JsonToChineseConverter<T> : JsonConverter
{
public override bool CanConvert(Type objectType)
{
return objectType == typeof(T);
}
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
JObject jsonObject = JObject.Load(reader);
T targetObject = (T)Activator.CreateInstance(objectType);
foreach (var property in objectType.GetProperties())
{
NameAttribute nameAttribute = property.GetCustomAttribute<NameAttribute>();
string propertyName = nameAttribute != null ? nameAttribute.ChineseName : property.Name;
if (jsonObject[propertyName] != null)
{
property.SetValue(targetObject, jsonObject[propertyName].ToObject(property.PropertyType, serializer));
}
}
return targetObject;
}
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
JObject jsonObject = new JObject();
Type objectType = value.GetType();
foreach (var property in objectType.GetProperties())
{
NameAttribute nameAttribute = property.GetCustomAttribute<NameAttribute>();
string propertyName = nameAttribute != null ? nameAttribute.ChineseName : property.Name;
jsonObject[propertyName] = JToken.FromObject(property.GetValue(value), serializer);
}
jsonObject.WriteTo(writer);
}
}
[AttributeUsage(AttributeTargets.Property)]
public class NameAttribute : Attribute
{
public string ChineseName {
get;
}
public NameAttribute(string chineseName)
{
ChineseName = chineseName;
}
}
说明：
JsonToChineseConverter 是一个泛型的类，继承JsonConverter，用于在 JSON 序列化和反序列化过程中，将 JSON 中的字段名从中文名称映射到 C# 对象的属性名，或者反过来将 C# 对象的属性名映射为中文名称。
该类通过自定义特性 [NameAttribute] 来对类的属性进行标记，并指定它的中文名称，如果没有标记，则使用本身的属性。
CanConvert：判断当前转换器是否适用于指定的类型 T。
ReadJson：在反序列化时，将 JSON 数据转换为 C# 对象。根据 [NameAttribute] 的中文名称找到对应的属性并赋值。
WriteJson：在序列化时，将 C# 对象转换为 JSON 数据。根据 [NameAttribute] 的中文名称生成对应的 JSON 字段。
使用方法：
public class UserInfo
{
[Name("用户名")]
public string Name { get; set; }
[Name("年龄")]
public string Age { get; set; }
}
var tom = new UserInfo{Name = 'Tom', Age = 20};
var setting = new JsonToChineseConverter<UserInfo>();
var jsonstr = JsonConvert.SerializeObject(tom, setting);
var json = JsonConvert.DeserializeObject<UserInfo>(jsonstr, setting);
Console.WriteLine(jsonstr); // {"用户名":"Tom","年龄":20}
json对象：
Name：Tom
Age: 20
到此这篇关于C# Newtonsoft自定义JsonConverter的实现的文章就介绍到这了,更多相关C# 自定义JsonConverter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
日志记录是软件开发中不可或缺的功能,它能帮助开发者在应用程序运行时记录重要信息,本文就来介绍一下常用日志记录功能以及常用的日志库,感兴趣的可以了解一下2024-03-03
这篇文章主要为大家详细介绍了如何利用WPF DrawingContext实现绘制刻度条，文中的示例代码讲解详细，对我们学习或工作有一定帮助，感兴趣的小伙伴可以了解一下2022-09-09
这篇文章主要为大家详细介绍了C#使用WebSocket实现聊天室功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-02-02
c# WPF中System.Windows.Interactivity的使用
这篇文章主要介绍了c# WPF中System.Windows.Interactivity的使用，帮助大家更好的理解和学习使用c#，感兴趣的朋友可以了解下2021-03-03
本篇文章是对在C#中使用SqlDbType.Xml类型参数的使用进行了详细的分析介绍，需要的朋友参考下2013-05-05
这篇文章主要介绍了C#配置文件Section节点处理总结,针对配置文件Section节点的处理做了较为详细的实例总结,需要的朋友可以参考下2014-10-10
事件总线是一种用于在应用程序内部或跨应用程序组件之间进行事件通信的机制，本文主要介绍了C#实现事件总线的方法示例，具有一定的参考价值，感兴趣的可以了解一下2024-02-02
详解C# IComparable和IComparer接口和自定义比较器
本文主要介绍了详解C# IComparable和IComparer接口和自定义比较器,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2025-07-07
这篇文章主要为大家详细介绍了Unity常用命令模式的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-03-03
在写一些实体类的时候，我们往往在写构造方法的时候思考很长时间，除了一个无参构造器外还在想需要写几个构造器呢？哪些参数是需要初始化的。现在你再也不需要为这事烦恼了2014-12-12
最新评论