Json.NET使用笔记

最新推荐文章于 2024-03-20 09:51:11 发布
最新推荐文章于 2024-03-20 09:51:11 发布
阅读量1.6k 收藏 4
点赞数 1
分类专栏： 自用笔记 文章标签： c# json .net
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ryse_Q1u/article/details/124394936
版权

文章目录

前言

本文是个人在工作中记录Json.NET使用笔记，简单的举例介绍了一下使用方法。

一、Json.NET是什么？

Json.Net是一个读写Json效率比较高的.Net框架.Json.Net 使得在.Net环境下使用Json更加简单,并且开源。本人主要用到了自定义Json序列化的功能。
下载地址： 官网地址 、GitHub
官方文档： 官方API.

二、使用步骤

1. 引入

引入包的方式有多种，这里直接就使用NuGget导入包
NuGget导入

2. JsonConverter的使用

简介：继承JsonConverter重写其方法可以自定义属性的序列化方式。
随便生成一个类
代码如下：

 public class Student
    {
        public int Age;
        public Sex Sex;
        public string Name { get; set; }
    }

    public enum Sex
    {
        boy,
        girl
    }

2.1 直接序列化

尝试将该类进行Json序列化操作
代码如下：

	//1.将对象序列化为Json字符串
	Student mm = new Student() { Age = 3, Name = "MM", Sex = Sex.girl };
	string jsonStr = JsonConvert.SerializeObject(mm);
 	Console.WriteLine(jsonStr);

查看运行结果：
直接序列化结果
可以看到枚举类型被换成了int类型，传给前端可能不易理解。

2.2 构建转换器

接下来我们再新建一个类，并且继承JsonConverter，重写其方法。
代码如下：

	/// <summary>
    /// 自定义属性转换类
    /// </summary>
    public class SexCustomSerializable : JsonConverter
    {
        //表示反序列化时是否执行该转换器
        public override bool CanRead => true;

        //表示序列化时是否执行该转换器
        public override bool CanWrite => true;

        //判断执行条件（可以判断类型是否符合再执行转换）
        public override bool CanConvert(Type objectType)
        {
            return objectType == typeof(Sex);
        }

        //反序列化时执行的转换方法
        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            Sex sex = Sex.boy;
            Enum.TryParse<Sex>(reader.Value.ToString(), out sex);
            return sex;
        }

        /// 序列化时执行的转换
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            //string v = value.ToString();
            writer.WriteValue(value.ToString());
        }
    }

2.3 使用转换器

转换器使用方法很简单，在对应的属性上加上标签即可
代码如下：

 public class Student
    {
        public int Age;

        [JsonConverter(typeof(SexCustomSerializable))]
        public Sex Sex;

        public string Name { get; set; }
    }

2.4 使用转换器序列化效果

查看运行结果：
效果图
可以看到枚举类型根据我们转换器重写的WriteJson方法toString输出了。
当然，如果只需要把枚举类型从int转换到String输出，Json.NET有封装好的转换器给我们用。

2.5 StringEnumConverter使用

代码如下：

 public class Student
    {
        public int Age;

        [JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }
    }

查看运行结果：
在这里插入图片描述
可以看到，效果是和我们写的是一样的。

3. JsonProperty与JsonIgnore的使用

简介：使用[JsonIgnore]标签可以是实体类在序列化时忽略该属性，[JsonProperty]与之相反。

3.1 JsonIgnore使用

实体类是默认会在Json序列化时，转换全部的属性，如果有不需要的可以打上[JsonIgnore]标签，其实默认的实体类会有[JsonObject(MemberSerialization.OptOut)]标签，表示转换全部属性。

 public class Student
    {
        [JsonIgnore]
        public int Age;

        [JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }
    }

结果：
图片描述

3.3 JsonProperty使用

[JsonProperty]与[JsonIgnore]效果相反，在有[JsonObject(MemberSerialization.OptIn)]的实体类里面指定属性转换。

[JsonObject(MemberSerialization.OptIn)]
 public class Student
    {
        [JsonProperty]
        public int Age;
		[JsonProperty]
        [JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }
    }

