ASP。NET MVC控制器操作,返回JSON或部分html

我试图创建控制器动作,根据参数返回JSON或部分html。异步将结果返回到MVC页面的最佳方法是什么?

649956 次浏览

在action方法中,返回Json(object)将Json返回到页面。

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

然后使用Ajax调用action方法。您可以使用ViewPage中的一个辅助方法,例如

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

SomeMethod将是一个javascript方法,然后计算返回的Json对象。

如果你想返回一个普通的字符串,你可以使用ContentResult:

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

ContentResult默认返回一个文本/纯文本作为它的内容类型 这是可重载的,所以你也可以这样做:

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

另一种处理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);
}
);

要回答问题的另一半,你可以拨打:

return PartialView("viewname");

当你想返回部分HTML时。您只需要找到某种方法来决定请求是想要JSON还是HTML,可能是基于URL部分/参数。

我认为您应该考虑请求的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
希望这对你有帮助 詹姆斯。< / p >

你可能想看看这篇非常有用的文章,它很好地介绍了这一点!

只是觉得它可能会帮助人们找到解决这个问题的好办法。

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

对于已经升级到MVC 3的人来说,这是一个很好的方法 使用MVC3和Json < / p >

驿码框架的替代解决方案

操作返回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())

我发现用JQuery实现MVC ajax GET调用的几个问题,这让我头疼,所以在这里分享解决方案。

  1. 确保在ajax调用中包含数据类型“json”。这将自动为您解析返回的JSON对象(假设服务器返回有效的JSON)。
  2. 包括JsonRequestBehavior.AllowGet;没有这个MVC返回一个HTTP 500错误(在客户端指定dataType: json)。
  3. cache: false添加到$。否则你最终会得到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);
}

PartialViewResult和jsonresult继承自基类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,以便我们可以从任何地方调用它,就像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