C#中關於 object,dynamic 一點使用心得

兴想事成發表於2024-06-28
C#Object

首先說一下使用場景 WebAPI介面入參使用 object和 dynamic 後續解析和處理

1.object和dynamic 區別

在.NET中，object和dynamic也有一些區別：

  1. object：object是.NET中的頂級類，所有類都是object的子類。在C#中，您可以使用object關鍵字來宣告變數，該變數可以儲存任何型別的物件引用。

  2. dynamic：dynamic是.NET中的一種型別，它允許您在執行時執行動態繫結。這意味著您可以在編譯時避免型別檢查，而是在執行時確定變數的型別。這使得程式碼更加靈活，但也可能導致執行時錯誤。

在C#中，您可以像這樣使用它們：

這裡使用 Raccoon 程式碼助手 給出例項程式碼: (國產免費ai有時候真智障,僅供參考)

object myObject = "Hello, World!";
dynamic myDynamic = "Hello, Dynamic!";

// 以下程式碼將引發編譯錯誤，因為myObject的型別在編譯時被確定
// myObject = 42;

// 以下程式碼不會引發編譯錯誤，因為myDynamic的型別在執行時被確定
myDynamic = 42;

2. 構建json 和 dynamic 對應關係

由於WebAPI介面接收的引數,來自於前端提交,沒有一定的型別檢查機制(js弱型別), 再加上有些內容不定(引數裡面有單個物件,也有陣列之類的)

後端處理 就會顯得有點棘手.

在考慮如何解析這些前端傳過來的結構不定物件之前,先複習一下基礎知識,(掌握必備知識,才能更好的解決問題)

下面程式碼預設使用 TestDriven 外掛執行, 名稱空間有

using System.Collections.Generic;
using System.Text;
using System.Text.RegularExpressions;
using Newtonsoft.Json;
using System.Linq;
using System.Linq.Expressions;
using Newtonsoft.Json.Linq;

2.1 示例程式碼1: 陣列和物件集合

        public static void Test1()
        {
            var defaultStringValue = new List<string> { "" };
            JArray jArrayString = JArray.FromObject(defaultStringValue);
            Console.WriteLine(JsonConvert.SerializeObject(defaultStringValue)); // 輸出 [""]
            Console.WriteLine(JsonConvert.SerializeObject(jArrayString));       // 輸出 [""]

            var defaultObjValue = new List<object> { new object() };
            JArray jArrayObj = JArray.FromObject(defaultObjValue);
            Console.WriteLine(JsonConvert.SerializeObject(defaultObjValue));    // 輸出 [{}]
            Console.WriteLine(JsonConvert.SerializeObject(jArrayObj));          // 輸出 [{}]
        }

接下來看一個複雜的物件構造示例:

現有如下json格式字串 ,構造 dynamic 型別

{"Guid":"3eab6205-6a05-4d09-9dd3-7a004369bb32","names":["張三","李四","王五"],"Params":[{"id_list":["0001"]}]}

說明一下, 上面這個物件象 ,有三個屬性, Guid 是一個 guid字串, names 是一個陣列, Params 是一個複雜物件(集合)

2.2 示例程式碼2: 構造複雜物件

        public static void Test02()
        {
            string[] strings = new string[] { "張三", "李四", "王五" };
            JArray jArray = JArray.FromObject(strings);

            JObject jObj_idlist = new JObject();
            JArray j_id_list = JArray.FromObject(new string[] { "0001" });
            JProperty p_id_list = new JProperty("id_list", j_id_list);
            jObj_idlist.Add(p_id_list);
            
            dynamic obj = new
            {
                Guid = Guid.NewGuid().ToString(),
                names = jArray,
                Params = JArray.FromObject(new List<object>() { jObj_idlist })
            };
            Console.WriteLine(JsonConvert.SerializeObject(obj));
        }

2.3 示例程式碼3:

判斷一個dynamic 的值型別是 陣列(集合),還是單個的物件 ,這裡繼續使用上面的 dynamic obj 物件

            Console.WriteLine(obj.Guid is JArray);   // False
            Console.WriteLine(obj.names is JArray);  // True
            Console.WriteLine(obj.Params is JArray); // True

2.3 示例程式碼4: 

    public class StudentInfo
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public DateTime Birthday { get; set; }
        public int? Age
        {
            get
            {
                if (Birthday.HasValue)
                {
                    int year = (DateTime.Now - this.Birthday.Value).Days;
                    return year / 365;
                }
                else
                {
                    return null;
                }
            }
        }
    }
    public class TestClass
    {
        public static void Test1()
        {
            StudentInfo stu1 = new StudentInfo() { Id = 1, Name = "張三", Birthday = new DateTime(2000,1,1)};
            Console.WriteLine(JsonConvert.SerializeObject(stu1));
            // 輸出  {"Id":1,"Name":"張三","Birthday":"2000-01-01T00:00:00","Age":24}
        }
    }

加入這個引數 {"Id":1,"Name":"張三","Birthday":"2000-01-01T00:00:00","Age":24} 從前端傳入, 那麼透過 StudentInfo 可以直接接收,