结果：
图片描述

3.4 JsonProperty序列化非公属性

 public class Student
    {
        //[JsonProperty]
        public int Age;

        //[JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }

        [JsonProperty]
        private DateTime born;

        public void SetBron(DateTime date)
        {
            born = date;
        }

        public DateTime GetBron()
        {
            return born;
        }
    }

			Student gg = new Student() { Age = 5, Sex = Sex.boy };
            gg.SetBron(DateTime.Now.ToLocalTime());
            Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();
            JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                //添加性别枚举转换器
                setting.Converters.Add(new SexCustomSerializable());
                //对时间的处理
                setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
                return setting;
            });

结果：
结果图

3.5 JsonProperty修改序列化属性名称

一般情况实体类都不能随意修改，在序列化与反序列化时可以自定义序列化出字符串的属性名称。
代码：

public class Student
    {
        //[JsonProperty]
        public int Age;

        //[JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }

        [JsonProperty(PropertyName = "BornDay")]
        private DateTime born;

        public void SetBron(DateTime date)
        {
            born = date;
        }

        public DateTime GetBron()
        {
            return born;
        }
    }

Student gg = new Student() { Age = 5, Sex = Sex.boy };
            gg.SetBron(DateTime.Now.ToLocalTime());
            Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();

            //JsonSerializerSettings setting = new JsonSerializerSettings();
            //string jsonStr = JsonConvert.Serializeobject(p, Newtonsoft.Json.Formatting.Indented, setting);
            JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                //添加性别枚举转换器
                setting.Converters.Add(new SexCustomSerializable());
                //对时间的处理
                setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
                return setting;
            });
            string ggStr = JsonConvert.SerializeObject(gg);

结果：
图片描述

4. DefaultContractResolver的使用

简介：继承DefaultContractResolver类重写其方法，可以实现动态决定属性序列化。
这里新建一个StudentPropsContractResolver类继承DefaultContractResolver，并且重写其方法。
代码：

public class StudentPropsContractResolver : DefaultContractResolver
    {
        /// <summary>
        /// 需要处理的属性名
        /// </summary>
        private string[] props = null;

        /// <summary>
        /// 属性是否需要序列化
        /// (一般都是指定哪些属性不序列化的多，但这里加入该属性可以应对两种情况)
        /// </summary>
        private bool serialize;

        public StudentPropsContractResolver(string[] props, bool retain = true)
        {
            this.props = props;
            this.serialize = retain;
        }

        protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
        {
            //原方法里面有注释，看不懂的也可以自己调试一下就明白参数都是啥了
            //获取类的属性
            IList<JsonProperty> list = base.CreateProperties(type, memberSerialization);
            //只保留数组中的属性
            return list.Where(p =>
            {
                if (serialize)
                {
                    return props.Contains(p.PropertyName);
                }
                else
                {
                    return !props.Contains(p.PropertyName);
                }
            }).ToList();
        }
    }

执行代码：

            //1.将对象序列化为Json字符串
            Student mm = new Student() { Age = 3, Name = "MM", Sex = Sex.girl };
            string jsonStr = JsonConvert.SerializeObject(mm);

            JsonSerializerSettings jsetting = new JsonSerializerSettings();
            jsetting.ContractResolver = new StudentPropsContractResolver(new string[] { "Age", "Sex" });
            Console.WriteLine(JsonConvert.SerializeObject(mm, jsetting));
            jsetting.ContractResolver = new StudentPropsContractResolver(new string[] { "Name", "Sex" });
            Console.WriteLine(JsonConvert.SerializeObject(mm, jsetting));
            Console.ReadLine();

结果：
运行效果
可以看到通过重写DefaultContractResolver方法可以实现动态决定属性序列化。

5. 通过JsonConvert.DefaultSettings全局设置

简介：有时候我们需要设置一下通用的规则，可以在JsonConvert.DefaultSettings不用再给每一个属性打标签了。

5.1 NullValueHandling的全局设置

在这里想把null的属性不序列化了。
代码：

