Question

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

Answer 1

在你的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返回text / plain作为其contentType 这是可以超载的，所以你也可以这样做：

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

Answer 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

希望这会有所帮助詹姆斯

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

Answer 4

我发现使用JQuery实现MVC ajax GET调用时遇到了一些问题，这让我头疼，所以在这里共享解决方案。

确保在ajax调用中包含数据类型“json”。这将自动为您解析返回的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);
}

Answer 5

要回答问题的另一半，您可以致电：

return PartialView("viewname");

当您想要返回部分HTML时。您只需要找到一些方法来决定请求是否需要JSON或HTML，可能是基于URL部分/参数。

Answer 6

使用incoding framework

的替代解决方案

动作返回json

<强>控制器

    [HttpGet]
    public ActionResult SomeActionMethod()
    {
        return IncJson(new SomeVm(){Id = 1,Name ="Inc"});
    }

Razor页面

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

Razor页面

@(Html.When(JqueryBind.InitIncoding)
  .Do()
  .AjaxGet(Url.Action("SomeActionMethod","SomeContoller"))
  .OnSuccess(dsl => dsl.Self().Core().Insert.Html())
  .AsHtmlAttributes()
  .ToDiv())

Answer 7

你可能想看一下非常有用的这篇非常有用的文章！

以为它可能会帮助人们寻找解决这个问题的好方法。

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

Answer 8

对于已经升级到MVC 3的人来说这是一个很好的方式 Using MVC3 and Json

Answer 9

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;


        }

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

Answer 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控制器操作

11 个答案: