WebApi 2.0中的序列化问题

本文关键字：序列化 问题 WebApi | 更新日期: 2023-09-27 18:18:38

我正在使用EF 6.0 Code First, AutoMapper和WebApi 2.0开发一个REST API。

我正在努力序列化数据，或者更具体地说;选择响应请求时应该序列化的内容。

假设我正在为一个足球联赛创建一个应用程序，它有以下类:

public class Player
{
    public String Name { get; set; }
    public virtual ICollection<Team> Teams { get; set; } // example
}
public class Team
{
    public String Name { get; set; }
    public virtual ICollection<Team> Players { get; set; }
    public virtual ICollection<FootballGame> Games { get; set; }
}
public class FootballGame
{
    public Team Team1 { get; set; }
    public Team Team2 { get; set; }
    public DateTime DateTime { get; set; }
}

我有一个名为PlayersController的API控制器，和一个普通的Get方法url/API/players/id，它应该返回那个播放器。

然而，由于LazyLoading，序列化和多对多关系，我得到了与该播放器相关的每个对象返回:

{
  "$id": "1",
  "Id": 1,
  "Name": "Jon Jones",
  "Teams": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "Liverpool",
      "Players": [
        {
          "$id": "3",
          "Id": 2,
          "Name": "James White",
          "Teams": [
            {
              "$ref": "2"
            },
            {
              "$id": "4",
              "Id": 2,
              "Name": "Man Utd",
              "Players": [
                {
                  "$ref": "3"
                },
                {
                  "$id": "5",
                  "Id": 3,
                  "Name": "John Snow",
                  "Teams": [
                    {
                      "$ref": "2"
                    },
                    {
                      "$ref": "4"
                    }
                  ]
                },
                {
                  "$ref": "1"
                }
              ],
              "Games": [
                {
                  "$id": "6",
                  "Id": 1,
                  "Team1": {
                    "$ref": "2"
                  },
                  "Team2": {
                    "$ref": "4"
                  },
                  "DateTime": "2014-08-18T23:20:01.7797942+02:00"
                },
                {
                  "$id": "7",
                  "Id": 2,
                  "Team1": {
                    "$id": "8",
                    "Id": 3,
                    "Name": "Man City",
                    "Players": [
                      {
                        "$ref": "1"
                      },
                      {
                        "$ref": "3"
                      },
                      {
                        "$id": "9",
                        "Id": 4,
                        "Name": "Elton John",
                        "Teams": [
                          {
                            "$ref": "2"
                          },
                          {
                            "$ref": "8"
                          }
                        ]
                      }
                    ],
                    "Games": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$id": "10",
                        "Id": 5,
                        "Team1": {
                          "$ref": "2"
                        },
                        "Team2": {
                          "$ref": "8"
                        },
                        "DateTime": "2014-08-18T23:20:01.7807943+02:00"
                      }
                    ]
                  },
                  "Team2": {
                    "$ref": "4"
                  },
                  "DateTime": "2014-08-18T23:20:01.7807943+02:00"
                }
              ]
            },
            {
              "$ref": "8"
            }
          ]
        },
        {
          "$ref": "5"
        },
        {
          "$ref": "9"
        }
      ],
      "Games": [
        {
          "$ref": "6"
        },
        {
          "$ref": "10"
        }
      ]
    },
    {
      "$ref": "4"
    }
  ]
}

我如何以一种简单的方式选择只返回球员，而对于球队，而不是返回球队可以获得数据的url，如:

{
  "Id": 1,
  "Name": "Jon Jones",
  "Teams": "http://url/api/player/1/teams/"
}

编辑:通过禁用惰性加载，我得到:

{
  "Id": 1,
  "Name": "Jon Jones",
  "Teams": []
}

如果是这样的话，是否有一个"最佳实践"来添加uri来获得团队?

WebApi 2.0中的序列化问题

在构建web服务时应该禁用延迟加载-强制自己明确要获取的数据是很好的。另一种方法是删除你不想让序列化器看到的类属性上的[JsonIgnore]属性。

正如Robert Levy建议的那样，您应该禁用延迟加载。或者，除了实体之外，还应该定义DTO(数据传输对象)。这些只是普通的对象，不是实体框架的一部分。它们的目的是让您定义一个看起来与数据库不同的外部API。然后，您将查询实体并编写一些代码来将poco的内容映射到dto。

如果您正在做一些非常简单的事情，这可能看起来有点小题大做(因为您的dto可能看起来完全像您的实体框架对象)。

但是，对于任何重要的事情，将数据库设计与API的拓扑解耦是有用的。

相关文章：