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

363

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

Теги:
asp.net-mvc
asp.net-ajax

10 ответов

408
Лучший ответ

В вашем методе действий верните Json (object), чтобы вернуть 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 по умолчанию возвращает текст /plain как свой contentType.
Это перегружает, поэтому вы также можете:

return Content("<xml>This is poorly formatted xml.</xml>", "text/xml");
  • 5
    извини фил! это на самом деле не отвечает на вопрос, не так ли? Это определенно полезно, но, как говорит Брэд, вам нужно как-то выяснить, о чем они просят, и соответственно вернуть результат.
  • 0
    см. мой несколько связанный (хорошо тот, который привел меня сюда) вопрос на stackoverflow.com/questions/482363/…
Показать ещё 3 комментария
106

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

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

  • 3
    Спасибо Джеймс, это может быть очень полезно для создания своего рода веб-сайта и REST API, используя те же действия контроллера.
  • 0
    Если у меня в контроллере много таких методов, есть ли способ сделать это более обобщенно?
Показать ещё 3 комментария
68

Другим приятным способом обработки данных JSON является использование функции JJuery 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);
    }
);
  • 14
    Это не отвечает на вопрос вообще.
  • 2
    @Aaronaught На самом деле первая часть return Json(new {foo="bar", baz="Blech"}); делает!
Показать ещё 1 комментарий
39

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

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

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

return PartialView("viewname");

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

  • 2
    так не остается ли вопрос без ответа?
  • 2
    Это не отвечает на вопрос.
Показать ещё 1 комментарий
5

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

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

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

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

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

4

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

  • 1
    Вы также можете использовать ту же технику, что и эта статья в MVC 2
1
    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);
            }
        }
  • 0
    Не могли бы вы добавить немного больше информации о том, что это делает?
1

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;


        }

Ещё вопросы

Сообщество Overcoder
Наверх
Меню