如何将 JSON 对象转换为自定义 C# 对象?

问题描述 投票:0回答:13

如何使用通过 AJAX 传递的 JSON 对象填充我的 C# 对象?

这是使用 JSON.stringify从页面传递到 C# web 方法的 JSON 对象:

{
    "user": {
        "name": "asdf",
        "teamname": "b",
        "email": "c",
        "players": ["1", "2"]
    }
}

接收 JSON 对象的 C# Web 方法:

[WebMethod]
public static void SaveTeam(Object user)
{

}

表示传入 Web 方法的 JSON 对象的对象结构的 C# 类

public class User
{
    public string name { get; set; }
    public string teamname { get; set; }
    public string email { get; set; }
    public Array players { get; set; }
}
c# asp.net .net ajax json
13个回答
273
投票

这个依赖于Newtonsoft NuGet包,它比默认的序列化器更快。

如果我们有一个类,那么我们可以使用下面的代码:

Mycustomclassname oMycustomclassname = Newtonsoft.Json.JsonConvert.DeserializeObject<Mycustomclassname>(jsonString);

如果没有类则使用动态:

var oMycustomclassname = Newtonsoft.Json.JsonConvert.DeserializeObject<dynamic>(jsonString);

240
投票

在 C# 中使用 JSON 的一个好方法是使用 JSON.NET

来自 JSON.NET - 官方网站的快速入门和 API 文档可帮助您使用它。

如何使用它的示例:

public class User
{
    public User(string json)
    {
        JObject jObject = JObject.Parse(json);
        JToken jUser = jObject["user"];
        name = (string) jUser["name"];
        teamname = (string) jUser["teamname"];
        email = (string) jUser["email"];
        players = jUser["players"].ToArray();
    }

    public string name { get; set; }
    public string teamname { get; set; }
    public string email { get; set; }
    public Array players { get; set; }
}

// Use
private void Run()
{
    string json = @"{""user"":{""name"":""asdf"",""teamname"":""b"",""email"":""c"",""players"":[""1"",""2""]}}";
    User user = new User(json);

    Console.WriteLine("Name : " + user.name);
    Console.WriteLine("Teamname : " + user.teamname);
    Console.WriteLine("Email : " + user.email);
    Console.WriteLine("Players:");

    foreach (var player in user.players)
        Console.WriteLine(player);
 }

97
投票

为了保持您的选择余地,如果您使用的是 .NET 3.5 或更高版本,这里是一个打包示例,您可以使用泛型直接从框架中使用。正如其他人提到的,如果它不仅仅是简单的对象,你真的应该使用 JSON.net。

public static string Serialize<T>(T obj)
{
    DataContractJsonSerializer serializer = new DataContractJsonSerializer(obj.GetType());
    MemoryStream ms = new MemoryStream();
    serializer.WriteObject(ms, obj);
    string retVal = Encoding.UTF8.GetString(ms.ToArray());
    return retVal;
}

public static T Deserialize<T>(string json)
{
    T obj = Activator.CreateInstance<T>();
    MemoryStream ms = new MemoryStream(Encoding.Unicode.GetBytes(json));
    DataContractJsonSerializer serializer = new DataContractJsonSerializer(obj.GetType());
    obj = (T)serializer.ReadObject(ms);
    ms.Close();
    return obj;
}

你需要:

using System.Runtime.Serialization;

using System.Runtime.Serialization.Json;

54
投票

鉴于您的代码示例,您不需要执行任何其他操作。

如果将该 JSON 字符串传递给 Web 方法,它将自动解析 JSON 字符串并创建一个填充的 User 对象作为 SaveTeam 方法的参数。

一般来说,您可以使用下面的

JavascriptSerializer
类,或者为了获得更大的灵活性,可以使用任何各种 Json 框架(Jayrock JSON 是一个很好的框架)来轻松进行 JSON 操作。

 JavaScriptSerializer jss= new JavaScriptSerializer();
 User user = jss.Deserialize<User>(jsonResponse); 

