ASP.NET действия контроллера MVC, возвращающие JSON или частичный html
Я пытаюсь создать действия контроллера, которые вернут либо JSON, либо частичный html в зависимости от параметра. Каков наилучший способ асинхронного возврата результата на страницу MVC?
11 ответов
в вашем методе действия верните 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 по умолчанию возвращает текст/равнина как его 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
надеюсь, это поможет Джеймс!--3-->
еще один хороший способ справиться с данными JSON-использовать функцию 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);
}
);
я нашел пару проблем, реализующих MVC ajax GET calls с 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);
}
чтобы ответить на вторую половину вопроса, Вы можете позвонить:
return PartialView("viewname");
когда вы хотите вернуть частичный HTML. Вам просто нужно найти способ решить, хочет ли запрос JSON или HTML, возможно, на основе части/параметра URL.
альтернативное решение с Incoding framework
действие возврата 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())
вы можете взглянуть на эту очень полезную статью, которая охватывает это очень красиво!
просто подумал, что это может помочь людям найти хорошее решение этой проблемы.
http://weblogs.asp.net/rashid/archive/2009/04/15/adaptive-rendering-in-asp-net-mvc.aspx
для людей, которые обновились до MVC 3, вот аккуратный способ использование MVC3 и Json
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;
}
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 для входящего запроса, чтобы увидеть, является ли значение заголовка X-Requested-With XMLHttpRequest
, который автоматически добавляется большинством браузеров и фреймворков AJAX.
пользовательский метод расширения, чтобы проверить, является ли запрос для json или нет, чтобы мы могли вызвать его из любого места, как и Запрос.IsAjaxRequest() метод расширения:
using System;
using System.Web;
public static class JsonRequestExtensions
{
public static bool IsJsonRequest(this HttpRequestBase request)
{
return string.Equals(request["format"], "json");
}
}