如何使用相同的MVC控制器方法处理数组或单个对象?

时间:2013-09-05 17:52:47

标签: c# json asp.net-mvc-4

我有一个ActionResult方法,它接受一个列表作为参数:

[HttpPost]
public ActionResult MyMethod (List<ClassA> json)
{
   ...
}

这会将进入的Json字符串绑定到已填充的ClassA对象的通用列表。

问题是有时json进来只是一个json对象而不是json对象数组。

有没有办法抢占这个,所以我可以直接绑定到ClassA vs List?或者我还可以使用其他技术吗?

以下是JSON的发送方式(作为数组):

var myjsonarray = [{
  "ID": "1",
  "FirstName": "John",
  "LastName": "Doe",
}, {
  "ID": "2",
  "FirstName": "Jane",
  "LastName": "Doe",
}];

$.ajax({
 type: "POST",
 contentType: "application/json; charset=utf-8",
 url: "/Home/MyPage",
 data: JSON.stringify(myjsonarray),
 dataType: 'json'
});

以上流程很好。这也有效:

var myjsonarray = [{
  "ID": "1",
  "FirstName": "John",
  "LastName": "Doe",
}];

但是当我作为一个未包装在数组中的单个对象发送时:

var myjsonarray = {
  "ID": "1",
  "FirstName": "John",
  "LastName": "Doe",
};

我的ActionResult方法参数为null:

json == null

3 个答案:

答案 0 :(得分:3)

虽然从您的问题中不清楚,但从其他答案的评论中可以看出,您无法控制向您发送此JSON的客户端代码。 (如果你这样做,最简单的解决方案是在发送之前将你的单个对象包装在一个数组中,正如其他人已经建议的那样。)

如果MVC允许我们在控制器中添加方法重载以处理这种情况,那将是很好的,例如:

[HttpPost]
public ActionResult MyMethod (List<ClassA> list)
{
   ...
}

[HttpPost]
public ActionResult MyMethod (ClassA single)
{
   ...
}

虽然这个编译得很好但是很遗憾,当你在运行时点击该方法时会导致System.Reflection.AmbiguousMatchException

因此,您似乎需要创建自定义IModelBinder来解决问题。虽然我之前没有实现自定义模型绑定器,但我将其作为挑战并提出了以下内容。你显然必须根据自己的需要调整它,但它似乎适用于你的例子。

以下是代码:

public class CustomModelBinder : IModelBinder
{
    public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
    {
        IValueProvider provider = bindingContext.ValueProvider;

        // Check whether we have a list or a single object.  If we have a list
        // then all the properties will be prefixed with an index in square brackets.
        if (provider.ContainsPrefix("[0]"))
        {
            // We have a list.  Since that is what the controller method is 
            // expecting, just use the default model binder to do the work for us.
            return ModelBinders.Binders.DefaultBinder.BindModel(controllerContext, bindingContext);
        }
        else
        {
            // We have a single object.
            // Bind it manually and return it in a list.
            ClassA a = new ClassA();
            a.ID = GetValue<int>(provider, "ID");
            a.FirstName = GetValue<string>(provider, "FirstName");
            a.LastName = GetValue<string>(provider, "LastName");
            return new List<ClassA> { a };
        }
    }

    private T GetValue<T>(IValueProvider provider, string key)
    {
        ValueProviderResult result = provider.GetValue(key);
        return (result != null ? (T)result.ConvertTo(typeof(T)) : default(T));
    }
}

要将此自定义绑定器插入MVC管道,请将此行添加到Application_Start()中的Global.asax.cs方法。

ModelBinders.Binders.Add(typeof(List<ClassA>), new CustomModelBinder());

现在,显然这不是一般的解决方案;它专门用于处理ClassA而不是其他任何东西。我不得不相信有可能制定一个通用的解决方案来处理任何类型列表的“单一或列表”情况,但这要复杂得多,超出了这个答案的范围。为此,您可能还需要创建自定义IModelBinderProvider。如果你想把它带到那个级别,你需要自己调查。这是一个MSDN article,可以让您更深入地了解幕后的绑定方式。

答案 1 :(得分:1)

您最好保持API不变,并将此逻辑添加到JavaScript代码中,以便始终传递与列表相同的类型。它易于维护和测试。

if(typeof(myjsonarray) === 'object'){
    myjsonarray = [myjsonarray];
}

答案 2 :(得分:0)

因为您接受集合所以需要通过js中的数组发送集合:

您甚至可以为一个元素创建数组

您可以创建另一个操作方法来接受元素而不是数组

HTH