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


246

有没有一种简单的方法可以使用通过AJAX传递的JSON对象填充C#对象?

这是使用JSON.stringify从页面传递给C#WEBMETHOD的JSON对象

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

接收JSON对象的C#WebMetod

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

}

C#类,表示传递给WebMethod的JSON对象的对象结构

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

68
要补充一点,您可以使用json2csharp.com为您生成c#类。完全披露:我确实创建了该网站。
JonathanK


@JonathanK你是我的救星!
Matheno

Answers:


218

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

快速入门和API文档JSON.NET -官方网站帮助你使用它。

如何使用它的示例:

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);
 }

5
这就像冠军,但是如果我在json中有多个项目并且想要创建对象列表怎么办?
Djeroen '16

@Djeroen:我看到两种方式。如果未将项目分组,请尝试找到一种拆分字符串的方法,然后在循环中重复该过程。如果它们被分组,则使对象成为对象
user1011138

1
我更喜欢其他答案中提到的一种。.恕我直言。
RayLoveless

是的,这不是一个好方法,下面使用DeserializeObject的方法要干净得多
Andrew

207

由于我们都喜欢一个班轮代码

Newtonsoft比Java脚本序列化器更快。...这取决于Newtonsoft NuGet软件包,该软件包非常流行,并且比默认的序列化程序更好。

如果我们有课,请在下面使用。

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

没有课程,然后使用动态

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

95

为了使您的选项保持打开状态,如果您使用的是.NET 3.5或更高版本,则下面是一个示例,您可以直接使用Generics从框架中使用。正如其他人提到的那样,如果不仅仅是简单的对象,那么您应该真正使用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;

@ChristianPayne哈!好点,是的,这些应该包装。事后看来,只需使用JSON.NET!
Jammin

2
如果DataContractJsonSerializer类不可见,则必须通过右键单击解决方案中的“引用”来添加对System.Runtime.Serialization的引用,选择.NET选项卡,然后选择System.Runtime.Serialization
DanKodi 2013年

1
一种情况,这种情况会中断。如果您的JSON对象表示带有单引号的属性,则此函数将失败。例如,它无法解析{'Subject':'Emailing:Web User Activity Log11','EmbedAsImage':true},但它能够解析{“ Subject”:“ Emailing:Web User Activity Log11”,“ EmbedAsImage” :true}
dreamerkumar

另外,我需要用DataContract和DataMember属性装饰我的简单类。没有它,它将无法解析。
dreamerkumar

与Vishal不同,POCO类非常适合我... +1,因为这避免了对JSON.NET的依赖。
Dunc

54

给定您的代码示例,您无需执行任何其他操作。

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

通常,尽管如此,您可以使用以下JavascriptSerializer类,或者为了获得更大的灵活性,可以使用现有的各种Json框架(Jayrock JSON是一个很好的框架)来简化JSON操作。

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

1
我认为您必须使用一个可枚举的类型(因此在此示例中List <User>)
Dragouf 2011年

如果包含子视图模型,我们如何反序列化
SrinivasNaidu

1
对于那些寻找它们的人,您需要引用该System.Web.Extensions程序集并添加一个using System.Web.Script.Serializationat来获取JavaScriptSerializer,但是一旦完成,这似乎是将您的json字符串反序列化为c#具体类的最干净的方法。
Serj Sagan

41

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

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

但是,如果User对象在属性中还有另一个JSon数据,则将失败...
gumuruh,

@gumuruh我想我不明白你的说法。如果您有一个复杂的对象,而属性是另一个复杂的对象,则只要您的Json String正确拥有数据,它们也将被转换。
丹尼尔

33

以下2个示例利用了

  1. System.Web.Script.Serialization下的JavaScriptSerializer
  2. System.Web.Helpers下的Json.Decode

示例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网页{VERSION} \ Assemblies \ System.Web.Helpers.dll

要么

%ProgramFiles(x86)%\ Microsoft ASP.NET \ ASP.NET网页{VERSION} \ Assemblies \ System.Web.Helpers.dll

希望这可以帮助!


这是一个很好的答案,但棘手的是,使用dynamic类型时,您不会得到任何真正的类型检查。例如,如果您的JSON包含"Name" : "Ahmed"您在C#代码中错误输入“名称”,那么这是运行时错误(bleh)。
杰西(Jess)2014年

谢谢!请更新答案以指出对于示例1,您需要引用System.Web.Extensions.dll
Valamas,2014年

1
超级好答案,动态键入也可以使用json.net v6.0.6!
stackuser83 2014年

7
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您可以在这里阅读。


5

使用JavaScriptSerializer()比提供的通用解决方案严格:public static T Deserialize(string json)

当将json传递到与您尝试转换为的对象定义不完全匹配的服务器时,这可能会派上用场。



1

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



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

而不是仅仅作为对象发送。

创建可访问的公共属性类,然后将数据发送到Web方法。

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

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

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.