javascript - ASP.Net webservices 中的 JSON 数组类型解析

Question

所以我想出了如何将我的自定义对象传递给 ASP.Net json webservices。很有魅力。

我遇到的问题是传入自定义对象的直接数组，或者传入作为自定义对象参数的数组。

所以例如...

Public Class WebService1
    Inherits System.Web.Services.WebService

    <WebMethod()> _
    <ScriptMethod(ResponseFormat:=ResponseFormat.Json)> _
    Public Function AddPersonList(ByVal PersonList As PersonList) As String
        Debug.Assert(False)
    End Function

    Public Class Person
        Public Sub New()
        End Sub

        Public Property FirstName As String
        Public Property LastName As String
    End Class

    Public Class PersonList
        Inherits List(Of Person)

    End Class
End Class

<script>
        $(function () {
            $.ajax({
                type: "POST",
                url: "WebService1.asmx/AddPersonList",
                data: " { PersonList: [ { FirstName: 'Max', LastName: 'Gershkovich' }, { FirstName: 'Test1', LastName: 'Test2' } ] }",
                contentType: "application/json; charset=utf-8",
                dataType: "json",
                success: function (e) { debugger; },
                error: function (e) { debugger; }
            });
        });
    </script>

失败并出现错误:值\"System.Collections.Generic.Dictionary`2[System.String,System.Object]\"不是\"WebApplication1.WebService1+Person\"类型，不能在此通用集合中使用。\r\n参数名称:值

那么我如何向 ASP.net 解释它实际上是一个 Person 数组呢？

请注意:将函数更改为 List(of Person) 或 ArrayList 确实有效，但鉴于我实现了自己的自定义集合，这对我来说并不是最佳选择。

更新:好的，到目前为止我已经解决的是这个问题肯定与 JavascriptSerializer 如何使用 SimpleTypeResolver 来解析类型有关。基本上如果我做这样的事情

Public Function AddPersonList(ByVal PersonList As String) As PersonList

我可以使用以下代码重新创建错误。

Dim PersonList As PersonList = jsonSerializer.Deserialize(Of PersonList)(PList)

但是，当我按照 的行提供我自己的自定义类型解析器时

Dim jsonSerializer As New JavaScriptSerializer(New MyCustomTypeResolver)

我可以成功创建自定义列表的实例。

现在我已经弄清楚了如何在 web.config 文件中提供我自己的自定义转换器。沿着这条线......

<system.web.extensions>
    <scripting>
      <webServices>
        <jsonSerialization>
          <converters>
            <add name="MyCustomConverter" type="WebApplication1.MyCustomConverter" />
          </converters>
        </jsonSerialization>
      </webServices>      
    </scripting>
  </system.web.extensions>

但问题是我找不到指定 CustomTypeResolver 的方法。我的假设是，这是我缺少的唯一一 block 拼图。

PSS:我尝试使用 SimpleTypeResolver ( SimpleTypeResolver MSDN ) 文档中指定的程序集完全限定名称，但这会引发“由于对象的当前状态，操作无效”。异常 - 这是 TypeResolver 无法解析名称时导致的错误(我通过使用我的 CustomTypeResolver 进行测试知道这一点)

更新@奥列格和肖恩:

我衷心感谢您的意见，实际上已经更改了我的应用程序以反射(reflect)您的建议；话虽如此，此更改的问题在于它需要以我希望避免的方式重新处理我的类实现及其相关行为。

我的问题从未将 List(of Object) 传递到我的 web 服务中(我只是提出这样的问题以简化它以用于 stackoverflow)。在这种情况下，我愿意完全接受使用 Generic List(of) 但我的问题实际上是我的一个自定义对象实现了一个具有强类型 List(of) 的属性，例如:

Customer {CustomerID AS Guid, FirstName AS String, LastName AS String, EmailAddresses AS EmailAddressList}

现在需要更改为

Customer {CustomerID AS Guid, FirstName AS String, LastName AS String, EmailAddresses AS List(Of EmailAddress)} 

诚然，这不是世界末日，并且在 web 服务上下文中可能更好(正如您所建议的那样)，但对于我的 Collection 属性的内部应用程序使用而言，这绝对是不利的。这意味着，一旦我有了这个属性，我要么需要在每次我想使用一些高级功能时将它转换为我的 CustomCollectionList，要么我需要实现另一个暴露 CustomCollectionList 的属性。这两种解决方案都会在我嘴里留下难闻的味道。

Answer 1

首先是数据

{ PersonList: [ { FirstName: 'Max', LastName: 'Gershkovich' }, { FirstName: 'Test1', LastName: 'Test2' } ] }

您发送到网络服务的是 错误的 JSON 数据 .您可以在 http://www.jsonlint.com/ 上验证数据.正确的 JSON 数据将是

