C#中如何將List(自定義)轉為Json格式 及相關函數-DataContractJsonSerializer

對C#和.net使用List和Json格式相互轉化的方法進行總結

關於JSON的入門介紹見https://www.json.org/ ，或者百度，這裡不贅述，不過通過下面的例子會有個更快捷和更直觀的認識。

如Json格式[{“id”:”1″,”name”:”sara”},{“id”:”2″,”name”:”sara2″}]

自定義數據類型，用於List:

 [DataContract]
    class Person {
        [DataMember]
        public int id;
        [DataMember]
        public string name;
    }

程序中使用：

首先加入引用：

using System.Runtime.Serialization.Json;
using System.Runtime.Serialization;
using System.Text;

代碼內容：

class Program
    {
        static void Main(string[] args)
        {
            //Product.GetAllSmartPhones();
            List nums = new List();
            nums.Add(new Person() { 
                id=1,
                name="sara"
            });
            nums.Add(new Person() { 
                id=1,
                name="sylar"
            });

            DataContractJsonSerializer json = new DataContractJsonSerializer(nums.GetType());

            string szJson = "";

            //序列化

            using (MemoryStream stream = new MemoryStream())
            {

                json.WriteObject(stream, nums);

                szJson = Encoding.UTF8.GetString(stream.ToArray());

            }
            Console.WriteLine(szJson);
            Console.ReadLine();
        }
    }

工程化時，可以對自定義數據結構重新定義一個類：

如：

public class TestListResult : List
{
public TestListResult()
{
this.Successed = false;
this.Message = “”;
}
public bool Successed { get; set; }
public string Message { get; set; }
}

使用時同上在一個文件裡一樣

理解瞭以上原理，可以使用以下函數在項目中使用：

List轉Json 

public static string Obj2Json(T data)
{
    try
    {
        System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(data.GetType());
        using (MemoryStream ms = new MemoryStream())
        {
            serializer.WriteObject(ms, data);
            return Encoding.UTF8.GetString(ms.ToArray());
        }
    }
    catch
    {
        return null;
    }
}

Json轉List 

public static Object Json2Obj(String json,Type t)
{
    try
    {
        System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(t);
        using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(json)))
        {
            
            return  serializer.ReadObject(ms);
        }
    }
    catch
    {
        return null;
    }
}

DataTable 轉Json 

public static string DataTable2Json(DataTable dt)
{
    if (dt.Rows.Count == 0)
    {
        return "";
    }
 
    StringBuilder jsonBuilder = new StringBuilder();
    // jsonBuilder.Append("{"); 
    //jsonBuilder.Append(dt.TableName.ToString());  
    jsonBuilder.Append("[");//轉換成多個model的形式
    for (int i = 0; i < dt.Rows.Count; i++)
    {
        jsonBuilder.Append("{");
        for (int j = 0; j < dt.Columns.Count; j++)
        {
            jsonBuilder.Append("\"");
            jsonBuilder.Append(dt.Columns[j].ColumnName);
            jsonBuilder.Append("\":\"");
            jsonBuilder.Append(dt.Rows[i][j].ToString());
            jsonBuilder.Append("\",");
        }
        jsonBuilder.Remove(jsonBuilder.Length - 1, 1);
        jsonBuilder.Append("},");
    }
    jsonBuilder.Remove(jsonBuilder.Length - 1, 1);
    jsonBuilder.Append("]");
    //  jsonBuilder.Append("}");
    return jsonBuilder.ToString();
}

單個對象轉JSON 

public static T Json2Obj(string json) 
{
    T obj = Activator.CreateInstance();
    using (System.IO.MemoryStream ms = new System.IO.MemoryStream(System.Text.Encoding.UTF8.GetBytes(json)))
    {
        System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(obj.GetType());
        return (T)serializer.ReadObject(ms);
    }
}