但是如果 不知道這個人的出生年月日,傳入的 字串為 下面這幾種情況

{"Id":1,"Name":"張三","Birthday":""} // 反序列化失敗

或者 {"Id":1,"Name":"張三","Birthday":"null"} , // 反序列化失敗

或者 {"Id":1,"Name":"張三","Birthday":null} // 可成功序列化

        public static void Test2()
        {
            string json1 = "{\"Id\":1,\"Name\":\"張三\",\"Birthday\":\"\"} ";
            StudentInfo stu1 = JsonConvert.DeserializeObject<StudentInfo>(json1);  // 報錯
            Console.WriteLine(JsonConvert.SerializeObject(stu1)); 
        }
        public static void Test3()
        {
            string json1 = "{\"Id\":1,\"Name\":\"張三\",\"Birthday\":\"null\"} ";
            StudentInfo stu1 = JsonConvert.DeserializeObject<StudentInfo>(json1);  // 報錯
            Console.WriteLine(JsonConvert.SerializeObject(stu1));
        }

        public static void Test4()
        {
            string json1 = "{\"Id\":1,\"Name\":\"張三\",\"Birthday\":null} ";
            StudentInfo stu1 = JsonConvert.DeserializeObject<StudentInfo>(json1); // 可正常解析
            Console.WriteLine(JsonConvert.SerializeObject(stu1));
            // 輸出  {"Id":1,"Name":"張三","Birthday":null,"Age":null}
        }

2.3 泛型類 MapHelper<T>預處理:

為了介面不報錯, 這個先用 dynamic obj 接收這個入參, 然後近一步處理

MapHelper 
 using System;
using System.Reflection;
using Newtonsoft.Json.Linq;

namespace Common.Helper
{
    /// <summary>
    /// dynamic 資料對映
    /// </summary>
    /// <typeparam name="T">目標實體類</typeparam>
    public class MapHelper<T> where T : new()
    {
        /// <summary>
        ///  將資料來源 轉換成對應的 目標物件(處理可空型別, 以及 補全缺失的欄位)
        /// </summary>
        /// <param name="obj">dynamic 資料來源物件</param>
        /// <returns></returns>
        public static dynamic DynamicFormat(dynamic obj)
        {
            JObject jobj = (Newtonsoft.Json.Linq.JObject)obj;

            T model = new T();//不關心物件T的值, 只關心物件T的欄位的型別
            Type ts = model.GetType();
            //反射, 獲取 T的所有 屬性
            PropertyInfo[] PropertyList = ts.GetProperties();
            foreach (PropertyInfo item in PropertyList)
            {
                string colName = item.Name;
                string typeName = "";
                if (item.PropertyType.IsGenericType && item.PropertyType.GetGenericTypeDefinition() == typeof(Nullable<>))
                {
                    //如果是 Nullable<T>, 直接返回 T, 例如 DateTime?  返回 DateTime
                    Type[] arr = item.PropertyType.GetGenericArguments();
                    var columnType = arr[0];
                    typeName = columnType.ToString();
                    // Console.WriteLine($"{colName}的 目標型別是Nullable<{typeName}>");
                }
                else
                {
                    //普通型別, int,string,datetime 等
                    typeName = item.PropertyType.Name;
                }

                //Console.WriteLine("欄位:" + colName);
                //Console.WriteLine("型別:" + typeName);

                #region  嘗試型別轉換
                var s = jobj.GetValue(colName);// {ID:"10"}
                if (s == null)
                {
                    jobj[colName] = null;
                    continue;
                }

                object va = ((Newtonsoft.Json.Linq.JValue)s).Value;//"10"

                if (va == null)
                {
                    jobj[colName] = null;
                    continue;
                }
                else
                {
                    if (typeName == "System.Int32")
                    {
                        int t;
                        bool parseRes = int.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            jobj[colName] = null;
                        }
                    }
                    else if (typeName == "System.Decimal")
                    {
                        Decimal t;
                        bool parseRes = decimal.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            jobj[colName] = null;
                        }
                    }

                    else if (typeName == "System.Double")
                    {
                        double t;
                        bool parseRes = double.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            jobj[colName] = null;
                        }
                    }
                    else if (typeName == "System.Int64")
                    {
                        long t;
                        bool parseRes = long.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            jobj[colName] = null;
                        }
                    }
                    else if (typeName == "System.DateTime")
                    {
                        DateTime t;
                        bool parseRes = DateTime.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            DateTime? init = null;

                            jobj[colName] = init;
                        }
                    }
                    else if (typeName == "System.Int16")
                    {
                        short t;
                        bool parseRes = short.TryParse(va.ToString(), out t);
                        if (parseRes)
                        {
                            jobj[colName] = t;
                        }
                        else
                        {
                            jobj[colName] = null;
                        }
                    }
                }
                #endregion
            }
            return jobj;
        }

        public static dynamic DynamicFormatList(dynamic obj)
        {
            JArray jArray = new JArray();
            foreach (dynamic item in obj)
            {
                JObject jObject = JObject.FromObject(item);
                jArray.Add(DynamicFormat(jObject));
            }
            return jArray;
        }
    }
}