52
投票

另一个真正简单的解决方案是使用库Newtonsoft.Json:

User user = JsonConvert.DeserializeObject<User>(jsonString);

38
投票

以下 2 个示例均使用其中一个

  1. JavaScriptSerializer 位于 System.Web.Script.Serialization
  2. Json.DecodeSystem.Web.Helpers

示例 1:使用 System.Web.Script.Serialization

using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Web.Script.Serialization;

namespace Tests
{
    [TestClass]
    public class JsonTests
    {
        [TestMethod]
        public void Test()
        {
            var json = "{\"user\":{\"name\":\"asdf\",\"teamname\":\"b\",\"email\":\"c\",\"players\":[\"1\",\"2\"]}}";
            JavaScriptSerializer serializer = new JavaScriptSerializer();
            dynamic jsonObject = serializer.Deserialize<dynamic>(json);

            dynamic x = jsonObject["user"]; // result is Dictionary<string,object> user with fields name, teamname, email and players with their values
            x = jsonObject["user"]["name"]; // result is asdf
            x = jsonObject["user"]["players"]; // result is object[] players with its values
        }
    }
}

用法: JSON 对象到自定义 C# 对象

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Web.Script.Serialization;
using System.Linq;

namespace Tests
{
    [TestClass]
    public class JsonTests
    {
        [TestMethod]
        public void TestJavaScriptSerializer()
        {
            var json = "{\"user\":{\"name\":\"asdf\",\"teamname\":\"b\",\"email\":\"c\",\"players\":[\"1\",\"2\"]}}";
            User user = new User(json);
            Console.WriteLine("Name : " + user.name);
            Console.WriteLine("Teamname : " + user.teamname);
            Console.WriteLine("Email : " + user.email);
            Console.WriteLine("Players:");
            foreach (var player in user.players)
                Console.WriteLine(player);
        }
    }

    public class User {
        public User(string json) {
            JavaScriptSerializer serializer = new JavaScriptSerializer();
            var jsonObject = serializer.Deserialize<dynamic>(json);
            name = (string)jsonObject["user"]["name"];
            teamname = (string)jsonObject["user"]["teamname"];
            email = (string)jsonObject["user"]["email"];
            players = jsonObject["user"]["players"];
        }

        public string name { get; set; }
        public string teamname { get; set; }
        public string email { get; set; }
        public Array players { get; set; }
    }
}

示例 2:使用 System.Web.Helpers

using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Web.Helpers;

namespace Tests
{
    [TestClass]
    public class JsonTests
    {
        [TestMethod]
        public void TestJsonDecode()
        {
            var json = "{\"user\":{\"name\":\"asdf\",\"teamname\":\"b\",\"email\":\"c\",\"players\":[\"1\",\"2\"]}}";
            dynamic jsonObject = Json.Decode(json);

            dynamic x = jsonObject.user; // result is dynamic json object user with fields name, teamname, email and players with their values
            x = jsonObject.user.name; // result is asdf
            x = jsonObject.user.players; // result is dynamic json array players with its values
        }
    }
}

用法: JSON 对象到自定义 C# 对象

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Web.Helpers;
using System.Linq;

namespace Tests
{
    [TestClass]
    public class JsonTests
    {
        [TestMethod]
        public void TestJsonDecode()
        {
            var json = "{\"user\":{\"name\":\"asdf\",\"teamname\":\"b\",\"email\":\"c\",\"players\":[\"1\",\"2\"]}}";
            User user = new User(json);
            Console.WriteLine("Name : " + user.name);
            Console.WriteLine("Teamname : " + user.teamname);
            Console.WriteLine("Email : " + user.email);
            Console.WriteLine("Players:");
            foreach (var player in user.players)
                Console.WriteLine(player);
        }
    }

