通过 Web Api 在 POST 中返回对象是一种不好的做法吗？答案

【问题标题】：Is it a bad practice to return an object in a POST via Web Api?通过 Web Api 在 POST 中返回对象是一种不好的做法吗？
【发布时间】：2012-07-14 11:51:26
【问题描述】：

我正在使用 Web Api 并且有一个场景，客户端每隔 n 秒发送一次心跳通知。有一个心跳对象是在 POST 而不是 PUT 中发送的，因为在我看来，它们正在创建一个新的心跳而不是更新现有的心跳。

此外，客户端有一个要求，即要求他们检索所有其他当前在线的客户端以及单个客户端拥有的未读消息的数量。在我看来，我有两个选择：

执行 POST，然后执行 GET，从纯 REST 的角度来看，这对我来说似乎更清晰。我正在创建和检索，我认为 SOLID 原则更愿意相应地拆分它们。但是，这种方法意味着两次往返。
让 POST 返回一个对象，该对象包含与 GET 否则会完成的相同信息。这会将所有内容合并到一个请求中，但我担心这种方法会被认为是不明智的。这不是纯粹的 POST。

删除的选项 #2 如下所示：

public HeartbeatEcho Post(Heartbeat heartbeat)
    {
    }

HeartbeatEcho 是一个类，其中包含其他在线客户端的属性和未读消息的数量。

Web Api 当然支持选项#2，但仅仅因为我可以做某事并不意味着我应该这样做。选项 #2 是可憎的、过早的优化还是实用主义？

【问题讨论】：

标签： rest asp.net-web-api solid-principles

【解决方案1】：

选项2根本不是可憎的。 POST 请求创建一个新资源，但资源本身返回给调用者是很常见的。例如，如果您的资源是数据库中的项目（例如，Person），则 POST 请求将发送 INSERT 操作所需的成员（例如，姓名、年龄、地址），并且响应将包含 Person 对象，该对象在除了作为输入传递的参数外，它还有一个标识符（数据库主键），可用于唯一标识对象。

请注意，POST 请求仅返回新创建资源的 id 也是完全有效的，但这是您可以选择的，具体取决于客户端的要求。

public HttpResponseMessage Post(Person p)
{
    var id = InsertPersonInDBAndReturnId(p);
    p.Id = id;
    var result = this.Request.CreateResponse(HttpStatusCode.Created, p);
    result.Headers.Location = new Uri("the location for the newly created resource");
    return result;
}

【讨论】：

【解决方案2】：

无论哪种方式都可以解决您的业务问题。您是正确的 POST 新记录与 PUT 更新现有记录。

建议： 您可能要考虑的一件事是将 Redis 添加到您的堆栈中，并且应用程序可以非常快速地发布，然后您可以将 Pub/Sub 功能用于 echo 部分或 Blpop（阻塞直到记录匹配标准）。它速度极快，可以帮助您进行扩展，并针对您正在尝试做的事情进行完美设计。

见：http://redis.io/topics/pubsub/

见：http://redis.io/commands/blpop

我将 Redis 用于类似的用途，但也使用过 RabbitMQ，通过 RabbitMQ，我们添加了 socket.io 连接以实时“流式传输”心跳，而无需长时间轮询。

【讨论】：