JSONまたはHTMLの一部を返すASP.NET MVCコントローラーアクション


406

パラメータに応じてJSONまたは部分的なHTMLを返すコントローラーアクションを作成しようとしています。結果を非同期でMVCページに返す最良の方法は何ですか?

回答:


519

アクションメソッドで、Json(object)を返し、JSONをページに返します。

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

次に、Ajaxを使用してアクションメソッドを呼び出します。次のようなViewPageのヘルパーメソッドの1つを使用できます。

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

SomeMethodは、返されたJsonオブジェクトを評価するJavaScriptメソッドになります。

プレーンな文字列を返したい場合は、単にContentResultを使用できます。

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

ContentResultはデフォルトで、text / plainをcontentTypeとして返します。
これはオーバーロード可能であるため、次のこともできます。

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

9
ごめん、フィル!これは実際には質問に答えませんか?間違いなく便利ですが、ブラッドが言うように、彼らが何を求めているのかを何らかの方法で見つけ、それに応じて結果を返す必要があります。
Simon_Weaver 2009年


9
答えを見つけたら、質問自体にリンクしてください。また、答えが正しいので、これをチェックするとは思いません。
Cherian


そのJsonクラスの完全修飾名は何ですか?
ジョシュウィジー

112

リクエストのAcceptTypesを考慮する必要があると思います。現在のプロジェクトでそれを使用して、次のように正しいコンテンツタイプを返しています。

コントローラーでのアクションは、リクエストオブジェクトと同様にテストできます。

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

次に、ビューのaspxを実装して、部分的なxhtml応答のケースに対応できます。

次に、jQueryで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

これがジェームズに役立つことを願っています


5
Jamesさん、ありがとうございます。同じコントローラアクションを使用してWebサイトやREST APIを作成するのに非常に役立ちます。
NathanD 2009年

コントローラにこのような多くのメソッドがある場合、これをより一般的に行う方法はありますか?
SEPH

Jsonクラスはどの名前空間にありますか?project.jsonの依存関係は何ですか?よろしくお願いします
Andrei

1
これは、System.Web.Mvc(System.Web.Mvc.dll内)のJsonResultクラスです @Andrei
James Green

ありがとう、見つけた。新しいAPIを反映するように回答を更新しますか?ところで、私はMicrosoft.AspNetCore.Mvc.JsonResultであるdotnetコアを使用しています。
Andrei

78

JSONデータを処理するもう1つの良い方法は、JQuery getJSON関数を使用することです。あなたは呼び出すことができます

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

単にjquery getJSONメソッドからのメソッド...

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

15
これは質問にまったく答えません。
アーロンノート、2011

2
@Aaronaught実際、最初の部分return Json(new {foo="bar", baz="Blech"});はそうです!
SparK 2016年

また、$ .post考える stackoverflow.com/questions/751218/... (無効JSONにASP.Net MVCのデフォルトは、セキュリティ上の理由から要求を取得)
グレッグ・

50

JQueryでMVC ajax GET呼び出しを実装する際にいくつかの問題が見つかりました。そのため、頭痛の種となったため、ここでソリューションを共有しました。

  1. 必ずajax呼び出しにデータ型「json」を含めてください。これにより、返されたJSONオブジェクトが自動的に解析されます(サーバーが有効なjsonを返す場合)。
  2. 含める JsonRequestBehavior.AllowGet ; このMVCがないと、(dataType: jsonクライアントで指定された)HTTP 500エラーが返されました。
  3. 追加 cache: false$ .ajax呼び出しにします。しない場合、最終的に(HTTP 200応答ではなく)HTTP 304応答が取得され、サーバーは要求を処理しません。
  4. 最後に、jsonは大文字と小文字を区別するため、要素の大文字と小文字はサーバー側とクライアント側で一致する必要があります。

サンプル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);
  }
});

サンプル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);
}

13

質問の残りの半分に答えるには、次の番号に電話してください。

return PartialView("viewname");

部分的なHTMLを返したい場合。URLの部分/パラメータに基づいて、リクエストがJSONとHTMLのどちらを必要とするかを決定する方法を見つける必要があるだけです。


2
質問は未回答のままではありませんか?
Simon_Weaver 2009年

2
これは質問の答えにはなりません。
アーロンノート、2011

彼は、PartialViewを使用してHTMLを取得するためのAjaxリクエストを探しています。Ajax呼び出しを使用してアクションメソッドからビューを返さない限り、ページの更新が必要です
Chris McGrath

7

コーディングフレームワーク使用した代替ソリューション

アクションリターンjson

コントローラ

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

かみそりのページ

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

アクションがHTMLを返す

コントローラ

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

かみそりのページ

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


4

PartialViewResultおよびJSONReusltは、基本クラスActionResultを継承します。そのため、戻り値の型が動的に決定される場合は、メソッドの出力をActionResultとして宣言します。

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


        }


2
    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);
            }
        }

これが何をするかについてもう少し情報を追加できますか?
RealCheeseLord 2017

コードはそれがJSONを返すことを示しているため、戻り値の型はActionResultではなくJsonResultである必要があります
noobprogrammer

0

要求に基づいて異なる出力を生成するための柔軟なアプローチ

public class AuctionsController : Controller
{
  public ActionResult Auction(long id)
  {
    var db = new DataContext();
    var auction = db.Auctions.Find(id);

    // Respond to AJAX requests
    if (Request.IsAjaxRequest())
      return PartialView("Auction", auction);

    // Respond to JSON requests
    if (Request.IsJsonRequest())
      return Json(auction);

    // Default to a "normal" view with layout
    return View("Auction", auction);
  }
}

このRequest.IsAjaxRequest()方法は非常に簡単です。受信リクエストのHTTPヘッダーをチェックして、X-Requested-Withヘッダーの値がであるかどうかを確認するだけですXMLHttpRequest。これは、ほとんどのブラウザーとAJAXフレームワークによって自動的に追加されます。

Request.IsAjaxRequest()拡張メソッドのように、どこからでも呼び出すことができるように、リクエストがjson用かどうかをチェックするカスタム拡張メソッド:

using System;
using System.Web;

public static class JsonRequestExtensions
{
  public static bool IsJsonRequest(this HttpRequestBase request)
  {
    return string.Equals(request["format"], "json");
  }
}

ソース:https : //www.safaribooksonline.com/library/view/programming-aspnet-mvc/9781449321932/ch06.html#_javascript_rendering

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.