Student gg = new Student() { Age = 5, Sex = Sex.boy };
            Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();
            string ggStr = JsonConvert.SerializeObject(gg);
            Console.WriteLine(ggStr);
            Console.ReadLine();

结果：
效果图
可以看到name没有赋值输出了null,可能会给前端带了一些困扰，而且值也没有什么意义，当然也可以直接设置jsetting.NullValueHandling = NullValueHandling.Ignore来让空值不序列化。

 [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
 public String Name { get; set; }

Json.Net提供了全局设置，方便我们操作。
代码：

			Student gg = new Student() { Age = 5, Sex = Sex.boy };
            Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();
            JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                return setting;
            });
            string ggStr = JsonConvert.SerializeObject(gg);

效果：
效果图

5.2 Converters的全局设置

当然，默认设置不仅仅可以设置null不序列化，还可以把我们刚才创建的转换器添加到设置里。
代码：

 JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                //添加性别枚举转换器
                setting.Converters.Add(new SexCustomSerializable());
                return setting;
            });

实体类去除标签：

public class Student
    {
        //[JsonProperty]
        public int Age;

        //[JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }
    }

结果：

效果图
当然，还有对时间格式的处理
代码：

JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                //添加性别枚举转换器
                setting.Converters.Add(new SexCustomSerializable());
                //对时间的处理
                setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
                return setting;
            });

结果：
结果图

6. 注意事项

前面也有说到实体类一般不会去动他，这个也包括打标签等操作，在实际开发中，一个实体类越简单越好。所以以下使用方法比较规范一些。
代码：

 public class Student
    {
        //[JsonProperty]
        public int Age;

        //[JsonConverter(typeof(StringEnumConverter))]
        public Sex Sex;

        public string Name { get; set; }

        //[JsonProperty(PropertyName = "BornDay")]
        private DateTime born;

        public void SetBron(DateTime date)
        {
            born = date;
        }

        public DateTime GetBron()
        {
            return born;
        }
    }

Student gg = new Student() { Age = 5, Sex = Sex.boy };
            gg.SetBron(DateTime.Now.ToLocalTime());
            Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();
            JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>
            {
                //空值处理
                setting.NullValueHandling = NullValueHandling.Ignore;
                var contractResolver = new StudentPropsContractResolver(new string[] { "Age", "Sex", "bron" });
                contractResolver.IgnoreSerializableAttribute = true;
                setting.ContractResolver = contractResolver;
                //添加性别枚举转换器
                setting.Converters.Add(new SexCustomSerializable());
                //对时间的处理
                setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
                return setting;
            });
            string ggStr = JsonConvert.SerializeObject(gg);

总结

Newtonsoft.Json序列化库提供了很多Json序列化有关的特性方便我们开发，学会使用是不难的，上面列举的只是一部分功能，更多的功能可以到官网文档进行学习。