2.3.1 將上面的 Test2() 改為 TestNew2() 

        public static void TestNew2()
        {
            JObject jobj_stu = new JObject();

            JProperty ip_id = new JProperty("Id", 1);
            JProperty ip_name = new JProperty("Name", "張三");
            JProperty ip_birthday = new JProperty("Birthday", "");

            jobj_stu.Add(ip_id);
            jobj_stu.Add(ip_name);
            jobj_stu.Add(ip_birthday);

            string json_ori = JsonConvert.SerializeObject(jobj_stu);
            Console.WriteLine("初始JSON:"+json_ori);
            // 輸出 初始JSON:{"Id":1,"Name":"張三","Birthday":""}

            dynamic objNew = MapHelper<StudentInfo>.DynamicFormat(jobj_stu);
            string json_new = JsonConvert.SerializeObject(objNew);
            Console.WriteLine("處理後JSON:" + json_new);
            // 輸出 處理後JSON:{"Id":1,"Name":"張三","Birthday":null,"Age":null}
            
            StudentInfo stu1 = JsonConvert.DeserializeObject<StudentInfo>(json_new);
            Console.WriteLine("物件序列化後JSON:"+JsonConvert.SerializeObject(stu1));
            // 輸出 物件序列化後JSON:{"Id":1,"Name":"張三","Birthday":null,"Age":null}
        }

2.3.2 將上面的 Test3() 改為 TestNew3() 

        public static void TestNew3()
        {
            JObject jobj_stu = new JObject();

            JProperty ip_id = new JProperty("Id", 1);
            JProperty ip_name = new JProperty("Name", "張三");
            JProperty ip_birthday = new JProperty("Birthday", "null");

            jobj_stu.Add(ip_id);
            jobj_stu.Add(ip_name);
            jobj_stu.Add(ip_birthday);

            string json_ori = JsonConvert.SerializeObject(jobj_stu);
            Console.WriteLine("初始JSON:"+json_ori);
            // 輸出 初始JSON:{"Id":1,"Name":"張三","Birthday":"null"}

            dynamic objNew = MapHelper<StudentInfo>.DynamicFormat(jobj_stu);
            string json_new = JsonConvert.SerializeObject(objNew);
            Console.WriteLine("處理後JSON:" + json_new);
            // 輸出 處理後JSON:{"Id":1,"Name":"張三","Birthday":null,"Age":null}
            
            StudentInfo stu1 = JsonConvert.DeserializeObject<StudentInfo>(json_new);
            Console.WriteLine("物件序列化後JSON:"+JsonConvert.SerializeObject(stu1));
            // 輸出 物件序列化後JSON:{"Id":1,"Name":"張三","Birthday":null,"Age":null}
        }

3. 使用 Dictionary<string,object> 處理 入參

除了使用 dynamic 和 JObject 之類的處理方式, 還有 使用 Dictionary<string,object>的處理方式,

var dict = JsonConvert.DeserializeObject<Dictionary<string, object>>(json_ori);

4.構造極為複雜的Json物件

比如有如下json結構的引數

{"Id":1,"Name":"張三","Birthday":"null","Extends":[[]],"Extends2":[[[]],[[]]]}

新增了 Extends 和 Extends2

一眼看上去 好像不是很好構造,下面給出 C#程式碼 示例

        public static void TestNew5()
        {
            JObject jobj_stu = new JObject();

            JProperty ip_id = new JProperty("Id", 1);
            JProperty ip_name = new JProperty("Name", "張三");
            JProperty ip_birthday = new JProperty("Birthday", "null");

            var l1 = new List<object>() { new List<object>() { }};
            JProperty jp_extends = new JProperty("Extends", JArray.FromObject(l1) );
          
            dynamic p = new List<JArray>() { JArray.FromObject(l1), JArray.FromObject(l1) };
            JProperty jp_extends2 = new JProperty("Extends2", p);

            jobj_stu.Add(ip_id);
            jobj_stu.Add(ip_name);
            jobj_stu.Add(ip_birthday);
            jobj_stu.Add(jp_extends);
            jobj_stu.Add(jp_extends2);

            string json_ori = JsonConvert.SerializeObject(jobj_stu);
            Console.WriteLine("JSON:" + json_ori);
            // 輸出 {"Id":1,"Name":"張三","Birthday":"null","Extends":[[]],"Extends2":[[[]],[[]]]}

            var dict =  JsonConvert.DeserializeObject < Dictionary<string, object>>(json_ori);
            Console.WriteLine("JSON:" + JsonConvert.SerializeObject(dict));
            // 輸出 {"Id":1,"Name":"張三","Birthday":"null","Extends":[[]],"Extends2":[[[]],[[]]]}
        }

關於 object,dynamic ,以及 配合使用 Newtonsoft.Json 庫 就先介紹到這裡.

相關文章