2

我看过一些声称可以工作的教程，但它们已经过时或根本不起作用。

如何使用 JSON.Net 序列化和反序列化从我的 API 控制器接收和发送的数据？

我们正在使用VS2012。

更新

我有一个这样的模型

public class SearchModel
{
    public int PageIndex { get; set; }
    public int PageSize { get; set; }
    public Dictionary<string, object> Terms { get; set; }
}

还有一个像这样的 Api 控制器

public class ModelSearchApiController : ApiController
{

     public List<Model> Get([FromUri] SearchModel search)
     {
         return new List<Model>();
     }
}

但是，search在 Ajax 请求中提供正确的值集时，该属性Terms始终是一个空字典。

我知道我们可以提供一个值，[ { Key:"foo", Value:123 } ]但为什么我不能只传递一个普通的 JSON 对象（即{ foo:123 }）？？？为什么它可以将 a 序列Dictionary化为一个很好的标准 JSON 对象，但不能获取完全相同的对象并重新创建一个Dictionary. 这是在我身后。

编辑

换句话说，如果浏览器发送这些参数：

 pageIndex: 0
 pageSize: 100
 terms[foo]: Bar
 terms[buz]: 1234

所需的对象签名是什么？因为上面提到的对象不起作用，字典只是空的。

4

2 回答 2

6

JSON.NET是ASP.NET Web API的默认序列化程序 - 它可以在JSON和 CLR 对象之间转换，并且对所有 JSON 输入都这样做。但是，您不是在尝试将 JSON 输入转换为 SearchModel - 您是在尝试从类似于 application/x-www-form-urlencoded 的基于 URI 的格式转换为 CLR 类型 SearchModel，并且JSON.NET 不支持（它不是 JSON！）。通常，序列化程序用于（在传入请求上）从请求正文转换为操作参数。

让我们看一下下面的这个（完整）示例（假设默认路由， to "api/{controller}"）。这与您的问题非常相似，但除了 GET 方法之外，我还添加了一个 Post 方法。

public class ModelSearchApiController : ApiController
{
    public List<Model> Get([FromUri] SearchModel search)
    {
        return new List<Model>
        {
            new Model { PageIndex = search.PageIndex, PageSize = search.PageSize, Terms = search.Terms }
        };
    }

    public List<Model> Post(SearchModel search)
    {
        return new List<Model>
        {
            new Model { PageIndex = search.PageIndex, PageSize = search.PageSize, Terms = search.Terms }
        };
    }
}

public class Model
{
    public int PageIndex { get; set; }
    public int PageSize { get; set; }
    public Dictionary<string, object> Terms { get; set; }
}

public class SearchModel
{
    public int PageIndex { get; set; }
    public int PageSize { get; set; }
    public Dictionary<string, object> Terms { get; set; }
}

如果您将此请求发送到服务器：

POST http://localhost:64699/api/ModelSearchApi HTTP/1.1
User-Agent: Fiddler
Host: localhost:64699
Content-Type: application/json
Content-Length: 65

{"PageIndex":1,"PageSize":10,"Terms":{"foo":"bar","foo2":"bar2"}}

如您所料，它将绑定到 SearchModel 参数 - 该Terms属性将是一个包含两个条目的字典（foo=bar，foo2=bar2）。

现在，对于 GET 参数。ASP.NET Web API 有一个模型绑定器和值提供者的概念，这将是将查询字符串转换为操作参数的组件。默认的 binder / provider 不支持复杂类型中的字典的“任意”名称/值对语法 *。正如您所指出的，您可以使用键/值对语法，这将被理解，如下所示。

GET http://localhost:64699/api/ModelSearchApi?PageIndex=1&PageSize=10&Terms[0][key]=foo&Terms[0][value]=bar HTTP/1.1
User-Agent: Fiddler
Host: localhost:64699

现在，对于您的问题，您有两个选择。您可以更改您的 API 以使用知道如何理解“简单”名称/值语法的自定义模型绑定器或值提供程序，如下所示：

public class ModelSearchApiController : ApiController
{
    public List<Model> Get([ModelBinder(typeof(MySearchModelBinder))] SearchModel search)
    {
        return new List<Model>
        {
            new Model { PageIndex = search.PageIndex, PageSize = search.PageSize, Terms = search.Terms }
        };
    }
}

public class MySearchModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        SearchModel value = new SearchModel();
        value.Terms = new Dictionary<string,object>();
        foreach (var queryParams in actionContext.Request.GetQueryNameValuePairs())
        {
            if (queryParams.Key == "PageIndex")
            {
                value.PageIndex = int.Parse(queryParams.Value);
            }
            else if (queryParams.Key == "PageSize")
            {
                value.PageSize = int.Parse(queryParams.Value);
            }
            else if (queryParams.Key.StartsWith("Terms."))
            {
                value.Terms.Add(queryParams.Key.Substring("Terms.".Length), queryParams.Value);
            }
        }

        bindingContext.Model = value;
        return true;
    }
}

另一种选择是在发送到服务器之前在客户端上预处理您的输入数据，使用类似于下面的功能。

function objToKVPArray(obj) {
    var result = [];
    var k;
    for (k in obj) {
        if (obj.hasOwnProperty(k)) {
            result.push({ key: k, value: obj[k] });
        }
    }
    return result;
}
于 2013-05-14T22:06:54.883 回答
0

您可以参考下面的链接。希望这有帮助。

这是使用带有 Web API 的 Json.net的示例。

于 2013-05-14T16:13:55.257 回答