弱类型 JSON 序列化示例

项目
05/09/2023

将用户定义的类型序列化为给定的连网格式，或者将连网格式反序列为原来的用户定义的类型时，给定的用户定义的类型必须在服务和客户端上可用。通常，为实现此目的，系统将 DataContractAttribute 属性应用于这些用户定义的类型，并将 DataMemberAttribute 属性应用于这些类型的成员。处理 JavaScript 对象符号 (JSON) 对象时，该机制同样适用，如主题 How to: Serialize and Deserialize JSON Data中所述。

在某些情况下，服务或客户端必须访问由不受开发人员控制的服务或客户端生成的 JSON 对象。随着越来越多的 Web 服务公开 JSON API，由 WCF 开发人员构造任意 JSON 对象要反序列化为的本地用户定义的类型可能会不切实际。

WeaklyTypedJson 示例提供了一种机制，使 WCF 开发人员无需创建用户定义的类型便可处理反序列化的任意 JSON 对象。这称为 JSON 对象的“弱类型序列化” ，因为 JSON 对象反序列化为的类型在编译时是未知的。

例如，一个公共 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"] 对象的要求的说明，请参阅主题 ["root"]中所述。

备注

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

若要使用 JsonObject 类型，客户端操作协定必须使用 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 构造函数采用通过 XmlDictionaryReader方法获取的 GetReaderAtBodyContents 。该读取器包含客户端接收的 JSON 消息的 XML 表示形式。有关详细信息，请参阅主题 JSON 与 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.

设置、生成和运行示例

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
按照在 Building the Windows Communication Foundation Samples中所述的方法生成解决方案 WeaklyTypedJson.sln。
运行解决方案。

通过

弱类型 JSON 序列化示例

设置、生成和运行示例

其他资源