    public class User {
        public User(string json) {
            var jsonObject = Json.Decode(json);
            name = (string)jsonObject.user.name;
            teamname = (string)jsonObject.user.teamname;
            email = (string)jsonObject.user.email;
            players = (DynamicJsonArray) jsonObject.user.players;
        }

        public string name { get; set; }
        public string teamname { get; set; }
        public string email { get; set; }
        public Array players { get; set; }
    }
}

此代码需要添加 System.Web.Helpers 命名空间,

%ProgramFiles%\Microsoft ASP.NET\ASP.NET Web 页面{版本}\Assemblies\System.Web.Helpers.dll

或者

%ProgramFiles(x86)%\Microsoft ASP.NET\ASP.NET Web 页面{版本}\Assemblies\System.Web.Helpers.dll


8
投票
public static class Utilities
{
    public static T Deserialize<T>(string jsonString)
    {
        using (MemoryStream ms = new MemoryStream(Encoding.Unicode.GetBytes(jsonString)))
        {    
            DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(T));
            return (T)serializer.ReadObject(ms);
        }
    }
}

更多信息请访问以下链接 http://ishareidea.blogspot.in/2012/05/json-conversion.html

关于

DataContractJsonSerializer Class
您可以阅读这里


7
投票

使用

JavaScriptSerializer()
不如提供的通用解决方案严格:

public static T Deserialize<T>(string json)

当将 json 传递到与您要转换的对象定义不完全匹配的服务器时,这可能会很方便。


2
投票

在性能方面,我发现 ServiceStack 的序列化器比其他序列化器要快一些。它是 ServiceStack.Text 命名空间中的 JsonSerializer 类。

https://github.com/ServiceStack/ServiceStack.Text

ServiceStack 可通过 NuGet 包获得: https://www.nuget.org/packages/ServiceStack/


1
投票

JSON.Net 是您的最佳选择,但是根据对象的形状以及是否存在循环依赖关系,您可以使用 JavaScriptSerializer 或 DataContractSerializer。


1
投票

codeplex 上的 JSON C# 类生成器生成与 NewtonSoftJS 配合良好的类。


1
投票

JavaScript 序列化器:需要

using System.Web.Script.Serialization;

public class JavaScriptSerializerDeSerializer<T>
{
    private readonly JavaScriptSerializer serializer;

    public JavaScriptSerializerDeSerializer()
    {
        this.serializer = new JavaScriptSerializer();
    }

    public string Serialize(T t)
    {
        return this.serializer.Serialize(t);
    }

    public T Deseralize(string stringObject)
    {
        return this.serializer.Deserialize<T>(stringObject);
    }
}

数据合约序列化器:需要

using System.Runtime.Serialization.Json;
- 泛型类型 T 应该是可序列化的 更多关于数据契约的信息

public class JsonSerializerDeserializer<T> where T : class
{
    private readonly DataContractJsonSerializer jsonSerializer;

    public JsonSerializerDeserializer()
    {
        this.jsonSerializer = new DataContractJsonSerializer(typeof(T));
    }

    public string Serialize(T t)
    {
        using (var memoryStream = new MemoryStream())
        {
            this.jsonSerializer.WriteObject(memoryStream, t);
            memoryStream.Position = 0;
            using (var sr = new StreamReader(memoryStream))
            {
                return sr.ReadToEnd();
            }
        }
    }

    public T Deserialize(string objectString)
    {
        using (var ms = new MemoryStream(System.Text.ASCIIEncoding.ASCII.GetBytes((objectString))))
        {
            return (T)this.jsonSerializer.ReadObject(ms);
        }
    }
}

0
投票

不要仅作为对象发送,而是创建可访问的公共属性类并将数据发送到 Webmethod。

[WebMethod]
public static void SaveTeam(useSomeClassHere user)
{
}

在 Ajax 调用中使用相同的参数名称来发送数据。

© www.soinside.com 2019 - 2024. All rights reserved.