返回 JSON 或部分 html 的 ASP.NET MVC 控制器操作
Posted
技术标签:
【中文标题】返回 JSON 或部分 html 的 ASP.NET MVC 控制器操作【英文标题】：ASP.NET MVC controller actions that return JSON or partial html 【发布时间】：2010-09-18 15:54:50 【问题描述】：我正在尝试创建将根据参数返回 JSON 或部分 html 的控制器操作。将结果异步返回到 MVC 页面的最佳方法是什么？
【问题讨论】：
【参考方案1】：在您的操作方法中，返回 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 默认返回 text/plain 作为其 contentType。 这是可重载的，所以你也可以这样做：
return Content("<xml>This is poorly formatted xml.</xml>", "text/xml");
【讨论】：
对不起菲尔！这实际上并没有回答问题吗？它绝对有用，但正如布拉德所说，您需要以某种方式找出他们要求的内容并相应地返回结果。 在***.com/questions/482363/… 上查看我的一些相关（以及导致我来到这里的那个）问题 如果您找到答案，请将其链接到问题本身。我也不认为检查这个作为答案是正确的。 ***.com/questions/320291/… 相关 那个 Json 类的完全限定名是什么？【参考方案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
希望这会有所帮助 詹姆斯
【讨论】：
感谢 James，这对于使用相同的控制器操作创建某种网站和 REST API 非常有用。 如果我的控制器中有很多这样的方法，有什么方法可以更通用地做到这一点？ Json 类在哪个命名空间中？ project.json 的依赖关系是什么？提前致谢 这是JsonResult class from System.Web.Mvc（在 System.Web.Mvc.dll 中）@Andrei 谢谢，找到了。也许更新答案以反映新的 API？顺便说一句，我正在使用 Microsoft.AspNetCore.Mvc.JsonResult 的 dotnet 核心。【参考方案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);
);
【讨论】：
这根本没有回答问题。 @Aaronaught 实际上第一部分return Json(new foo="bar", baz="Blech"); 确实如此！
还要考虑 $.post ***.com/questions/751218/…（出于安全原因，ASP.Net MVC 默认禁用 JSON Get 请求）【参考方案4】：
我发现了一些使用 JQuery 实现 MVC ajax GET 调用的问题，这让我很头疼，所以在这里分享解决方案。
-
确保在 ajax 调用中包含数据类型“json”。这将自动为您解析返回的 JSON 对象（假设服务器返回有效的 json）。
包括
JsonRequestBehavior.AllowGet；如果没有此 MVC，则会返回 HTTP 500 错误（在客户端上指定了 dataType: json）。
在 $.ajax 调用中添加 cache: false，否则您最终会得到 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);
【讨论】：
【参考方案5】：要回答另一半问题，您可以致电：
return PartialView("viewname");
当您想要返回部分 HTML 时。您只需要找到某种方法来决定请求需要 JSON 还是 HTML，可能基于 URL 部分/参数。
【讨论】：
所以这个问题不是没有答案吗？ 这不能回答问题。 他正在寻找 ajax 请求以使用 PartialView 获取 html 需要刷新页面，除非您使用 ajax 调用从操作方法返回视图【参考方案6】：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())
【讨论】：
【参考方案7】：您可能想看看这篇非常有用的文章，它很好地涵盖了这一点！
只是认为它可能会帮助人们寻找解决此问题的好方法。
http://weblogs.asp.net/rashid/archive/2009/04/15/adaptive-rendering-in-asp-net-mvc.aspx
【讨论】：
【参考方案8】：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;
【讨论】：
【参考方案9】：对于已经升级到 MVC 3 的人来说，这是一个简洁的方法 Using MVC3 and Json
【讨论】：
您也可以在 MVC 2 中使用与本文相同的技术【参考方案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);
【讨论】：
您能否添加更多有关此功能的信息？ 由于您的代码显示它返回 JSON，因此返回类型应该是 JsonResult 而不是 ActionResult【参考方案11】：根据请求产生不同输出的灵活方法
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
【讨论】：
以上是关于返回 JSON 或部分 html 的 ASP.NET MVC 控制器操作的主要内容，如果未能解决你的问题，请参考以下文章
hive 踩坑 get_json_object 返回NULL或部分可解析部分解析不了