Newtonsoft.Json高级用法

From: http://www.cnblogs.com/yanweidie/p/4605212.html

　　手机端应用讲究速度快，体验好。刚好手头上的一个项目服务端接口有性能问题，需要进行优化。在接口多次修改中，实体添加了很多字段用于中间计算或者存储，然后最终用Newtonsoft.Json进行序列化返回数据，经过分析一个简单的列表接口每一行数据返回了16个字段，但是手机APP端只用到了其中7个字段，剩余9个字段的数据全部都是多余的，如果接口返回数据为40K大小，也就是说大约20K的数据为无效数据，3G网络下20K下载差不多需要1s，不返回无效数据至少可以节约1s的时间，大大提高用户体验。本篇将为大家介绍Newtonsoft.Json的一些高级用法，可以修改很少的代码解决上述问题。

阅读目录

  • Newtonsoft.Json介绍
  • 基本用法
  • 高级用法
  • 总结
回到顶部

Newtonsoft.Json介绍

　　在做开发的时候，很多数据交换都是以json格式传输的。而使用Json的时候，我们很多时候会涉及到几个序列化对象的使用：DataContractJsonSerializer,JavaScriptSerializer 和 Json.NET即Newtonsoft.Json。大多数人都会选择性能以及通用性较好Json.NET，这个不是微软的类库，但是一个开源的世界级的Json操作类库，从下面的性能对比就可以看到它的其中之一的性能优点。

齐全的API介绍，使用方式简单

 

回到顶部

基本用法

　　Json.Net是支持序列化和反序列化DataTable,DataSet,Entity Framework和Entity的。下面分别举例说明序列化和反序列化。

DataTable：

复制代码
            //序列化DataTableDataTable dt = new DataTable();dt.Columns.Add("Age", Type.GetType("System.Int32"));dt.Columns.Add("Name", Type.GetType("System.String"));dt.Columns.Add("Sex", Type.GetType("System.String"));dt.Columns.Add("IsMarry", Type.GetType("System.Boolean"));for (int i = 0; i < 4; i++){DataRow dr = dt.NewRow();dr["Age"] = i + 1;dr["Name"] = "Name" + i;dr["Sex"] = i % 2 == 0 ? "男" : "女";dr["IsMarry"] = i % 2 > 0 ? true : false;dt.Rows.Add(dr);}Console.WriteLine(JsonConvert.SerializeObject(dt));
复制代码

利用上面字符串进行反序列化

 string json = JsonConvert.SerializeObject(dt);dt=JsonConvert.DeserializeObject<DataTable>(json);foreach (DataRow dr in dt.Rows){Console.WriteLine("{0}\t{1}\t{2}\t{3}\t", dr[0], dr[1], dr[2], dr[3]);}

Entity序列化和DataTable一样，就不过多介绍了。

回到顶部

高级用法

    1.忽略某些属性

    2.默认值的处理

    3.空值的处理

    4.支持非公共成员

    5.日期处理

    6.自定义序列化的字段名称

　 7.动态决定属性是否序列化

    8.枚举值的自定义格式化问题

　 9.自定义类型转换

  10.全局序列化设置

 一.忽略某些属性

　　类似本问开头介绍的接口优化，实体中有些属性不需要序列化返回，可以使用该特性。首先介绍Json.Net序列化的模式:OptOut 和 OptIn

OptOut默认值,类中所有公有成员会被序列化,如果不想被序列化,可以用特性JsonIgnore
OptIn默认情况下,所有的成员不会被序列化,类中的成员只有标有特性JsonProperty的才会被序列化,当类的成员很多,但客户端仅仅需要一部分数据时,很有用

 

 

　仅需要姓名属性

复制代码
    [JsonObject(MemberSerialization.OptIn)]public class Person{public int Age { get; set; }[JsonProperty]public string Name { get; set; }public string Sex { get; set; }public bool IsMarry { get; set; }public DateTime Birthday { get; set; }}
