WebAPI 实例化对象，即使它们在 JSON 中为空

Question

在将 JSON 模型发布到 WebAPI 控制器方法时，我注意到如果 JSON 模型中有空对象，模型绑定器将实例化这些项目，而不是在服务器端对象中将它们保持为空。

这与普通 MVC 控制器绑定数据的方式形成对比......如果对象在 JSON 中为空，它不会实例化一个对象。

MVC 控制器

public class HomeController : Controller
{
    [HttpPost]
    public ActionResult Test(Model model)
    {
        return Json(model);
    }
}

WebAPI 控制器

public class APIController : ApiController
{
    [HttpPost]
    public Model Test(Model model)
    {
        return model;
    }
}

将被发布的模型类

public class Model
{
    public int ID { get; set; }
    public Widget MyWidget { get; set; }
}

Model类中使用的类

public class Widget
{
    public int ID { get; set; }
    public string Name { get; set; }
}

以下是我向每个控制器发布 JSON 模型时的结果：

$.post('/Home/Test', { ID: 29, MyWidget: null })
//Results in: {"ID":29,"MyWidget":null}

$.post('/api/api/Test', { ID: 29, MyWidget: null })
//Results in: {"ID":29,"MyWidget":{"ID":0,"Name":null}}

如您所见，WebAPI 方法用一个对象实例化了 MyWidget 属性，而 MVC 操作将其保留为空。

在我看来，WebAPI 会以这种方式运行并不直观。为什么会这样做？我可以让它在这方面表现得像 MVC 动作吗？

Answer 1

使用 newtonsoft 序列化程序。 Newtonsoft.Json 保持它们为空

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Serialization;


public static class WebApiConfig
        {
            public static void Register(HttpConfiguration config)
            {
              var jsonformatter = new JsonMediaTypeFormatter();
              config.Formatters.Clear();
              config.Formatters.Add(jsonformatter);
         }
    }

Answer 2

我认为这与我们之前在项目中遇到的问题类似。

您必须将 jQuery 的邮政编码更改为以下代码：

$.ajax({
            type: 'POST',
            url: '/api/api/Test',
            data: JSON.stringify({ ID: 29, MyWidget: null }),
            contentType: "application/json",
            dataType: 'json',
            timeout: 30000
        })
        .done(function (data) {
        })
        .fail(function() {
        });

默认情况下，jQuery 'posts' 将参数作为 form-url-encoded 数据发送。

应用程序/x-www-form-urlencoded
编号 29
我的小部件

ID=29&MyWidget=

所以它被完全正确地反序列化了。 MyWidget 是空字符串，所以 Widget 类的值为空。

另外我建议你为 WebApi 控制器添加 Formatters 配置：

public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        // Formatters
        JsonMediaTypeFormatter json = config.Formatters.JsonFormatter;

        config.Formatters.Clear();
        config.Formatters.Add(json);
    }

因此，您将只使用 JSON 格式器进行 ​​API 调用。

更新

传递给 MVC 控制器的 form-url-encoded 数据将由运行时处理并最终由 DefaultModelBinder 处理的主要区别（如果自定义绑定器不可用）。因此，编码为 form-url 的数据对于 MVC 来说很常见，因为通常数据是由 HTML 表单发布生成的。但是 Web API 在设计上并不依赖于任何特定的编码。所以它使用特定的机制（格式化程序）来解析数据......例如上面的json。因此 System.Net.Http.Formatting 中的 FormUrlEncodedMediaTypeFormatter 和 System.Web.Mvc 中的 DefaultModelBinder 处理空字符串的方式不同。

对于 DefaultModelBinder，空字符串将被转换为 null。 分析代码我可以确定 BindModel 方法首先创建空模型：

 if (model == null)
 {
     model = CreateModel(controllerContext, bindingContext, modelType);
 }

之后会填充属性：

// call into the property's model binder
        IModelBinder propertyBinder = Binders.GetBinder(propertyDescriptor.PropertyType);
        object originalPropertyValue = propertyDescriptor.GetValue(bindingContext.Model);
        ModelMetadata propertyMetadata = bindingContext.PropertyMetadata[propertyDescriptor.Name];
        propertyMetadata.Model = originalPropertyValue;
        ModelBindingContext innerBindingContext = new ModelBindingContext()
        {
            ModelMetadata = propertyMetadata,
            ModelName = fullPropertyKey,
            ModelState = bindingContext.ModelState,
            ValueProvider = bindingContext.ValueProvider
        };
        object newPropertyValue = GetPropertyValue(controllerContext, innerBindingContext, propertyDescriptor, propertyBinder);

最后，GetBinder 将为 Widget 类型（属性类型）返回 fallbackBinder。 fallbackBinder 本身将调用 ConvertSimpleType ，其中字符串处理如下：

        string valueAsString = value as string;
        if (valueAsString != null && String.IsNullOrWhiteSpace(valueAsString))
        {
            return null;
        }

我猜没有任何标准描述从 url 编码字符串到 C# 对象的转换。所以我不知道哪个是正确的。无论如何，我确信您需要通过 AJAX 调用而不是表单 URL 编码的数据传递 json。