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

Question

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

Answer 1

В вашем методе действия верните 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");

Answer 2

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

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

Answer 3

Еще одним хорошим способом работы с данными 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);
    }
);

Answer 4

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

1. Убедитесь, что в вызов ajax включен тип данных "json". Это автоматически проанализирует возвращенный объект 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);
}

Answer 5

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

return PartialView("viewname");

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

Answer 6

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

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

Answer 7

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

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

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

Answer 8

Для людей, которые обновились до MVC 3, есть отличный способ Использование MVC3 и Json

Answer 9

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;


        }

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