將函數封裝成類，更便於項目中引用：

 public class JsonHelper
    {
        /// 
        /// 生成Json格式
        /// 
        /// 
        /// 
        /// 
        public static string GetJson(T obj)
        {
            DataContractJsonSerializer json = new DataContractJsonSerializer(obj.GetType());
            using (MemoryStream stream = new MemoryStream())
            {
                json.WriteObject(stream, obj);
                string szJson = Encoding.UTF8.GetString(stream.ToArray()); 
                return szJson;
            }
        }
        /// 
        /// 獲取Json的Model
        /// 
        /// 
        /// 
        /// 
        public static T ParseFromJson(string szJson)
        {
            T obj = Activator.CreateInstance();
            using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(szJson)))
            {
                DataContractJsonSerializer serializer = new DataContractJsonSerializer(obj.GetType());
                return (T)serializer.ReadObject(ms);
            }
        }
    }
 /// 
        /// 反回JSON數據到前臺
        /// 
        /// 數據表
        /// JSON字符串
        public string DataTableToJson(DataTable dt)
        {
            StringBuilder JsonString = new StringBuilder();
            if (dt != null && dt.Rows.Count > 0)
            {
                JsonString.Append("{ ");
                JsonString.Append("\"TableInfo\":[ ");
                for (int i = 0; i < dt.Rows.Count; i++)
                {
                    JsonString.Append("{ ");
                    for (int j = 0; j < dt.Columns.Count; j++)
                    {
                        if (j < dt.Columns.Count - 1)
                        {
                            JsonString.Append("\"" + dt.Columns[j].ColumnName.ToString() + "\":" + "\"" + dt.Rows[i][j].ToString() + "\",");
                        }
                        else if (j == dt.Columns.Count - 1)
                        {
                            JsonString.Append("\"" + dt.Columns[j].ColumnName.ToString() + "\":" + "\"" + dt.Rows[i][j].ToString() + "\"");
                        }
                    }
                    if (i == dt.Rows.Count - 1)
                    {
                        JsonString.Append("} ");
                    }
                    else
                    {
                        JsonString.Append("}, ");
                    }
                }
                JsonString.Append("]}");
                return JsonString.ToString();
            }
            else
            {
                return null;
            }
        }

表的轉化Json類：

public static class JsonTableHelper
    {
        ///  
        /// 返回對象序列化 
        ///  
        /// 源對象 
        /// json數據 
        public static string ToJson(this object obj)
        {
            JavaScriptSerializer serialize = new JavaScriptSerializer();
            return serialize.Serialize(obj);
        }

        ///  
        /// 控制深度 
        ///  
        /// 源對象 
        /// 深度 
        /// json數據 
        public static string ToJson(this object obj, int recursionDepth)
        {
            JavaScriptSerializer serialize = new JavaScriptSerializer();
            serialize.RecursionLimit = recursionDepth;
            return serialize.Serialize(obj);
        }

        ///  
        /// DataTable轉為json 
        ///  
        /// DataTable 
        /// json數據 
        public static string ToJson(DataTable dt)
        {
            Dictionary dic = new Dictionary();

            int index = 0;
            foreach (DataRow dr in dt.Rows)
            {
                Dictionary result = new Dictionary();

                foreach (DataColumn dc in dt.Columns)
                {
                    result.Add(dc.ColumnName, dr[dc].ToString());
                }
                dic.Add(index.ToString(), result);
                index++;
            }
            return ToJson(dic);
        }
    }

在Asp.net中前後臺Json數據的傳遞

一、前臺產生Json數據傳遞給後臺處理

前臺生成Json數據要使用javascript和json.js。

json.js 下載地址：https://www.json.org/json.js

前臺代碼： 

            var people = [{ "UserName": "t1", "PassWord": "111111", "Sex": "男" },{ "UserName": "t2", "PassWord": "222222", "Sex": "女" }];
            var url = "Default.aspx?people=" + escape(people.toJSONString());
            request.open("POST", url, true);
            request.onreadystatechange = updatePage;
            request.send(null);

後臺處理代碼：

同上面的轉化原理一樣，我們先建立一個json數據類，便於List中使用。

[DataContract]//序列化
public class TestObj
{
    [DataMember]
    public string UserName { get; set; }
     [DataMember]
    public string PassWord { get; set; }
     [DataMember]
    public string Sex { get; set; }


public TestObj(string u,string p,string s)
	{
        UserName = u;
        PassWord = p;
        Sex = s;
	}
}

對前臺提交的Json數據相互轉化函數

//json 序列化

    public static string ToJsJson(object item)
    {
        DataContractJsonSerializer serializer = new DataContractJsonSerializer(item.GetType());
        using(MemoryStream ms=new MemoryStream())
        {
            serializer.WriteObject(ms, item);
            StringBuilder sb = new StringBuilder();
            sb.Append(Encoding.UTF8.GetString(ms.ToArray()));
            return sb.ToString();
        }
    }

    //反序列化

    public static T FromJsonTo(string jsonString)
    {
        DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(T));
        using (MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(jsonString)))
        {
            T jsonObject = (T)ser.ReadObject(ms);
            return jsonObject;
        }
    }

