C# 利用 Newtonsoft.Json 实现 Json 字符串 与 Object 对象数据 的转换

本文介绍如何使用Newtonsoft.Json库进行JSON序列化与反序列化,包括设置JSON格式、对象与JSON字符串互转、读写JSON文件等实用功能。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

废话不多说,直接上干货!

首先,需要在项目中引用 Newtonsoft.Json 库,

选中你在开发的项目,右键(如下图,VS2017 IDE)

搜索 Json ,

 安装 Newtonsoft.Json 库 即可。

下面是一个 Json 的工具类代码:

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Common.Json
{
    /// <summary> Json 工具类
    /// </summary>
    public static class JsonTool
    {

        /// <summary> 设置 Json 序列化格式
        /// </summary>
        /// <param name="isFormatJson">是否格式化 Json 字符串,默认 true</param>
        /// <param name="isIgnoreNull">是否忽略 null 值,默认 false</param>
        /// <param name="DtmFormat">日期格式化参数,默认 "yyyy-MM-dd HH:mm:ss"</param>
        /// <returns></returns>
        public static JsonSerializerSettings SetJsonSerializerFormat(bool isFormatJson = true,
                                                                     bool isIgnoreNull = false,
                                                                     string DtmFormat = "yyyy-MM-dd HH:mm:ss")
        {
            JsonSerializerSettings jss = new JsonSerializerSettings();

            IList<JsonConverter> jcList = new List<JsonConverter>();

            //日期时间格式化处理
            IsoDateTimeConverter timeConverter = new IsoDateTimeConverter();
            timeConverter.DateTimeFormat = DtmFormat; //日期时间格式化处理

            jcList.Add(timeConverter);

            jss.Converters = jcList;

            if (isFormatJson)
            {
                jss.Formatting = Newtonsoft.Json.Formatting.Indented; //格式化Json字符串    
            }

            if (isIgnoreNull)
            {
                jss.NullValueHandling = NullValueHandling.Ignore; //忽略null值    
            }

            return jss;
        }

        /// <summary> object 对象转换为 Json 字符串
        /// </summary>
        /// <param name="obj">可序列化对象</param>
        /// <returns></returns>
        public static string ObjectToJson(object obj)
        {
            string json = null;

            if (obj == null)
            {
                return string.Empty;
            }

            try
            {
                json = JsonConvert.SerializeObject(obj, SetJsonSerializerFormat());
            }
            catch (Exception ex)
            {
                return string.Empty;
            }

            return json;
        }

        /// <summary> Json 格式的字符串转换为 T 对象
        /// </summary>
        /// <typeparam name="T">泛型 类型</typeparam>
        /// <param name="json">json 格式的字符串</param>
        /// <returns></returns>
        public static T JsonToObject<T>(string json)
        {
            T t_object = default(T);

            if (string.IsNullOrWhiteSpace(json))
            {
                return default(T);
            }

            try
            {
                t_object = JsonConvert.DeserializeObject<T>(json);
            }
            catch (Exception ex)
            {
                return default(T);
            }

            return t_object;
        }

        /// <summary> Json 格式的字符串转换为 object 对象
        /// </summary>
        /// <param name="json">json 格式的字符串</param>
        /// <returns></returns>
        public static object JsonToObject(string json)
        {
            object obj = null;

            if (string.IsNullOrWhiteSpace(json))
            {
                return null;
            }

            try
            {
                obj = JsonConvert.DeserializeObject(json);
            }
            catch (Exception ex)
            {
                return null;
            }

            return obj;
        }

        /// <summary> Json 格式的字符串转换为 dynamic 匿名对象
        /// </summary>
        /// <param name="json">json 格式的字符串</param>
        /// <returns></returns>
        public static dynamic JsonToDynamic(string json)
        {
            if (string.IsNullOrWhiteSpace(json))
            {
                return null;
            }

            //创建匿名对象
            dynamic dyData = default(dynamic);

            try
            {
                dyData = JsonConvert.DeserializeObject(json);
            }
            catch (Exception ex)
            {
                dyData = null;
            }

            return dyData;
        }


        /// <summary> 读取 Json 内容的文件,并转化为 object 对象
        /// </summary>
        /// <param name="path">Json 文件的绝对路径</param>
        /// <param name="encoding">字符编码,默认 UTF-8</param>
        /// <returns></returns>
        public static object JsonFileToObject(string path, Encoding encoding = null)
        {
            if (!File.Exists(path))
            {
                return null;
            }

            object obj = null;

            if (encoding == null)
            {
                encoding = Encoding.UTF8;
            }

            try
            {
                string jsonStr = null;
                using (FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read))
                {
                    using (StreamReader sr = new StreamReader(fs, encoding))
                    {
                        jsonStr = sr.ReadToEnd();
                    }
                }
                if (string.IsNullOrWhiteSpace(jsonStr))
                {
                    obj = null;
                }
                else
                {
                    obj = JsonToObject(jsonStr);
                }
            }
            catch (Exception ex)
            {
                obj = null;
            }

            return obj;
        }

        /// <summary> 读取 Json 内容的文件,并转化为 T 对象
        /// </summary>
        /// <typeparam name="T">泛型 类型</typeparam>
        /// <param name="path">Json 文件的绝对路径</param>
        /// <param name="encoding">字符编码,默认 UTF-8</param>
        /// <returns></returns>
        public static T JsonFileToObject<T>(string path, Encoding encoding = null)
        {
            T t_obj = default(T);

            if (!File.Exists(path))
            {
                return default(T);
            }

            if (encoding == null)
            {
                encoding = Encoding.UTF8;
            }

            try
            {
                string jsonStr = null;
                using (FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read))
                {
                    using (StreamReader sr = new StreamReader(fs, encoding))
                    {
                        jsonStr = sr.ReadToEnd();
                    }
                }
                if (string.IsNullOrWhiteSpace(jsonStr))
                {
                    t_obj = default(T);
                }
                else
                {
                    t_obj = JsonToObject<T>(jsonStr);
                }
            }
            catch (Exception ex)
            {
                t_obj = default(T);
            }

            return t_obj;
        }

        /// <summary> object 对象转换为 Json 内容的文件
        /// </summary>
        /// <param name="obj">object</param>
        /// <param name="path">Json 文件的绝对路径(建议文件格式用 .json 后缀)</param>
        /// <param name="encoding">字符编码,默认 UTF-8</param>
        /// <returns></returns>
        public static bool ObjectToJsonFile(object obj, string path, Encoding encoding = null)
        {
            if (obj == null || string.IsNullOrWhiteSpace(path))
            {
                return false;
            }

            bool isFinish = false;

            string jsonStr = ObjectToJson(obj);
            if (string.IsNullOrWhiteSpace(jsonStr))
            {
                isFinish = false;
            }
            else
            {
                if (encoding == null)
                {
                    encoding = Encoding.UTF8;
                }
                try
                {
                    if (!Directory.Exists(Path.GetDirectoryName(path)))
                    {
                        Directory.CreateDirectory(Path.GetDirectoryName(path));
                    }

                    using (FileStream fs = new FileStream(path, FileMode.Create, FileAccess.Write))
                    {
                        using (StreamWriter sw = new StreamWriter(fs, encoding))
                        {
                            sw.Write(jsonStr);
                        }
                    }
                    isFinish = true;
                }
                catch (Exception ex)
                {
                    isFinish = false;
                }
            }

            return isFinish;
        }

    }
}

希望给你带来帮助! 

 

### 使用 Newtonsoft.Json 进行对象序列化为字符串.NET 开发中,`Newtonsoft.Json` 是一个非常流行的库,用于处理 JSON 数据。它提供了强大的功能来简化对象 JSON 字符串之间的相互转换操作。下面是关于如何利用 `JsonConvert.SerializeObject` 方法将自定义对象序列化成 JSON 字符串的具体说明。 #### 基本语法 方法签名如下所示: ```csharp public static string SerializeObject(object value); ``` 其中参数 `value` 表示要被序列化的对象实例[^1]。 #### 示例代码 假设我们有一个简单的类表示一个人的信息,可以这样实现它的序列化: ```csharp using System; using Newtonsoft.Json; // 定义一个Person类作为待序列化的对象模型 public class Person { public string Name { get; set; } public int Age { get; set; } } class Program { static void Main() { // 初始化一个新的Person对象 Person person = new Person { Name = "John", Age = 30 }; // 调用SerializeObject方法将其转为JSON格式的字符串 string json = JsonConvert.SerializeObject(person); // 输出结果 Console.WriteLine(json); // {"Name":"John","Age":30} } } ``` 这段程序首先创建了一个名为 `person` 的 `Person` 类型的对象,并赋予了一些初始值;接着调用了静态方法 `JsonConvert.SerializeObject()` 来把这个 C# 对象变成对应的 JSON 文本形式最后打印出来验证效果[^1]。 #### 高级选项配置 除了最基本的用法之外,还可以传递额外的设置项来自定义序列化的行为。比如忽略那些具有默认值(如整数类型的零或者引用类型的 null)字段不参最终输出等特性可以通过调整 `JsonSerializerSettings` 参数达成目的: ```csharp var settings = new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.Ignore, }; string filteredJson = JsonConvert.SerializeObject(person, Formatting.Indented, settings); Console.WriteLine(filteredJson); ``` 这里设置了当某个属性等于其类型默认状态时则不会出现在生成的结果里[^3]。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值