C# Newtonsoft自定义JsonConverter的实现
更新时间：2025年03月20日 08:58:46 作者：likepoems
本文介绍了在C#中使用Newtonsoft库进行JSON对象和字符串的序列化与反序列化,具有一定的参考价值,感兴趣的可以了解一下
在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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
公司电脑各式各样的都有，里面的设置也有很多不统一的，我们做软件一般会从系统中获取一些数据，比如日期时间，环境变量的路径参数，可以用批处理文件达到我们所想要的目的，也可以用C#代码2013-03-03
这篇文章主要为大家详细介绍了Unity实现瞄准镜效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-04-04
这篇文章介绍了三层架构的工作原理，二层与三层架构的区别，三层架构的优劣势。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-12-12
这篇文章主要介绍了C# WinForm中禁止改变窗口大小的方法,需要把FormBorderStyle和MaximizeBox的值固定即可,需要的朋友可以参考下2014-08-08
这篇文章主要介绍了C#实现简单播放mp3的方法,涉及C#播放多媒体文件的技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-03-03
详解ObjectARX开发环境的创建与开发实例Hello World(VS2005+AutoCad2008+Object
这篇文章主要介绍了ObjectARX开发环境的创建与开发实例Hello World(VS2005+AutoCad2008+ObjectArx2008),本文通过图文实例相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-04-04
这篇文章主要为大家详细介绍了如何利用C#语言实现一键清空控件值的功能，文中的示例代码讲解详细，对我们学习C#有一定帮助，需要的可以参考一下2022-09-09
这篇文章主要为大家分享了两个使用C#编写的两个漂亮时钟的示例代码，文中的示例代码讲解详细，具有一定的参考价值，感兴趣的可以了解一下2023-07-07
在日常办公和开发中,我们经常需要将Word文档转换为RTF格式,本文将介绍一种易集成的 C# 解决方案 - 使用 Spire.Doc for .NET 实现 Word 转 RTF,帮助开发者快速完成文档格式转换,需要的朋友可以参考下2025-09-09
这篇文章主要为大家详细介绍了C# OpenVINO如何实现图片旋转角度检测,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下2024-02-02
最新评论