在後臺代碼中調用以上函數進行對數據people的處理：

 //獲取json字符串
        string jsonStr = Request["people"];
        List obj = Json.FromJsonTo<List>(jsonStr);
        foreach (TestObj item in obj)
            {
         Response.Write(string.Format("UserName:{0}，Password:{1}，Sex:{2}/r/n", item.UserName, item.PassWord, item.Sex));
            }
        Response.End();

最終的結果：

        List Users = new List();
        Users.Add(new TestObj("t1", "1", "男"));
        Users.Add(new TestObj("t2", "2", "女"));
        string json = Json.ToJsJson(Users);
        Response.Write(json);
        Response.End();

二、前臺獲取後臺提交的Json數據

後臺產生Json數據的方法如上原理中提到的：

 string Json;
       DataContractJsonSerializer json = new DataContractJsonSerializer(list.GetType());
                using (MemoryStream stream = new MemoryStream())
                {
                    json.WriteObject(stream, list);
                     Json = Encoding.UTF8.GetString(stream.ToArray());
                    
                }
        return Json;   
  /// 
    /// Json的數據結構
    /// 
    [DataContract]
    class ResultJson
    {
        [DataMember]
        public bool Result;
        [DataMember]
        public int Count;
        [DataMember]
        public string Message;
    }

前臺獲取後臺返回的Json字符串：

  function updatePage() {
            if (request.readyState == 4) {
                if (request.status == 200) {
                    var response = request.responseText;
                    //轉化成對象
                    //方法1
                        response = response.parseJSON();
                    //方法2
                    // response = eval("(" + response + ")");
                    //對象訪問方式
                    document.getElementById("d1").innerHTML = response[1].Sex;
                    //直接輸出
                   // document.getElementById("d1").innerHTML = response;
                }
            }
        }

復雜的Json字符串操作方法：

假如我們要轉化的JSON字符串格式為： 

{
    "encoding":"UTF-8",
    "plug-ins":["python","c++","ruby"],
    "indent":{
        "length":3,
        "use_space":true
    }
}

然後編寫相應的序列化的類，註意下面Indent類加的屬性：

[DataContract]
class Config
{
    [DataMember(Order = 0)]
    public string encoding { get; set; }
    [DataMember(Order = 1)]
    public string[] plugins { get; set; }
    [DataMember(Order = 2)]
    public Indent indent { get; set; }
}

[DataContract]
class Indent
{
    [DataMember(Order = 0)]
    public int length { get; set; }
    [DataMember(Order = 1)]
    public bool use_space { get; set; }
}

輸出JSON字符串

var config = new Config(){
                         encoding = "UTF-8",
                         plugins = new string[]{"python", "C++", "C#"},
                         indent = new Indent(){ length = 4, use_space = false}
                         };
var serializer = new DataContractJsonSerializer(typeof(Config));
var stream = new MemoryStream();
serializer.WriteObject(stream, config);

byte[] dataBytes = new byte[stream.Length];

stream.Position = 0;

stream.Read(dataBytes, 0, (int)stream.Length);

string dataString = Encoding.UTF8.GetString(dataBytes);

Console.WriteLine("JSON string is:");
Console.WriteLine(dataString);

結果：

JSON string is:
{"encoding":"UTF-8","plugins":["python","C++","C#"],"indent":{"length":4,"use_space":false}}

讀取Json字符串內容：

var mStream = new MemoryStream(Encoding.Default.GetBytes(dataString));
Config readConfig = (Config)serializer.ReadObject(mStream);

Console.WriteLine("Encoding is: {0}", readConfig.encoding);
foreach (string plugin in readConfig.plugins)
{
    Console.WriteLine("plugins is: {0}", plugin);
}
Console.WriteLine("indent.length is: {0}", readConfig.indent.length);
Console.WriteLine("indent.use_space is: {0}", readConfig.indent.use_space);

結果：

Encoding is: UTF-8
plugins is: python
plugins is: C++
plugins is: C#
indent.length is: 4
indent.use_space is: False

Related posts:

  1. ExtJS4 自定義基於配置的高級查詢2
  2. ExtJs–08–Ext自定義類的繼承關系
  3. jQuery validationEngine自定義提醒
  4. JavaScript自定義事件
  5. jtable列中自定義button示例代碼
  6. Jquery 自定義動畫概述及示例
  7. Js自定義錯誤obj.prototype.toString代碼實例講解
  8. js實現微信自定義分享功能的代碼教程

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *