Acciones del controlador ASP.NET MVC que devuelven JSON o html parcial

Question

Estoy intentando crear acciones de controlador que devolverán JSON o html parcial según un parámetro. ¿Cuál es la mejor manera de obtener el resultado devuelto a una página MVC de forma asíncrona?

Answer 1

En su método de acción, devuelva Json (objeto) para devolver JSON a su página.

public ActionResult SomeActionMethod() { 
    return Json(new {foo="bar", baz="Blech"}); 
} 

Luego solo llame al método de acción usando Ajax. Se podría utilizar uno de los métodos auxiliares de la ViewPage como

<%= Ajax.ActionLink("SomeActionMethod", new AjaxOptions {OnSuccess="somemethod"}) %> 

SomeMethod sería un método javascript que se evalúa el objeto JSON devuelto.

Si desea devolver una cadena sencilla, sólo se puede utilizar el ContentResult:

public ActionResult SomeActionMethod() { 
    return Content("hello world!"); 
} 

ContentResult por defecto devuelve un text/plain como su contentType.
Esta es sobrecargable por lo que también se puede hacer:

return Content("<xml>This is poorly formatted xml.</xml>", "text/xml"); 

Answer 2

Otra buena manera de tratar con datos JSON está utilizando la función jQuery getJSON. Usted puede llamar al método

public ActionResult SomeActionMethod(int id) 
{ 
    return Json(new {foo="bar", baz="Blech"}); 
} 

del método jQuery getJSON simplemente ...

$.getJSON("../SomeActionMethod", { id: someId }, 
    function(data) { 
     alert(data.foo); 
     alert(data.baz); 
    } 
); 

Answer 3

Para responder a la otra mitad de la pregunta, puede llamar a:

return PartialView("viewname"); 

cuando quieres devolver HTML parcial Simplemente tendrá que encontrar la manera de decidir si la solicitud desea JSON o HTML, tal vez en función de una parte/parámetro de la URL.

Answer 4

Creo que debería considerar los tipos de aceptación de la solicitud. Lo estoy usando en mi proyecto actual para devolver el tipo de contenido correcto de la siguiente manera.

Su acción en el controlador puede poner a prueba como en el objeto de la petición

if (Request.AcceptTypes.Contains("text/html")) { 
    return View(); 
} 
else if (Request.AcceptTypes.Contains("application/json")) 
{ 
    return Json(new { id=1, value="new" }); 
} 
else if (Request.AcceptTypes.Contains("application/xml") || 
     Request.AcceptTypes.Contains("text/xml")) 
{ 
    // 
} 

A continuación, puede poner en práctica el aspx de la vista para atender el caso XHTML respuesta parcial.

Luego, en jQuery se puede recuperar lo que pasa el parámetro de tipo como JSON:

$.get(url, null, function(data, textStatus) { 
     console.log('got %o with status %s', data, textStatus); 
     }, "json"); // or xml, html, script, json, jsonp or text 

Esperanza esto ayuda James

Answer 5

Es posible que desee echar un vistazo a este artículo muy útil que cubre esta misma ¡bien!

Pensé que podría ayudar a las personas que buscan una buena solución a este problema.

http://weblogs.asp.net/rashid/archive/2009/04/15/adaptive-rendering-in-asp-net-mvc.aspx

Answer 6

Para las personas que han actualizado a MVC 3 aquí es una clara forma Using MVC3 and Json

Answer 7

solución alternativa con incoding framework

retorno Acción JSON

controlador

[HttpGet] 
    public ActionResult SomeActionMethod() 
    { 
     return IncJson(new SomeVm(){Id = 1,Name ="Inc"}); 
    } 

página Razor

@using (var template = Html.Incoding().ScriptTemplate<SomeVm>("tmplId")) 
{ 
    using (var each = template.ForEach()) 
    { 
     <span> Id: @each.For(r=>r.Id) Name: @each.For(r=>r.Name)</span> 
    } 
} 

@(Html.When(JqueryBind.InitIncoding) 
    .Do() 
    .AjaxGet(Url.Action("SomeActionMethod","SomeContoller")) 
    .OnSuccess(dsl => dsl.Self().Core() 
           .Insert 
           .WithTemplate(Selector.Jquery.Id("tmplId")) 
           .Html()) 
    .AsHtmlAttributes() 
    .ToDiv()) 

retorno Acción html

controlador

[HttpGet] 
    public ActionResult SomeActionMethod() 
    { 
     return IncView(); 
    } 

página Razor

@(Html.When(JqueryBind.InitIncoding) 
    .Do() 
    .AjaxGet(Url.Action("SomeActionMethod","SomeContoller")) 
    .OnSuccess(dsl => dsl.Self().Core().Insert.Html()) 
    .AsHtmlAttributes() 
    .ToDiv()) 

Answer 8

Encontré un par de problemas al implementar MVC ajax GET llamadas con JQuery que me causaron dolores de cabeza por lo que compartí soluciones aquí.

1. Asegúrese de incluir el tipo de datos "json" en la llamada ajax. Esto automáticamente analizará el objeto JSON devuelto por usted (dado que el servidor devuelve JSON válido).
2. Incluya el JsonRequestBehavior.AllowGet; sin este MVC devolvía un error HTTP 500 (con dataType: json especificado en el cliente).
3. Agregue cache: false a la llamada $ .ajax, de lo contrario obtendrá respuestas HTTP 304 (en lugar de respuestas HTTP 200) y el servidor no procesará su solicitud.
4. Finalmente, json distingue entre mayúsculas y minúsculas, por lo que la carcasa de los elementos debe coincidir en el lado del servidor y del lado del cliente.

JQuery muestra:

$.ajax({ 
    type: 'get', 
    dataType: 'json', 
    cache: false, 
    url: '/MyController/MyMethod', 
    data: { keyid: 1, newval: 10 }, 
    success: function (response, textStatus, jqXHR) { 
    alert(parseInt(response.oldval) + ' changed to ' + newval);          
    }, 
    error: function(jqXHR, textStatus, errorThrown) { 
    alert('Error - ' + errorThrown); 
    } 
}); 

Muestra código MVC:

[HttpGet] 
public ActionResult MyMethod(int keyid, int newval) 
{ 
    var oldval = 0; 

    using (var db = new MyContext()) 
    { 
    var dbRecord = db.MyTable.Where(t => t.keyid == keyid).FirstOrDefault(); 

    if (dbRecord != null) 
    { 
     oldval = dbRecord.TheValue; 
     dbRecord.TheValue = newval; 
     db.SaveChanges(); 
    } 
    } 

    return Json(new { success = true, oldval = oldval}, 
       JsonRequestBehavior.AllowGet); 
} 

Answer 9

PartialViewResult y JSONReuslt heredar de la ActionResult clase base. entonces si el tipo de devolución se decide dinámicamente, declare el resultado del método como ActionResult.

public ActionResult DynamicReturnType(string parameter) 
     { 
      if (parameter == "JSON") 
       return Json("<JSON>", JsonRequestBehavior.AllowGet); 
      else if (parameter == "PartialView") 
       return PartialView("<ViewName>"); 
      else 
       return null; 


     } 

Answer 10

public ActionResult GetExcelColumn() 
    {    
      List<string> lstAppendColumn = new List<string>(); 
      lstAppendColumn.Add("First"); 
      lstAppendColumn.Add("Second"); 
      lstAppendColumn.Add("Third"); 
    return Json(new { lstAppendColumn = lstAppendColumn, Status = "Success" }, JsonRequestBehavior.AllowGet); 
      } 
     }