WebApi 服务中的 [FromUri] 属性忽略了 DataMember 的 Name 属性

Question

我们正在使用 Asp.Net WebApi 创建 RestService。但是由于某种原因，当尝试使用 [FromURI] 属性反序列化复杂属性时，DataMember 属性中的 Name 属性会被忽略。

例如，我们可能有： 方法：

public IHttpActionResult Get([FromUri]User user)

型号：

[DataContract]
public class User
{
    [DataMember(Name = "username")]
    public string Username{ get; set; }
    [DataMember(Name = "isActive", IsRequired = false)]
    public bool? Active { get; set; }
}

当反序列化user 时，我们得到了预期的用户名，但null 得到Active。另一方面，在序列化数据时，我们得到了isActive 和username，正如预期的那样。如果我们在查询字符串中发送带有active 的请求，它将按预期工作。

IModelBinder 显然有问题。由于某种原因，它不使用DataMember 的Name 属性。我检查了包含哪些格式器，并注册了 4 个默认格式器：

System.Net.Http.Formatting.JsonMediaTypeFormatter
System.Net.Http.Formatting.XmlMediaTypeFormatter
System.Net.Http.Formatting.FormUrlEncodedMediaTypeFormatter
System.Net.Http.Formatting.JQueryMvcFormUrlEncodedFormatter

我没有办法检查哪个是应要求使用的。我会假设它是FormUrlEncodedMediaTypeFormatter，但我不能确定。另外，我不确定它是否支持Name 属性。

我已经检查了一个解决方案，我能找到的最接近的主题是WebAPI DataMember Name not used when de/serializing via application/x-www-form-urlencoded，但它没有使用[FromUri]，而是使用application/x-www-form-urlencoded 属性，它并没有真正解决。

任何想法、指示或建议将不胜感激。

Answer 1

使用[FromQuery] 代替其他属性。

根据您的要求制作模型 http://localhost:8080/api/users?username=John&isActive=true

[Route("api/users")]
public class UsersController : Controller
{
    [HttpGet]
    public IHttpActionResult Get(User user)
    {
        //...
    }
}

看起来像

public class User
{
    [FromQuery(Name = "username")]
    public string Username{ get; set; }
    [FromQuery(Name = "isActive")]
    public bool? Active { get; set; }
}

无论如何，最佳实践是将名称保留在模型中，因为它在查询中为名称提供参数。 在这种情况下，您不必提供“名称”参数，只需在 queryClass 上保留[FromQuery]，并且 .Net 会自动提供小写。

Answer 2

您必须检查您的“获取”请求。你的get请求一定是这样的；

GET api/foo?username=fooname&active=false

您不必使用 DataContract 和 DataMember 属性来实现这一点。这些属性只是为了另一件事，它不是使用的主要原因。

在你的get方法获得有效命中后，你可以在你的方法中检查模型状态；

if (ModelState.IsValid) {
/// your code goes here    
}