复制代码

  不需要是否结婚属性

复制代码
    [JsonObject(MemberSerialization.OptOut)]public class Person{public int Age { get; set; }public string Name { get; set; }public string Sex { get; set; }[JsonIgnore]public bool IsMarry { get; set; }public DateTime Birthday { get; set; }}
复制代码

  通过上面的例子可以看到，要实现不返回某些属性的需求很简单。1.在实体类上加上[JsonObject(MemberSerialization.OptOut)] 2.在不需要返回的属性上加上 [JsonIgnore]说明。

二.默认值处理

    序列化时想忽略默认值属性可以通过JsonSerializerSettings.DefaultValueHandling来确定，该值为枚举值

DefaultValueHandling.Ignore
序列化和反序列化时,忽略默认值
DefaultValueHandling.Include
序列化和反序列化时,包含默认值

 

 

 

 [DefaultValue(10)]public int Age { get; set; }
 Person p = new Person { Age = 10, Name = "张三丰", Sex = "男", IsMarry = false, Birthday = new DateTime(1991, 1, 2) };JsonSerializerSettings jsetting=new JsonSerializerSettings();jsetting.DefaultValueHandling=DefaultValueHandling.Ignore;Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

最终结果如下：

 

三.空值的处理

　　序列化时需要忽略值为NULL的属性，可以通过JsonSerializerSettings.NullValueHandling来确定，另外通过JsonSerializerSettings设置属性是对序列化过程中所有属性生效的，想单独对某一个属性生效可以使用JsonProperty，下面将分别展示两个方式

　　1.JsonSerializerSettings

 Person p = new Person { room=null,Age = 10, Name = "张三丰", Sex = "男", IsMarry = false, Birthday = new DateTime(1991, 1, 2) };JsonSerializerSettings jsetting=new JsonSerializerSettings();jsetting.NullValueHandling = NullValueHandling.Ignore;Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

   

   2.JsonProperty

通过JsonProperty属性设置的方法，可以实现某一属性特别处理的需求，如默认值处理，空值处理，自定义属性名处理，格式化处理。上面空值处理实现

 [JsonProperty(NullValueHandling=NullValueHandling.Ignore)]public Room room { get; set; }

 

四.支持非公共成员

  序列化时默认都是处理公共成员，如果需要处理非公共成员，就要在该成员上加特性"JsonProperty"

 [JsonProperty]private int Height { get; set; }

 

五.日期处理

　　对于Dateime类型日期的格式化就比较麻烦了，系统自带的会格式化成iso日期标准，但是实际使用过程中大多数使用的可能是yyyy-MM-dd 或者yyyy-MM-dd HH:mm:ss两种格式的日期，解决办法是可以将DateTime类型改成string类型自己格式化好，然后在序列化。如果不想修改代码，可以采用下面方案实现。

      Json.Net提供了IsoDateTimeConverter日期转换这个类，可以通过JsnConverter实现相应的日期转换

    [JsonConverter(typeof(IsoDateTimeConverter))]public DateTime Birthday { get; set; }

　　但是IsoDateTimeConverter日期格式不是我们想要的，我们可以继承该类实现自己的日期

