Web Api 2.0中的序列化问题

时间:2014-08-18 21:23:05

标签: c# rest json.net asp.net-web-api asp.net-web-api2

我正在使用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"
    }
  ]
}

我如何以一种简单的方式选择仅返回玩家,而对于团队而言,返回可以获得团队数据的网址,例如:

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

编辑: 通过根据建议解除延迟加载,我得到:

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

如果可行的话,是否有最佳实践&#34;添加uri以便让团队进入那里?

2 个答案:

答案 0 :(得分:1)

您应该在构建Web服务时禁用延迟加载 - 最好强制自己明确提取哪些数据。另一种方法是在您不希望序列化程序查看的类的属性上删除[JsonIgnore]属性。

答案 1 :(得分:0)

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

如果您正在做一些非常简单的事情,这看起来有点过分(因为您的DTO看起来可能与您的实体框架对象完全相同。

但是,对于任何非常重要的事情,将数据库设计与API的拓扑结构分离可能很有用。