actions du contrôleur ASP.NET MVC qui retournent JSON ou html partiel

Question

J'essaye de créer des actions de contrôleur qui retourneront JSON ou html partiel selon un paramètre. Quel est le meilleur moyen de renvoyer le résultat à une page MVC de manière asynchrone?

Answer 1

Dans votre méthode d'action, renvoyez Json (objet) pour renvoyer JSON à votre page.

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

Appelez simplement la méthode d'action en utilisant Ajax. Vous pouvez utiliser l'une des méthodes d'aide de la ViewPage tels que

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

SomeMethod serait une méthode javascript qui évalue ensuite l'objet JSON retourné.

Si vous voulez retourner une chaîne de caractères, vous pouvez simplement utiliser le ContentResult:

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

ContentResult par défaut retourne un texte/simple comme contentType.
C'est surchargeable vous pouvez donc aussi faire:

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

Answer 2

Une autre belle façon de traiter les données JSON utilise la fonction JQuery getJSON. Vous pouvez appeler le

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

Méthode de la méthode jquery getJSON simplement ...

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

Answer 3

Pour répondre à l'autre moitié de la question, vous pouvez appeler:

return PartialView("viewname"); 

quand vous voulez retourner du HTML partiel. Vous devrez juste trouver un moyen de décider si la requête nécessite JSON ou HTML, peut-être en fonction d'une partie/paramètre d'URL.

Answer 4

Je pense que vous devriez considérer les AcceptTypes de la requête. Je l'utilise dans mon projet actuel pour renvoyer le type de contenu correct comme suit.

Votre action sur le contrôleur peut tester comme sur l'objet de la demande

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")) 
{ 
    // 
} 

Vous pouvez ensuite mettre en œuvre le ASPX de la vue de répondre le cas de réponse partielle xhtml.

Puis, en jQuery vous pouvez chercher faisant passer le paramètre de type 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 

Hope this helps James

Answer 5

Vous pouvez jeter un oeil à cet article très utile qui couvre cette très bien! Je pensais juste que cela pourrait aider les gens à la recherche d'une bonne solution à ce problème.

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

Answer 6

Pour les gens qui ont mis à jour pour MVC 3 ici est une belle façon Using MVC3 and Json

Answer 7

solution alternative avec incoding framework

retour d'action JSON

Contrôleur

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

page 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()) 

retour Action html

Contrôleur

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

page Razor

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

Answer 8

J'ai trouvé quelques problèmes d'implémentation des appels ajax GET de MVC avec JQuery qui m'ont causé des maux de tête pour partager des solutions ici.

1. Assurez-vous d'inclure le type de données "json" dans l'appel ajax. Cela analysera automatiquement l'objet JSON retourné pour vous (étant donné que le serveur renvoie json valide).
2. Inclure le JsonRequestBehavior.AllowGet; sans ce MVC renvoyait une erreur HTTP 500 (avec dataType: json spécifié sur le client).
3. Ajoutez cache: false à l'appel $ .ajax, sinon vous obtiendrez des réponses HTTP 304 (au lieu des réponses HTTP 200) et le serveur ne traitera pas votre requête.
4. Enfin, le json est sensible à la casse, de sorte que le boîtier des éléments doit correspondre du côté serveur et côté client.

échantillon JQuery:

$.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); 
    } 
}); 

Exemple de code 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 et JSONReuslt hériter de la classe de base ActionResult. donc si le type de retour est décidé dynamiquement, déclarez la sortie de la méthode comme 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); 
      } 
     }