复制代码
    public class ChinaDateTimeConverter : DateTimeConverterBase{private static IsoDateTimeConverter dtConverter = new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd" };public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer){return dtConverter.ReadJson(reader, objectType, existingValue, serializer);}public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer){dtConverter.WriteJson(writer, value, serializer);}}
复制代码

    自己实现了一个yyyy-MM-dd格式化转换类，可以看到只是初始化IsoDateTimeConverter时给的日期格式为yyyy-MM-dd即可，下面看下效果

[JsonConverter(typeof(ChinaDateTimeConverter))]
public DateTime Birthday { get; set; }

   可以根据自己需求实现不同的转换类

 

六.自定义序列化的字段名称

    实体中定义的属性名可能不是自己想要的名称，但是又不能更改实体定义，这个时候可以自定义序列化字段名称。

     [JsonProperty(PropertyName = "CName")]public string Name { get; set; }

 

七.动态决定属性是否序列化

　　这个是为了实现@米粒儿提的需求特别增加的，根据某些场景，可能A场景输出A，B，C三个属性，B场景输出E，F属性。虽然实际中不一定存在这种需求，但是json.net依然可以支持该特性。

　　继承默认的DefaultContractResolver类，传入需要输出的属性

     重写修改了一下，大多数情况下应该是要排除的字段少于要保留的字段,  为了方便书写这里修改了构造函数加入retain表示props是需要保留的字段还是要排除的字段

复制代码
public class LimitPropsContractResolver : DefaultContractResolver{string[] props = null;bool retain;/// <summary>/// 构造函数/// </summary>/// <param name="props">传入的属性数组</param>/// <param name="retain">true:表示props是需要保留的字段  false：表示props是要排除的字段</param>public LimitPropsContractResolver(string[] props, bool retain=true){//指定要序列化属性的清单this.props = props;this.retain = retain;}protected override IList<JsonProperty> CreateProperties(Type type,MemberSerialization memberSerialization){IList<JsonProperty> list =base.CreateProperties(type, memberSerialization);//只保留清单有列出的属性return list.Where(p => {if (retain){return props.Contains(p.PropertyName);}else{return !props.Contains(p.PropertyName);}      }).ToList();}
复制代码
        public int Age { get; set; }[JsonIgnore]public bool IsMarry { get; set; }public string Sex { get; set; }
      JsonSerializerSettings jsetting=new JsonSerializerSettings();jsetting.ContractResolver = new LimitPropsContractResolver(new string[] { "Age", "IsMarry" });Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

  使用自定义的解析类，只输出"Age", "IsMarry"两个属性，看下最终结果.只输出了Age属性，为什么IsMarry属性没有输出呢，因为标注了JsonIgnore

 

 看到上面的结果想要实现pc端序列化一部分，手机端序列化另一部分就很简单了吧，我们改下代码实现一下

复制代码
  string[] propNames = null;if (p.Age > 10){propNames = new string[] { "Age", "IsMarry" };}else{propNames = new string[] { "Age", "Sex" };}jsetting.ContractResolver = new LimitPropsContractResolver(propNames);Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));
复制代码

 

八.枚举值的自定义格式化问题

  默认情况下对于实体里面的枚举类型系统是格式化成改枚举对应的整型数值,那如果需要格式化成枚举对应的字符怎么处理呢？Newtonsoft.Json也帮我们想到了这点，下面看实例

