Действия контроллера ASP.NET MVC, которые возвращают JSON или частичный HTML

Я пытаюсь создать действия контроллера, которые будут возвращать либо JSON, либо частичный HTML в зависимости от параметра. Каков наилучший способ получить результат, возвращаемый на страницу MVC асинхронно?

В вашем методе действия верните Json (объект), чтобы вернуть JSON на вашу страницу.

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

Затем просто вызовите метод действия, используя Ajax. Вы можете использовать один из вспомогательных методов из ViewPage, таких как

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

SomeMethod будет методом javascript, который затем оценивает возвращаемый объект Json.

Если вы хотите вернуть простую строку, вы можете просто использовать ContentResult:

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

ContentResult по умолчанию возвращает text / plain как его contentType.
Это перегружается, поэтому вы также можете сделать:

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

Я думаю, что вы должны рассмотреть 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 вы можете получить его, передав параметр типа как 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

Надеюсь, это поможет Джеймсу

Другим хорошим способом работы с данными JSON является использование функции getQSON JQuery. Вы можете позвонить

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

Я обнаружил пару проблем, связанных с реализацией вызовов GET MVC ajax с помощью JQuery, которые вызвали у меня головную боль, поэтому я делился здесь решениями.

1. Убедитесь, что вы включили тип данных "json" в вызов ajax. Это автоматически проанализирует возвращенный объект JSON для вас (если сервер возвращает действительный json).
2. Включить JsonRequestBehavior.AllowGet; без этого MVC возвращал ошибку HTTP 500 (сdataType: json указанным на клиенте).
3. Добавить cache: false к вызову $ .ajax, в противном случае вы получите ответы HTTP 304 (вместо ответов HTTP 200), и сервер не обработает ваш запрос.
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);
}

Чтобы ответить на другую половину вопроса, вы можете позвонить:

return PartialView("viewname");

когда вы хотите вернуть частичный HTML. Вам просто нужно будет найти способ решить, хочет ли запрос JSON или HTML, возможно, основываясь на части / параметре URL.

Альтернативное решение со структурой кодирования

Действие вернуть 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())

Действие return 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())

Возможно, вы захотите взглянуть на эту очень полезную статью, которая освещает это очень красиво!

Просто подумал, что это может помочь людям, которые ищут хорошее решение этой проблемы.

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

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;


        }

Для тех, кто перешел на MVC 3, есть удобный способ использования MVC3 и Json.

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

Гибкий подход для получения различных результатов на основе запроса

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 заголовки для входящего запроса , чтобы увидеть , если значение Х-Requested-With заголовкаXMLHttpRequest , который автоматически добавляется большинством браузеров и AJAX-сред.

Пользовательский метод расширения, чтобы проверить, является ли запрос для json или нет, чтобы мы могли вызывать его из любого места, точно так же, как метод расширения Request.IsAjaxRequest ():

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