{"PersonList":[{"FirstName":"Max","LastName":"Gershkovich"},{"FirstName":"Test1","LastName":"Test2"}]}

另外我推荐你永远不要手动制作 JSON .相反，您应该使用 JSON.stringify .在大多数情况下，函数甚至是 natively supported在网络浏览器中(有时在像 here 这样的更新之后)。可以正确序列化 Web 服务参数

$.ajax({
    data: {PersonList:JSON.stringify(t)} 
    // other parameters
});

(参见 here 了解更多详情)或

$.ajax({
    data: JSON.stringify({ PersonList: t })
    // other parameters
});

在哪里

var t = [ { FirstName: 'Max', LastName: 'Gershkovich' },
          { FirstName: 'Test1', LastName: 'Test2' } ];

哪个版本的数据表示JSON.stringify({ PersonList: t })或 {PersonList:JSON.stringify(t)}是否正确取决于其他事情。很容易测试哪些在您的环境中工作。

下一个小问题:你最好使用List(Of Person)直接在AddPersonList的参数中而不是使用类型 PersonList继承自 List(Of Person) .

更新 : 刚才看了你对List(Of Person)的评论或 PersonList另一个答案。为了防止同样的讨论，我决定写下我对此的看法。在 Web 服务中使用哪些类并不重要。您应该设计 Web 服务的接口(interface)，使其应为 简单明了对于每个对您的实现一无所知的人。该方法的输入数据(至少您在问题中包含的数据)可以用 List(Of Person) 完美描述.此外List(Of Person)它有利于数据传输。 方法实现内部您可以转换 List(Of Person)到任何其他对方法内部有好处的类。比如构造PersonList很简单来自 List(Of Person) .所以我建议你遵循这样的方式:保持 Web 服务的接口(interface)不受实现细节的影响。

更新 2 : 如果作为 Web 方法的输入参数的对象具有其他对象(如 List(Of EmailAddress))作为属性，则根本不是问题。 .例如，如果您定义 EmailAddress从你的最后一个例子

Public Class EmailAddress
    Public Property Type As String
    Public Property Address As String
End Class

和 Customer喜欢

Public Class Customer
    'Public CustomerID As Guid
    Public Property FirstName As String
    Public Property LastName As String
    Public Property EmailAddresses As List(Of EmailAddress)
End Class

那么 AddPersonList 就没有问题了web方法定义如下

<WebMethod()> _
Public Function AddPersonList(ByVal PersonList As List(Of Customer)) As String

以同样的方式你可以使用

<WebMethod()> _
Public Function AddPersonList1(ByVal input As InputData) As String

和

Public Class InputData
    Public Property PersonList As List(Of Customer)
End Class

或许多其他版本的对象，以使用 $.ajax 将信息发送到 Web 服务器.

在客户端，您可以定义 myData如下

var myData = [
        { FirstName: 'Max', LastName: 'Gershkovich',
            EmailAddresses: [
                { Type: 'SMTP', Address: 'Max.Gershkovich@googlemail.com' },
                { Type: 'SMTP', Address: 'Max.Gershkovich@mail.ru' },
            ]
        },
        { FirstName: 'Test1', LastName: 'Test2' }
    ];

然后将数据发送到Web服务器

$.ajax({
    type: "POST",
    url: "WebService1.asmx/AddPersonList",
    data: JSON.stringify({ PersonList: myData }),
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    success: function (data) {
        alert(data.d);
    },
    error: function (xhr, textStatus, errorThrown) {
        alert("Error Occured!" + " | " + xhr.responseText + " | " +
              textStatus + " | " + errorThrown);
    }
});

或者

$.ajax({
    type: "POST",
    url: "WebService1.asmx/AddPersonList1",
    data: JSON.stringify({ input: {PersonList: myData} }),
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    success: function (data) {
        alert(data.d);
    },
    error: function (xhr, textStatus, errorThrown) {
        alert("Error Occured!" + " | " + xhr.responseText + " | " +
              textStatus + " | " + errorThrown);
    }
});

以上所有工作都没有任何问题。您可以下载the test example ，执行此操作(应启动 Default.htm。要调用该方法，您应单击第一个或第二个按钮)。

如果您查看 myData客户端代码中定义的对象再看JSON.stringify的用法在上面你会看到 您可以毫无问题地发送任何复杂的对象，包括数组和属性 .在服务器端，您可以使用 List(Of Customer) , List(Of EmailAddress)或其他对象的列表作为 JavaScript 数组的表示形式。一切都会奏效。只有您原来的对象继承示例是一个不好的示例。

如果你会尝试设计Web服务的界面从客户端而不是从内部服务器结构看您将轻松为 Web 方法的相应输入参数构造类。一切都会立即生效。如果您需要使用这些信息初始化您的内部类，您将能够非常简单地完成它。这种数据转换将非常容易，您无需编写任何实际上相同的 CustomTypeResolver。