返回JSON或部分html的ASP.NET MVC控制器操作


406

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

Answers:


519

在您的操作方法中,返回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返回一个文本/纯文本作为其contentType。
这是可重载的,因此您还可以执行以下操作:

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

9
抱歉,菲尔!这实际上没有回答问题吗?它绝对有用,但正如brad所说,您需要以某种方式找出他们的要求,并相应地返回结果。
Simon_Weaver


9
如果找到答案,则将其链接到问题本身。我也不认为检查这个答案是对的。
Cherian


该Json类的完全限定名称是什么?
Josh Withee '18

112

我认为您应该考虑请求的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中,您可以通过将type参数作为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

希望这对詹姆斯有帮助


5
谢谢James,这对于使用相同的Controller Actions创建网站和REST API可能非常有用。
NathanD

如果我的控制器中有很多这样的方法,有什么办法可以使我更通用吗?
Seph 2012年

Json类在哪个名称空间中?project.json的依赖项是什么?在此先感谢
Andrei

1
这就是System.Web.Mvc中JsonResult类(在System.Web.Mvc.dll中)@Andrei
詹姆斯·格林

谢谢,找到了。也许更新答案以反映新的API?顺便说一句,我正在使用dotnet核心,它是Microsoft.AspNetCore.Mvc.JsonResult。
Andrei

78

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

15
这根本无法回答问题。
亚伦诺特2011年

2
@Aaronaught其实第一部分return Json(new {foo="bar", baz="Blech"});是!
SparK

也可以考虑$。员额 stackoverflow.com/questions/751218/... (ASP.Net MVC默认为禁用JSON获取出于安全原因,请求)
格雷格-

50

我发现用JQuery实施MVC ajax GET调用有两个问题,这些使我头疼,因此请在此处共享解决方案。

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

13

要回答问题的另一半,您可以致电:

return PartialView("viewname");

当您想返回部分HTML时。您只需要找到某种方法即可确定请求是需要JSON还是HTML,也许可以基于URL部件/参数。


2
那么问题是否仍然没有得到解决?
Simon_Weaver

2
这不能回答问题。
Aaronaught 2011年

他正在寻找一个使用PartialView获取html的ajax请求,需要刷新页面,除非您使用ajax调用从操作方法返回视图
Chris McGrath 2012年

7

编码框架的替代解决方案

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


4

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;


        }


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

您能否添加更多有关此功能的信息?
RealCheeseLord

由于您的代码显示返回JSON,因此返回类型应为JsonResult而不是ActionResult
noobprogrammer

0

可以根据要求灵活地产生不同的输出

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

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.