JSON扩展类——JsonHelper
1.引用Newtonsoft.Json库（JSON.NET）。
2.复制粘贴JsonHelper吧。
源代码：
using System;
using System.Collections.Generic;
using System.Linq;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters; namespace Allen.Core
{
public static partial class JsonHelper
{
#region Private fields private static readonly JsonSerializerSettings JsonSettings; private const string EmptyJson = "[]";
#endregion #region Constructor static JsonHelper()
{
var datetimeConverter = new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd HH:mm:ss" }; JsonSettings = new JsonSerializerSettings
{
MissingMemberHandling = MissingMemberHandling.Ignore,
NullValueHandling = NullValueHandling.Ignore,
ReferenceLoopHandling = ReferenceLoopHandling.Ignore
};
JsonSettings.Converters.Add(datetimeConverter);
}
#endregion #region Public Methods /// <summary>
/// 应用Formatting.None和指定的JsonSerializerSettings设置,序列化对象到JSON格式的字符串
/// </summary>
/// <param name="obj">任意一个对象</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <returns>标准的JSON格式的字符串</returns>
public static string ToJson(object obj, JsonSerializerSettings jsonSettings)
{
return ToJson(obj, Formatting.None, jsonSettings);
} /// <summary>
/// 应用指定的Formatting枚举值None和指定的JsonSerializerSettings设置,序列化对象到JSON格式的字符串
/// </summary>
/// <param name="obj">任意一个对象</param>
/// <param name="format">指定 Newtonsoft.Json.JsonTextWriter 的格式设置选项</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <returns>标准的JSON格式的字符串</returns>
public static string ToJson(object obj, Formatting format, JsonSerializerSettings jsonSettings)
{
try
{
return obj == null ? EmptyJson : JsonConvert.SerializeObject(obj, format, jsonSettings ?? JsonSettings);
}
catch (Exception)
{
//TODO LOG
return EmptyJson;
}
} /// <summary>
/// 应用Formatting.None和指定的JsonSerializerSettings设置,反序列化JSON数据为dynamic对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个dynamic对象。</para>
/// <para>转换失败，或发生其它异常，则返回dynamic对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <returns>dynamic对象</returns>
public static dynamic FromJson(this string json, JsonSerializerSettings jsonSettings)
{
return FromJson<dynamic>(json, Formatting.None, jsonSettings);
} /// <summary>
/// 应用指定的Formatting枚举值None和指定的JsonSerializerSettings设置,反序列化JSON数据为dynamic对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个dynamic对象。</para>
/// <para>转换失败，或发生其它异常，则返回dynamic对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <param name="format">指定 Newtonsoft.Json.JsonTextWriter 的格式设置选项</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <returns>dynamic对象</returns>
public static dynamic FromJson(this string json, Formatting format, JsonSerializerSettings jsonSettings)
{
return FromJson<dynamic>(json, format, jsonSettings);
} /// <summary>
/// 应用Formatting.None和指定的JsonSerializerSettings设置,反序列化JSON数据到指定的.NET类型对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个T对象。</para>
/// <para>转换失败，或发生其它异常，则返回T对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <typeparam name="T">反序列化对象的类型</typeparam>
/// <returns></returns>
public static T FromJson<T>(string json, JsonSerializerSettings jsonSettings) where T : class, new()
{
return FromJson<T>(json, Formatting.None, jsonSettings);
} /// <summary>
/// 应用指定的Formatting枚举值None和指定的JsonSerializerSettings设置,反序列化JSON数据到指定的.NET类型对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个T对象。</para>
/// <para>转换失败，或发生其它异常，则返回T对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <param name="format">指定 Newtonsoft.Json.JsonTextWriter 的格式设置选项</param>
/// <param name="jsonSettings">在一个 Newtonsoft.Json.JsonSerializer 对象上指定设置，如果为null，则使用默认设置</param>
/// <typeparam name="T">反序列化对象的类型</typeparam>
/// <returns></returns>
public static T FromJson<T>(string json, Formatting format, JsonSerializerSettings jsonSettings) where T : class, new()
{
T result; if (jsonSettings == null)
{
jsonSettings = JsonSettings;
} try
{
result = string.IsNullOrWhiteSpace(json) ? default(T) : JsonConvert.DeserializeObject<T>(json, jsonSettings);
}
catch (JsonSerializationException) //在发生该异常后，再以集合的方式重试一次.
{
//LOG
try
{
var array = JsonConvert.DeserializeObject<IEnumerable<T>>(json, jsonSettings);
result = array.FirstOrDefault();
}
catch (Exception)
{
//LOG
result = default(T);
}
}
catch (Exception)
{
//LOG
result = default(T);
}
return result;
}
#endregion #region Public Extend Methods /// <summary>
/// 反序列化JSON数据为dynamic对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个dynamic对象。</para>
/// <para>转换失败，或发生其它异常，则返回dynamic对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <returns>dynamic对象</returns>
public static dynamic FromJson(this string json)
{
return FromJson<dynamic>(json, Formatting.None, JsonSettings);
} /// <summary>
/// 反序列化JSON数据到指定的.NET类型对象
/// <para>如果发生JsonSerializationException异常，再以集合的方式重试一次，取出集合的第一个T对象。</para>
/// <para>转换失败，或发生其它异常，则返回T对象的默认值</para>
/// </summary>
/// <param name="json">需要反序列化的JSON字符串</param>
/// <typeparam name="T">反序列化对象的类型</typeparam>
/// <returns></returns>
public static T FromJson<T>(this string json) where T : class, new()
{
return FromJson<T>(json, Formatting.None, JsonSettings);
} /// <summary>
/// 应用默认的Formatting枚举值None和默认的JsonSerializerSettings设置,序列化对象到JSON格式的字符串
/// </summary>
/// <param name="obj">任意一个对象</param>
/// <returns>标准的JSON格式的字符串</returns>
public static string ToJson(this object obj)
{
return ToJson(obj, Formatting.None, JsonSettings);
} public static string ToJson<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate), isFilterNull);
} public static string ToJson<TSource>(this IEnumerable<TSource> source, Func<TSource, int, bool> predicate, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(t => t != null).Select(selector), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, int, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(t => t != null).Select(selector), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, bool> predicate, Func<TSource, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate).Select(selector), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, bool> predicate, Func<TSource, int, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate).Select(selector), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, int, bool> predicate, Func<TSource, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate).Select(selector), isFilterNull);
} public static string ToJson<TSource, TResult>(this IEnumerable<TSource> source, Func<TSource, int, bool> predicate, Func<TSource, int, TResult> selector, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => enumerable.Where(predicate).Select(selector), isFilterNull);
}
#endregion #region Private Methods /// <summary>
/// 委托处理需要序列化为JSON格式的对象，返回标准的JSON格式的字符串。
/// 默认过滤null对象，如果需要在上层调用时，自己进行条件过滤null对象，
/// 则设置isFilterNull为false，不建议isFilterNull设置为false。
/// </summary>
/// <typeparam name="TSource"></typeparam>
/// <typeparam name="TResult"></typeparam>
/// <param name="source">需要转换为JSON格式字符串的对象</param>
/// <param name="func">集合/数组条件筛选方法委托，返回筛选后的集合/数组</param>
/// <param name="isFilterNull">是否过滤IEnumerable<TSource> source中的null对象，默认为true</param>
/// <returns>标准的JSON格式的字符串</returns>
private static string DelegateToJson<TSource, TResult>(IEnumerable<TSource> source, Func<TSource[], IEnumerable<TResult>> func, bool isFilterNull = true)
{
return DelegateToJson(source, enumerable => func(enumerable).ToJson(), isFilterNull);
} /// <summary>
/// 委托处理需要序列化为JSON格式的对象，返回标准的JSON格式的字符串。
/// 默认过滤null对象，如果需要在上层调用时，自己进行条件过滤null对象，
/// 则设置isFilterNull为false，不建议isFilterNull设置为false。
/// </summary>
/// <typeparam name="TSource"></typeparam>
/// <param name="source">需要转换为JSON格式字符串的对象</param>
/// <param name="func">JSON处理方法委托，返回JSON格式的字符串</param>
/// <param name="isFilterNull">是否过滤IEnumerable<TSource> source中的null对象，默认为true</param>
/// <returns>标准的JSON格式的字符串</returns>
private static string DelegateToJson<TSource>(IEnumerable<TSource> source, Func<TSource[], string> func, bool isFilterNull = true)
{
if (source == null)
{
return EmptyJson;
} TSource[] enumerable;
if (isFilterNull)
{
//过滤null
enumerable = source.Where(t => t != null).ToArray();
}
else
{
//不过滤null，但上层需要注意内里面有null对象时，可能会导致Where或Select引发异常。
enumerable = source as TSource[] ?? source.ToArray();
} return enumerable.Any() ? func(enumerable) : EmptyJson;
} #endregion
}
}
用法案例：
class Program
{
static void Main(string[] args)
{
//ToJson 方法 Test
#region 默认过滤null对象 var list1 = new List<Test>
{
new Test {Id = 10, Type = 21, Name="Allen"},
new Test {Id = 11, Type = 22},
new Test {Id = 12, Type = 23},
new Test {Id = 13, Type = 24, Name="Peter"},
null,
new Test {Id = 13, Type = 24, Name=null}
}; //指定json数据所需要的属性
string jsonString = list1.ToJson(t => new { id = t.Id, type = t.Type }); //推荐写法，连true都省略掉
//string jsonString = JsonHelper.ToJson(list1, t => new { id = t.Id, type = t.Type }); //不推荐该写法
//string jsonString = list1.ToJson(t => new { id = t.Id, type = t.Type }, true);
Console.WriteLine(jsonString); //筛选出Name为"Allen"的对象
string jsonString2 = list1.ToJson(t => t.Name == "Allen"); //推荐写法，连true都省略掉
//string jsonString2 = JsonHelper.ToJson(list1, t => t.Name == "Allen"); //不推荐该写法
//string jsonString2 = list1.ToJson(t => t.Name == "Allen", true);
Console.WriteLine(jsonString2); //筛选出Name为"Allen"的对象，并且指定json数据所需要的属性
string jsonString3 = list1.ToJson(t => t.Name == "Allen", t => new { id = t.Id, type = t.Type }); //推荐写法，连true都省略掉
//string jsonString3 = JsonHelper.ToJson(list1, t => t.Name == "Allen", t => new { id = t.Id, type = t.Type }); //不推荐该写法
//string jsonString3 = list1.ToJson(t => t.Name == "Allen", t => new { id = t.Id, type = t.Type }, true);
Console.WriteLine(jsonString3);
#endregion #region 不过滤null对象 var list2 = new List<Test>
{
new Test {Id = 10, Type = 21, Name="Allen"},
new Test {Id = 11, Type = 22, Name="Bolong"},
new Test {Id = 12, Type = 23, Name="Popo"},
new Test {Id = 13, Type = 24, Name="Peter"},
new Test {Id = 16, Type = 25, Name="Willy"}
}; //指定json数据所需要的属性
string jsonString4 = list2.ToJson(t => new { id = t.Id, type = t.Type }, false);
Console.WriteLine(jsonString4); //筛选出Name为"Allen"的对象
string jsonString5 = list2.ToJson(t => t.Name == "Allen", false);
Console.WriteLine(jsonString5); //筛选出Name为"Allen"的对象，并且指定json数据所需要的属性
string jsonString6 = list2.ToJson(t => t.Name == "Allen", t => new { id = t.Id, type = t.Type }, false);
Console.WriteLine(jsonString6);
#endregion //FromJson<T> 方法 Test
List<Test> testList1 = jsonString.FromJson<List<Test>>();
List<Test> testList2 = jsonString2.FromJson<List<Test>>();
Test test = jsonString3.FromJson<Test>(); //弱类型 Test
var test2 = jsonString.FromJson();
Newtonsoft.Json.Linq.JArray test3 = test2; Console.ReadKey();
}
} internal class Test
{
public int Type { get; set; } public int Id { get; set; } public string Name { get; set; }
}
PS：有更好的封装建议吗？
JSON扩展类——JsonHelper的更多相关文章
- C# json帮助类，JsonHelper，Table转JSon，JSon转Table
/// <summary> /// json帮助类 /// </summary> public class JsonHelper { public JsonHelper() { ...
- ASP.NET(C#) Json序列化反序列化帮助类Jsonhelper
原文地址:https://ken.io/note/csharp-asp.net-jsonhelper using System; using System.Collections.Generic; u ...
- Thinkphp编辑器扩展类kindeditor用法
一, 使用前的准备. 使用前请确认你已经建立好了一个Thinkphp站点项目. 1,Keditor.class.php和JSON.class.php 是编辑器扩展类文件,将他们拷贝到你的站点项目的Th ...
- Spring统一返回Json工具类，带分页信息
前言: 项目做前后端分离时,我们会经常提供Json数据给前端,如果有一个统一的Json格式返回工具类,那么将大大提高开发效率和减低沟通成本. 此Json响应工具类,支持带分页信息,支持泛型,支持Htt ...
- C#封装的一个JSON操作类
using System; using System.Collections.Generic; using System.Collections; using System.Text; using S ...
- UI(UGUI)框架(二)-------------UIManager单例模式与开发BasePanel面板基类/UIManage统一管理UI面板的实例化/开发字典扩展类
UIManage单实例: /// 单例模式的核心 /// 1,定义一个静态的对象 在外界访问 在内部构造 /// 2,构造方法私有化 private static UIManager _instanc ...
- Android Json转换类对象，并使用
长话短说,先上代码(今天的代码是有史以来最短的)(今天的课也是有史以来最精简...) 然后就是介绍Song是啥,上面的网站应该知道,是网易云的,不过为啥会变成这样,因为这是网易云的API网站 反正就是 ...
- [No00009A]JsonToObject json与类互转
using System.Web.Script.Serialization; /// <summary> /// 内部类,保存jsonData /// </summary> p ...
- C# 扩展类
C# 中提供一个非常实用的供能,扩展方法(Extension method) 扩展方法是通过额外的静态方法扩展现有的类型.通过扩展方法,可以对已有类型做自己想做的相关扩展.方法:定义静态类,扩展方法也 ...
随机推荐
- 深入解析Sqlite的完美替代者，android数据库新王者——Realm
写在前面: 又到一年一度七夕虐狗节,看着大家忍受着各种朋友圈和QQ空间还有现实生活中的轮番轰炸,我实在不忍心再在这里给大家补刀,所以我觉得今天不虐狗,继续给大家分享有用的. 如果你比较关心androi ...
- CentOS7使用firewalld打开关闭防火墙与端口(转载)
1.firewalld的基本使用 启动: systemctl start firewalld 查看状态: systemctl status firewalld 停止: systemctl disabl ...
- 使用Expression实现数据的任意字段过滤（1）
在项目常常要和数据表格打交道. 现在BS的通常做法都是前端用一个js的Grid控件, 然后通过ajax的方式从后台加载数据, 然后将数据和Grid绑定. 数据往往不是一页可以显示完的, 所以要加分页: ...
- python学习笔记（python介绍）
为什么要学python? python和shell的比较,和PHP.和JAVA比较 运维开发只是用到python的很小一部分 python在一些知名公司的应用: 谷歌:python的创始人原来在谷歌工 ...
- PHP设计模式（八）桥接模式（Bridge For PHP）
一.概述 桥接模式:将两个原本不相关的类结合在一起,然后利用两个类中的方法和属性,输出一份新的结果. 二.案例 1.模拟毛笔(转) 需求:现在需要准备三种粗细(大中小),并且有五种颜色的比 如果使用蜡 ...
- iOS自定义model排序
在开发过程中,可能需要按照model的某种属性排序. 1.自定义model @interface Person : NSObject @property (nonatomic,copy) NSStri ...
- SVN的使用
- DevExpress - 使用 GaugeControl 标尺组件制作抽奖程序 附源码
前不久,公司举办了15周年庆,其中添加了一个抽奖环节,要从在读学员中随机抽取幸运学员,当然,这个任务就分到了我这里. 最后的效果如下,启动有个欢迎页面,数据是来自Excel的,点击开始则上面的学号及姓 ...
- Linux常用命令
命令格式与目录处理命令 ls 命令格式与目录处理命令 ls 命令格式:命令 [-选项][参数] 例:ls -la /etc 说明: 1)个别命令使用不遵循格式 2)当有多个选项时,可以写在一起 3)简 ...
- .Net中的AOP系列之《单元测试切面》
返回<.Net中的AOP>系列学习总目录 本篇目录 使用NUnit编写测试 编写和运行NUnit测试 切面的测试策略 Castle DynamicProxy测试 测试一个拦截器 注入依赖 ...