ASP.NET Core Web API - 如何处理 URL 查询字符串中的“null”与“undefined”？

Question

我正在使用 ASP.NET Core Web API (v3.1) 实现 REST API。目前，当通过 URL 中的查询字符串传递时，我不确定如何区分“未定义”值和“空”值。

例如，假设 API 管理用户，所有用户都有名字和姓氏。此外，所有用户都可能有一个中间名。

REST API 允许像这样查询这些用户：

GET api/user?lastName=doe

（这将返回姓氏“Doe”的用户资源集合）。相关的控制器类可能如下所示：

[HttpGet]
public IActionResult GetUsers(string firstName, string lastName, string middleName)
{
    // Search database for users
    // Ignore firstName and middleName, because they are null
}

当查询包含中间名时，我的问题出现了：

GET api/user?middleName=null&firstName=john

此查询（其中middleName 明确设置为null）应返回名字为“John”且没有中间名的用户。对比请求

GET api/user?firstName=john

（其中middleName 是undefined）应该返回所有名字为“John”的用户，无论他们是否有中间名。

在这两种情况下，我的控制器方法中的middleName 参数都设置为null。如何区分控制器中的这些查询？

编辑：

我的示例具有误导性，并且表现不如我预期，因为

GET api/user?middleName=null&firstName=john

将middleName 设置为字符串值"null" 而不是null（就像什么都没有）。

我仍然想让客户端搜索没有中间名的用户（中间名的数据库值为 NULL）。这如何通过 URL 传递并由控制器进一步处理？

Answer 1

一般来说，当来自请求时，没有固有的方法来区分 null 和 undefined，因为它们本质上是相同的。所有值最初都是字符串，然后由模型绑定器强制转换为它们的实际类型。

正如其他人已经指出的那样，这里的middleName=null 表示您将middleName 设置为“null”，不是 null，因为它是一个字符串进入一个字符串。如果您想允许这种约定，您需要执行以下操作：

if (middleName == "null")
    middleName = null;

但是，在查询字符串中指定 null 的真正方法是提供不带值的键，例如param1=&param2=foo。在这里，param1 没有任何价值。尽管如此，模型绑定器仍会将其解释为 ""，而不是 null。您当然可以执行与上述相同的操作，检查此条件并将其显式设置为 null，或者仅使用 string.IsNullOrEmpty 作为值的测试。

这仍然没有涵盖如何确定它是否被显式设置。默认情况下，所有操作参数都是可选的。您可以在这里做的最好的事情是明确检查查询中是否存在该值：

if (Request.Query.ContainsKey("middleName"))
    // explicitly passed

然后，您可以根据该值是否实际存在于查询中来决定如何处理该值。