Ryse_Q1u
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JSON.NET使用简单说明
狼行天下
06-21 992
NewtonJson算是比较常用的json解析库了，我的项目中基本都使用该库，因为Unity上也有其相关的库，所以保证了多种项目之间的统一。同时NewtonJson的序列化和反序列化的接口比较简单，相对的功能也比较强大。不过在使用中也不是没有坑的，所以把一些心得记录下，以备日后查询。 序列化和反序列化 序列化和反序列化很简单，调用相关的接口即可。反序列化的时候可以指定泛型参数，直接解析成对应的
.net6使用最小api（7）— 自定义加载json配置文件
hailang2ll的专栏
04-17 2474
前言最常用的加载json配置文件，采用微软自带的方法AddJsonFile，这时可通过Configuration来读取配置信息，有时为了了解原理，我们自己写重写一个加载配置的方法，下面我们来实战一下。往期最小api文章回顾.net6使用最小api（1）——依赖注入Autofac之构造函数注入.net6使用最小api（2）——依赖注入Autofac之属性注入.net6使用最...
Json.net的高级用法
qq_27410185的博客
10-20 580
在前后端使用Json进行数据交互的时候，很多情况下我们定义的实体类与前端所需要的Json格式的字段或者值并不能保持一致，所以我们需要在尽量改动小的情况下以满足以上场景； 所以这篇写一下关于Json.net的一些小操作。 我们有以下实体类 private class Studet { public string name { get; set; } public int age { get; set; } public string idCard { get; set;
什么是Jsonnet
qq_15821487的博客
11-08 518
Jsonnet是Google开源的一门配置语言，用于弥补JSON所暴露的短板，它完全兼容JSON，并加入了JSON所没有的一些特性，包括注释、引用、算数运算、条件操作符、数组和对象深入、引入函数、局部变量、继承等，Jsonnet程序被编译为兼容JSON的数据格式。简单来说Jsonnet就是增强版JSON。
C# 解析JSON详解
一名热爱技术的工程师的博客。分享技术干货，记录美好生活。永远相信美好的事情即将发生。
09-26 8204
JSON的全称是，是一种轻量级的数据交换格式，主要用于数据的序列化和交互。
探索 Jsonnet：优雅的数据配置语言与工具
最新发布
gitblog_00061的博客
03-20 224
探索 Jsonnet：优雅的数据配置语言与工具 项目地址:https://gitcode.com/google/jsonnet Jsonnet 是一个增强型的 JSON 数据配置语言，由 Google 开发并维护。它在 JSON 的基础上增加了表达性和可读性，使得数据结构的描述更加灵活且强大。GitCode 上的 Jsonnet 仓库提供了源代码和相关文档，方便开发者进行学习和应用。 项目简介 J...
json 入门学习笔记 示例代码
12-01
 json.net 下载地址 http://json.codeplex.com/releases/view/37810 Demo: 　 描述：　点击获取按钮后，将请求页面，获取json数据，填充到表格html代码： 代码如下: <!DOCTYPE html PUBLIC “-//W3C//DTD XHTML ...
.Net学习笔记之Layui多图片上传功能
10-16
本篇笔记将深入探讨如何在.NET环境中实现Layui的多图片上传功能。 首先，确保你的项目已经引入了Layui的相关资源。在HTML中，你需要链接到Layui的CSS和JS文件。通常，这可以通过以下方式完成： ```html 路径/to/...
JSON 入门教程基础篇 json入门学习笔记
01-18
JSON: JavaScript Object Notation(JavaScript 对象表示法) JSON 是存储和交换文本信息的语法。类似 XML。 JSON 比 XML 更小、更快，更易解析。 JSON 实例 { sites: [ { name:软件开发网 , url:www.jb51.net }, ...
.Net Core学习记录笔记
08-26
.NET Core 学习记录笔记 ...本文为 .NET Core 学习记录笔记的其中一部分，旨在帮助读者理解如何使用 .NET Core 实现数据库映射。如果您想了解更多关于 .NET Core 的知识，请继续阅读我们的学习记录笔记。
Json.net下载
06-18
2012年新版本json.net，ajax后台数据处理的好东西，哈哈,这个不用多介绍吧！
JSON NET For Unity 2.0.1.rar
03-26
大家在用U3D开发时 经常会遇到JSON的读取与写入，U3D自带的JsonUtility和现在用到的比较多的LitJson dll 都不支持IOS手机上的读取 我这个.net for Unity 支持PC 安卓 苹果 实测。解压放进Plugins就行了
Json.NET:.NET 流行的高性能 JSON 框架-开源
07-14
使用 Json.NET 强大的 JSON 序列化器序列化和反序列化任何 .NET 对象。 使用 Json.NET 的 JObject、JArray 和 JValue 对象创建、解析、查询和修改 JSON。 使用类似 XPath 的语法查询 JSON。 比 DataContractJsonSerializer 快 50%，比 JavaScriptSerializer 快 250%。 Json.NET 让简单变得简单，也让复杂变得可能。 如果需要，Json.NET 支持在 XML 和 JSON 之间进行转换。 Json.NET 是开源软件，完全免费用于商业用途。 Json.NET 支持 Windows、MacOS、Linux、Mono 和 Xamarin。 Json.NET 的下载量超过 10 亿次，并且是 NuGet 上排名第一的库。 Json.NET 文档是第一个寻求帮助的地方。 它包括 100 多个代码示例。 Json.NET 在 MIT 许可下是开源的，可免费用于商业用途。
C#ASP.NET个人笔记_2012年
02-24
这份笔记是我2012年年内对ASP.NET相关知识点和使用方法、技巧、设计思路的整理笔记，主要内容为ASP.NET（包括控件，Server，session等对象，加密方式，常用类库，发布、部署等），其中也包括JS,JQuery(部分，剩余...
C#中Newtonsoft.Json(Json.NET)的使用和处理json格式数据
热门推荐
sinat_37281674的博客
08-29 3万+
C#关于json的一些操作C#中Newtonsoft.Json(Json.NET)的使用添加Newtonsoft.Json.dll引用：下载Newtonsoft.Json.dll：在项目中添加：Newtonsoft.Json的使用添加头文件引用json格式的处理如何将http的request的json格式数据写入到我们的类中比较好的链接 C#中Newtonsoft.Json(Json.NET)的使用 添加Newtonsoft.Json.dll引用： 处理json格式需要添加Newtonsoft.Json.d
ASP.NET 处理 JSON
奇妙的代码
06-12 979
作为后端，有可能需要接收来自前端提交的 json 格式的数据，也有可能需要往前端发送 json 格式的数据，这里以分类作为示例，介绍下在 ASP.NET 处理程序中是如何跟前端进行数据交换的。
ASP.NET MVC小改裝 - 以Json.NET取代JavaScriptSerializer
彷徨de等待
04-09 2617
转自：http://blog.darkthread.net/post-2012-08-30-asp-net-mvc-and-json-net.aspx 在前篇文章中，我們實測驗證ASP.NET MVC 4的JsonResult採用JavaScriptSerializer進行JSON序列化，然而若要100%確認，其實還有更精準的做法--因為ASP.NET MVC 4是一個Open So
Json.NET读写Json文件
anyx的专栏
02-23 2万+
Json文件的写入读取 采用的Json.NET提供的API。 http://james.newtonking.com/projects/json-net.aspx http://www.codeplex.com/json/ 以下是demo代码 using System; using System.Collections.Generic; using System.Linq
esp32使用json
08-13
esp32使用json的步骤可以分为以下几步： 1. 引用中的方法，使用`deserializeJson`函数对接收到的json文件进行解析。该函数接受两个参数，第一个参数是建立的DynamicJsonDocument对象，第二个参数是获取到的json文件（类型为String）。 2. 根据引用中的内容，了解JSON的基础概念、语法规则和数据类型。JSON包括数字、字符串、逻辑值、数组和对象等数据类型。 3. 以引用中的解析JSON数据为例，可以使用`cJSON_Parse`函数将给定的JSON字符串转换为cJSON对象。 4. 使用相应的库函数来操作cJSON对象，例如使用`cJSON_GetObjectItem`函数根据键获取对应的值，使用`cJSON_GetArrayItem`函数根据下标获取cJSON对象数组中的对象，使用`cJSON_AddStringToObject`函数新增一个字符串类型的字段到JSON格式的数据等。 5. 在使用完cJSON对象后，使用`cJSON_Delete`函数释放链表占用的内存空间。 总结起来，使用ESP32处理JSON数据的过程包括解析JSON数据、操作cJSON对象以及释放内存空间等步骤。根据具体的需求和场景，可以使用不同的库函数来实现相应的功能。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [ESP32超详细学习记录：JSON解析（利用ArduinoJson库）](https://blog.csdn.net/qq_41650023/article/details/124668884)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 33.333333333333336%"] - *2* [【ESP32_8266_WiFi (九)】JSON基础](https://blog.csdn.net/K3169/article/details/127838227)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 33.333333333333336%"] - *3* [ESP8266学习笔记（8）——第三方库cJSON使用](https://blog.csdn.net/qq_36347513/article/details/86691835)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 33.333333333333336%"] [ .reference_list ]

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值