复制代码
    public enum NotifyType{/// <summary>/// Emil发送/// </summary>Mail=0,/// <summary>/// 短信发送/// </summary>SMS=1}public class TestEnmu{/// <summary>/// 消息发送类型/// </summary>public NotifyType Type { get; set; }}JsonConvert.SerializeObject(new TestEnmu());
复制代码

输出结果：  现在改造一下，输出"Type":"Mail"

复制代码
    public class TestEnmu{/// <summary>/// 消息发送类型/// </summary>[JsonConverter(typeof(StringEnumConverter))]public NotifyType Type { get; set; }}
复制代码

其它的都不变，在Type属性上加上了JsonConverter(typeof(StringEnumConverter))表示将枚举值转换成对应的字符串,而StringEnumConverter是Newtonsoft.Json内置的转换类型,最终输出结果

 

九.自定义类型转换

默认情况下对于实体里面的Boolean系统是格式化成true或者false,对于true转成"是" false转成"否"这种需求改怎么实现了？我们可以自定义类型转换实现该需求，下面看实例

复制代码
public class BoolConvert : JsonConverter{private string[] arrBString { get; set; }public BoolConvert(){arrBString = "是,否".Split(',');}/// <summary>/// 构造函数/// </summary>/// <param name="BooleanString">将bool值转换成的字符串值</param>public BoolConvert(string BooleanString){if (string.IsNullOrEmpty(BooleanString)){throw new ArgumentNullException();}arrBString = BooleanString.Split(',');if (arrBString.Length != 2){throw new ArgumentException("BooleanString格式不符合规定");}}public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer){bool isNullable = IsNullableType(objectType);Type t = isNullable ? Nullable.GetUnderlyingType(objectType) : objectType;if (reader.TokenType == JsonToken.Null){if (!IsNullableType(objectType)){throw new Exception(string.Format("不能转换null value to {0}.", objectType));}return null;}try{if (reader.TokenType == JsonToken.String){string boolText = reader.Value.ToString();if (boolText.Equals(arrBString[0], StringComparison.OrdinalIgnoreCase)){return true;}else if (boolText.Equals(arrBString[1], StringComparison.OrdinalIgnoreCase)){return false;}}if (reader.TokenType == JsonToken.Integer){//数值return Convert.ToInt32(reader.Value) == 1;}}catch (Exception ex){throw new Exception(string.Format("Error converting value {0} to type '{1}'", reader.Value, objectType));}throw new Exception(string.Format("Unexpected token {0} when parsing enum", reader.TokenType));}/// <summary>/// 判断是否为Bool类型/// </summary>/// <param name="objectType">类型</param>/// <returns>为bool类型则可以进行转换</returns>public override bool CanConvert(Type objectType){return true;}public bool IsNullableType(Type t){if (t == null){throw new ArgumentNullException("t");}return (t.BaseType.FullName=="System.ValueType" && t.GetGenericTypeDefinition() == typeof(Nullable<>));}public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer){if (value == null){writer.WriteNull();return;}bool bValue = (bool)value;if (bValue){writer.WriteValue(arrBString[0]);}else{writer.WriteValue(arrBString[1]);}}}
复制代码

 自定义了BoolConvert类型，继承自JsonConverter。构造函数参数BooleanString可以让我们自定义将true false转换成相应字符串。下面看实体里面怎么使用这个自定义转换类型

    public class Person{[JsonConverter(typeof(BoolConvert))]public bool IsMarry { get; set; }}

‘

相应的有什么个性化的转换需求，都可以使用自定义转换类型的方式实现。

 

十.全局序列化设置

文章开头提出了Null值字段怎么不返回的问题，相应的在高级用法也给出了相应的解决方案使用jsetting.NullValueHandling = NullValueHandling.Ignore; 来设置不返回空值。这样有个麻烦的地方，每个不想返回空值的序列化都需设置一下。可以对序列化设置一些默认值方式么？下面将解答

复制代码
　　Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() =>{
　　　　//日期类型默认格式化处理setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";　 //空值处理setting.NullValueHandling = NullValueHandling.Ignore;      //高级用法九中的Bool类型转换 设置setting.Converters.Add(new BoolConvert("是,否"));return setting;});
复制代码

 

这样设置以后，以后使用序列化的地方就不需要单独设置了，个人最喜欢设置的是空值处理这一块。

回到顶部

总结

　　Newtonsoft.Json序列化库替我们想了很多特性，也实现了很多特性，除了上面介绍的几种高级用法外，还有其它的特殊用法，可以去官网进行学习。当然这里我目前最喜欢的特性就是那个忽略部分属性序列化的功能，很小的代码改动实现了接口的优化，提升了用户体验。


本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/403116.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

CH340驱动（含各平台）

CH340驱动（含各平台）

CH340转串口芯片支持的平台驱动齐全&#xff0c;支持 Windows/Linux/Android/MacOS/WinCE 等各主流系统。下面就给出各平台下驱动官网链接和简要说明&#xff0c;每个平台的安装与使用问题可以参见我的其他博文。 Windows驱动 下载链接&#xff1a;CH340/CH341 Windows 驱动链…
阅读更多...
js获取文件名后缀

js获取文件名后缀

this.fileType this.file.name.split(.)[this.file.name.split(.).length - 1]
阅读更多...
PHP笔记-管道的作用 类

PHP笔记-管道的作用 类

echo 123 | sudo -S /bin/bash -c cp god* /usr/local/bin | 就是管道 作用是将前面的结果作为后面的参数使用 123就是sudo的密码 -c &#xff08;command命令&#xff09; cp god* /usr/local/bin将以god开头的文件拷贝到/usr/local/bin文件中 god* 以god开头的文件 /bin/b…
阅读更多...
Android 经典示例，初学者的绝好源码资料

Android 经典示例，初学者的绝好源码资料

2019独角兽企业重金招聘Python工程师标准>>> Android 经典示例&#xff0c;初学者的绝好源码资料 附上源码&#xff1a; 转载:http://www.adobex.com/android/source/details/00000374.htm 转载于:https://my.oschina.net/androidcode/blog/104696
阅读更多...
USB转串口驱动（支持各平台）

USB转串口驱动（支持各平台）

CH340转串口芯片支持的平台驱动齐全&#xff0c;支持 Windows/Linux/Android/MacOS/WinCE 等各主流系统。下面就给出各平台下驱动官网链接和简要说明&#xff0c;每个平台的安装与使用问题可以参见我的其他博文。 Windows驱动 下载链接&#xff1a;CH340/CH341 Windows 驱动链…
阅读更多...
【DOS】对指定目录下的指定文件类型进行打包

【DOS】对指定目录下的指定文件类型进行打包

echo offset packagepack.rar set dirsLoginServer Launcher GlobalLauncher GameLauncherdel %package%REM 对指定目录下的指定文件类型进行打包 for %%i in (%dirs%) do rar a %package% %%i\*.dll %%i\*.pdb %%i\*.exe.* %%i\*.xml说明&#xff1a; 1. 以上不会去子目录下搜…
阅读更多...
CH340 Linux驱动使用教程

CH340 Linux驱动使用教程

在官方Linux内核版本中自Kernel2.6以后就默认包含了对CH340/CH341芯片的驱动支持了&#xff0c;但比较遗憾的是该自带驱动版本较老&#xff08;由开源社区开发者提交&#xff09;已不能满足使用需求了&#xff0c;因此我们需要用芯片官网提供的新驱动进行替换链接。 1. 首先去…
阅读更多...
关于页面图表相应式的问题，问题遇见时间，9月1日，到今天9月2日，尚未解决...

关于页面图表相应式的问题，问题遇见时间，9月1日，到今天9月2日，尚未解决...

首先&#xff0c;我在做公司的新的软件页面&#xff0c;后台页面&#xff0c;遇到的问题是当我引入百度的echarts.js&#xff0c;想使用他们的插件来实现图表的功能&#xff0c;发现JS的信息描述必须放在他们div id的下面&#xff0c;否则会失效&#xff0c;这是问题一。 现在遇…
阅读更多...
h5开发实时预览；真机调试开发；拼接ip的地址直接微信打开或者浏览器打开也可以实时预览

h5开发实时预览；真机调试开发；拼接ip的地址直接微信打开或者浏览器打开也可以实时预览

http://192.168.10.135:2277/#/Write1 本地启动vue项目 将地址栏复制 放在微信开发者工具 可以借助微信开发者工具预览 找到自己电脑的ip 也可以电脑输入自己的ip和对应端口号地址进行预览 最后将拼接ip和端口号的地址直接微信打开或者浏览器打开也可以实时预览
阅读更多...
Android广播接实现电话的监听（电话的状态，拦截）

Android广播接实现电话的监听（电话的状态，拦截）

Android广播接实现电话的监听 1&#xff1a;需要在AndroidManifest.xml清单中添加权限 <uses-permission android:name"android.permission.PROCESS_OUTGOING_CALLS"/> <uses-permission android:name"android.permission.READ_PHONE_STATE" /…
阅读更多...
CH340 MAC驱动使用教程

CH340 MAC驱动使用教程

CH340 支持各类系统平台下使用&#xff0c;驱动的使用以及下载介绍可以参见我的其他博客&#xff1a;CH340 驱动&#xff08;含各平台&#xff09; 这一篇文章主要介绍CH340 在 MAC 以及各类 Arduino 平台的安装使用流程&#xff0c;首先到沁恒官网下载最新的CH340驱动&#x…
阅读更多...
python基础2

python基础2

本节内容 列表、元组操作字符串操作字典操作集合操作文件操作字符编码与转码 一、列表、元组操作 列表是我们最以后最常用的数据类型之一&#xff0c;通过列表可以对数据实现最方便的存储、修改等操作 定义列表 >>> name [hongpeng,21,ops] 通过下标访问列表中的元素…
阅读更多...
element-ui嵌套弹框遮罩层解决

element-ui嵌套弹框遮罩层解决

:modal-append-to-body“false” :append-to-body“true” 嵌套的 Dialog 必须指定该属性并赋值为 true <template><el-button type"text" click"outerVisible true">点击打开外层 Dialog</el-button><el-dialog title"外层 D…
阅读更多...
Linux 串口调试工具汇总

Linux 串口调试工具汇总

在 linux 系统下进行串口调试或者开发时配合简单易用的串口调试工具那是必不可少。这篇博客对当前用的较多的&#xff0c;且我自己经常用的一些串口工具做一下汇总&#xff0c;大家可以参考一下。 实验环境&#xff1a; OS: Ubuntu16.04 Kernel: 4.4.0 --------------------…
阅读更多...
Find和FirstOrDefault()有什么区别?

Find和FirstOrDefault()有什么区别?

From: http://www.cnblogs.com/Benjamin/p/3261538.html Find方法和FirstOrDefault方法效果相同&#xff0c;都是返回满足条件的第一个元素&#xff0c;如果没有该元素&#xff0c;则返回null。 那么这两个扩展方法有什么不同&#xff1f; 1&#xff09;Find方法是.netFramewor…
阅读更多...
python3.5中import sqlite3报错：ImportError: No module named _sqlite3

python3.5中import sqlite3报错：ImportError: No module named _sqlite3

原因&#xff1a;缺少相关库 解决方案&#xff1a; 1 安装相关库 yum install sqlite-devel 2 重新编译安装Python转载于:https://www.cnblogs.com/MnCu8261/p/5836028.html
阅读更多...
Linux系统putty的安装使用教程

Linux系统putty的安装使用教程

文章已经汇总到我的其他博客文章&#xff1a; Linux 串口调试工具汇总 - JAZZSOLDIER的专栏 - 博客频道 - CSDN.NET http://blog.csdn.net/jazzsoldier/article/details/70183995 有疑问可以给我留言或者评论哦~:-D
阅读更多...
nagios监控之（监控配置）

nagios监控之（监控配置）

打开上一章&#xff1a;nagios监控之&#xff08;运行环境搭建&#xff09; PS&#xff1a; 上一张已经把nagios的基本环境搭建完成&#xff0c;并能成功浏览nagios页面 现在讲下nagios配置文件 配置文件 放在nagios/etc下面 cgi.cfg 控制CGI访问的配置文件 …
阅读更多...
minicom/picocom/cutecom/putty 安装与使用教程

minicom/picocom/cutecom/putty 安装与使用教程

文章已经汇总到我的其他博客文章&#xff1a; Linux 串口调试工具汇总 - JAZZSOLDIER的专栏 - 博客频道 - CSDN.NET http://blog.csdn.net/jazzsoldier/article/details/70183995 有疑问可以给我留言或者评论哦~:-D
阅读更多...
List去除重复的元素

List去除重复的元素

有两种方法&#xff0c;一种是去重不带顺序的&#xff0c;一种是去重带顺序的。 /** 方法1: 无顺序* Hastset根据hashcode判断是否重复&#xff0c;数据不会重复*/public static List<String> deleteDuplicate(List<String> list){Set<String> set new Hash…
阅读更多...
最新文章

Copyright @ 2022~2023