大网数据广告活动
.NET 与 C# 开发

弱类型 JSON 序列化示例

· 52CE 我爱测

将用户定义的类型序列化为给定的连网格式,或者将连网格式反序列为原来的用户定义的类型时,给定的用户定义的类型必须在服务和客户端上可用。 通常,为实现此目的,系统将 属性应用于这些用户定义的类型,并将 属性应用于这些类型的成员。 该机制同样适用时使用 JavaScript 对象表示法 (JSON) 对象,如本主题中所述如何:序列化和反序列化 JSON 数据。

将用户定义的类型序列化为给定的连网格式,或者将连网格式反序列为原来的用户定义的类型时,给定的用户定义的类型必须在服务和客户端上可用。 通常,为实现此目的,系统将 xref:System.Runtime.Serialization.DataContractAttribute 属性应用于这些用户定义的类型,并将 xref:System.Runtime.Serialization.DataMemberAttribute 属性应用于这些类型的成员。 该机制同样适用时使用 JavaScript 对象表示法 (JSON) 对象,如本主题中所述如何:序列化和反序列化 JSON 数据。

在某些情况下,Windows Communication Foundation (WCF) 服务或客户端必须访问由服务或开发人员的控制之外的客户端生成的 JSON 对象。 随着更多 Web 服务公开 JSON Api,可能会不切实际 WCF 开发人员用来构造要任意 JSON 对象反序列化到其中的本地用户定义类型。 此示例提供了一种机制,使 WCF 开发人员能够使用反序列化的任意 JSON 对象,而无需创建用户定义类型。 这称为 JSON 对象的“弱类型序列化” ,因为 JSON 对象反序列化为的类型在编译时是未知的。

Note: 本主题的最后介绍了此示例的设置过程和生成说明。

例如,一个公共 Web 服务 API 返回以下 JSON 对象,该对象描述有关该服务的用户的一些信息。

{"personal": {"name": "Paul", "age": 23, "height": 1.7, "isSingle": true, "luckyNumbers": [5,17,21]}, "favoriteBands": ["Band ABC", "Band XYZ"]}  

若要反序列化此对象,WCF 客户端必须实现以下用户定义类型。

[DataContract]  
 public class MemberProfile  
 {  
     [DataMember]  
     public PersonalInfo personal;  
  
     [DataMember]  
     public string[] favoriteBands;  
 }  
  
 [DataContract]  
 public class PersonalInfo  
 {  
     [DataMember]  
     public string name;  
  
     [DataMember]  
     public int age;  
  
     [DataMember]  
     public double height;  
  
     [DataMember]  
     public bool isSingle;  
  
     [DataMember]  
     public int[] luckyNumbers;  
 }  

这可能会很麻烦,尤其是客户端必须处理多种 JSON 对象时。

此示例提供的 JsonObject 类型引入了以弱类型表示的反序列化的 JSON 对象。 JsonObject 依赖于 JSON 对象和.NET Framework 字典之间的自然映射和 JSON 数组和.NET Framework 数组之间的映射。 下面的代码演示 JsonObject 类型。

// Instantiation of JsonObject json omitted  
  
string name = json["root"]["personal"]["name"];  
int age = json["root"]["personal"]["age"];  
double height = json["root"]["personal"]["height"];  
bool isSingle = json["root"]["personal"]["isSingle"];  
int[] luckyNumbers = {  
                                     json["root"]["personal"]["luckyNumbers"][0],  
                                     json["root"]["personal"]["luckyNumbers"][1],  
                                     json["root"]["personal"]["luckyNumbers"][2]   
                                 };  
string[] favoriteBands = {  
                                        json["root"]["favoriteBands"][0],  
                                        json["root"]["favoriteBands"][1]  
                                    };  

请注意,您无需在编译时声明 JSON 对象和数组的类型便可以“浏览”它们。 有关顶级 ["root"] 对象的要求的说明,请参阅主题 Mapping Between JSON and XML中所述。

Note: JsonObject 类仅作为示例提供, 它未经全面测试,不应在生产环境中使用。 弱类型 JSON 序列化的一个明显含义是在处理 JsonObject时缺乏类型安全。

若要使用 JsonObject 类型,客户端操作协定必须使用 xref:System.ServiceModel.Channels.Message 作为其返回类型。

[ServiceContract]  
    interface IClientSideProfileService  
    {  
        // There is no need to write a DataContract for the complex type returned by the service.  
        // The client will use a JsonObject to browse the JSON in the received message.  
  
        [OperationContract]  
        [WebGet(ResponseFormat = WebMessageFormat.Json)]  
        Message GetMemberProfile();  
    }  

随后实例化 JsonObject ,如下面的代码所示。

// Code to instantiate IClientSideProfileService channel omitted…  
  
// Make a request to the service and obtain the Json response  
XmlDictionaryReader reader = channel.GetMemberProfile().GetReaderAtBodyContents();  
  
// Go through the Json as though it is a dictionary. There is no need to map it to a .NET CLR type.  
JsonObject json = new JsonObject(reader);  

JsonObject 构造函数采用通过 xref:System.Xml.XmlDictionaryReader方法获取的 xref:System.ServiceModel.Channels.Message.GetReaderAtBodyContents* 。 该读取器包含客户端接收的 JSON 消息的 XML 表示形式。 有关详细信息,请参阅主题Mapping Between JSON and XML。

该程序生成以下输出:

Service listening at http://localhost:8000/.  
To view the JSON output from the sample, navigate to http://localhost:8000/GetMemberProfile  
This is Paul's page. I am 23 years old and I am 1.7 meters tall.  
I am single.  
My lucky numbers are 5, 17, and 21.  
My favorite bands are Band ABC and Band XYZ.  

设置、生成和运行示例

  1. 请确保您具有执行的 Windows Communication Foundation 示例的一次性安装过程。

  2. 按照在 Building the Windows Communication Foundation Samples中所述的方法生成解决方案 WeaklyTypedJson.sln。

  3. 运行该解决方案。

Important: 您的计算机上可能已安装这些示例。 在继续操作之前,请先检查以下(默认)目录:

<InstallDrive>:\WF_WCF_Samples

如果此目录不存在,请转到Windows Communication Foundation (WCF) 和.NET Framework 4 的 Windows Workflow Foundation (WF) 示例若要下载所有 Windows Communication Foundation (WCF) 和WF示例。 此示例位于以下目录:

<InstallDrive>:\WF_WCF_Samples\WCF\Scenario\Ajax\WeaklyTypedJson

历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / .NET 中文文档历史快照
适用范围
历史中文快照 2019-08-18;详见原文产品版本;文档日期 03/30/2017
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。