天天看点

关于asp.net mvc中Controller中的方法返回值类型ActionResult及其子类的理解

理解ASP.NET MVC中的ActionResult

通常我们在一个ASP.NET MVC项目中创建一个Controller的时候,Index()方法默认的返回类型都是ActionResult,通过查看UML图,ActionResult实际上是一个抽象类,因此实际返回的类型是该抽象类的子类。

有关ActionResult及其子类的UML图如下所示:

关于asp.net mvc中Controller中的方法返回值类型ActionResult及其子类的理解

由于图片比较大,所以在浏览器中看起来可能比较小,也不太方便,大家可以点击这里下载大图,使用专业的图片浏览器打开看。

下载大图 

ActionResult及其子类的对照表:

ActionResult的子类名称 说明
ViewResult 表示HTML的页面内容
EmptyResult 表示空白的页面内容
RedirectResult 表示定位到另一个URL
JsonResult 表示可以运用到AJAX程序中的JSON结果
JavaScriptResult 表示一个JavaScript对象
ContentResult 表示一个文本内容
FileContentResult 表示一个可以下载的、二进制内容的文件
FilePathResult 表示一个可以下载的、指定路径的文件
FileStreamResult 表示一个可以下载的、流式的文件

通过我们在代码中编写,不难看到如下一段代码:

public ActionResult Index()
{
    return View();
}
           

可能有人会有疑问,既然我定义的是ActionResult,为什么返回值会是View呢?

其实这个View的类型是ActionResult的子类ViewResult,有关Controller中的方法与返回对象请参照下表:

Controller中的方法 返回对象
View ViewResult
Redirect RedirctResult
RedirectToAction RedirectToActionResult
RedirectToRoute RedirectToRouteResult
Json JosnResult
JavaScripeResult JavaScriptResult
Content ContentResult
File FileContentResult、FilePathResult、FileStreamResult

以上参考出处:

微软北京.NET俱乐部13号群:249636398 

作者:深山老林

出处:http://wlb.cnblogs.com/ 

在mvc中所有的controller类都必须使用"Controller"后缀来命名

并且对Action也有一定的要求:

  • 必须是一个public方法
  • 必须是实例方法
  • 没有标志NonActionAttribute特性的(NoAction)
  • 不能被重载
  • 必须返回ActionResult类型
如:

使用ASP.NET MVC中的ActionResult

public class MyController : Controller  
{  
   // 必须返回ActionResult类型  
    public ActionResult HelloWorld()  
    {  
        ViewData["Message"] = "Hello World!";  
        return View();  
    }  
}  
           

下面列举Asp.net MVC中Controller中的ActionResult返回类型

1、返回ViewResult视图结果,将视图呈现给网页

public ActionResult About()  
 {  
    return View(); // 参数可以返回model对象  
 }  
           

2、 返回PartialViewResult部分视图结果,主要用于返回部分视图内容

在View/Shared目录下创建ViewUserControl.cshtml部分视图

public ActionResult UserControl()  
 {  
     ViewBag.Message = "部分视图";  
     return PartialView("ViewUserControl");  
 }  
           

    页面调用@ViewBag.Message 将输出“部分视图”

3、 返回ContentResult用户定义的内容类型 

public ActionResult Content()  
{  
   return Content("Test Content", "text/html"); // 可以指定文本类型  
}
           

 页面输出“Test Content”;

此类型多用于在ajax操作中需要返回的文本内容

4、 返回JsonResult序列化的Json对象

public ActionResult Json()  
 {  
     Dictionary<string, object> dic = new Dictionary<string, object>();  
     dic.Add("id", 100);  
     dic.Add("name", "hello");  
     return Json(dic, JsonRequestBehavior.AllowGet);  
 }  
           

主要用于返回json格式对象,可以用ajax操作;

注意:需要设置参数,JsonRequestBehavior.AllowGet,

否则会提示错误:此请求已被阻止,因为当用在 GET 请求中时,会将敏感信息透漏给第三方网站。

若要允许 GET 请求,请将 JsonRequestBehavior 设置为 AllowGet。

5、返回JavaScriptResult可在客户端执行的脚本

public ActionResult JavaScript()  
{  
    string str = string.Format("alter('{0}');", "弹出窗口");  
    return JavaScript(str);  
}  
           

但这里并不会直接响应弹出窗口,需要用页面进行再一次调用。

这个可以方便根据不同逻辑执行不同的js操作

6、返回FileResult要写入响应中的二进制输出,一般可以用作要简单下载的功能

public ActionResult File()  
 {  
     string fileName = "~/Content/test.zip"; // 文件名  
     string downFileName = "文件显示名称.zip"; // 要在下载框显示的文件名  
     return File(fileName, "application/octet-stream", downFileName);  
 }  
           

直接下载test.zip后保存到本地则为"文件显示名称.zip"

7、 返回Null或者Void数据类型的EmptyResult 

public ActionResult Empty()  
 {  
     return null;  
 } 
           

返回NULL

8、重定向方法:Redirect / RedirectToAction / RedirectToRoute

    Redirect:直接转到指定的url地址

public ActionResult Redirect()  
       {  
           // 直接返回指定的url地址  
           return Redirect("http://www.baidu.com");  
       } 
           

RedirectToAction:直接使用 Action Name 进行跳转,也可以加上ControllerName

public ActionResult RedirectResult()  
{  
    return RedirectToAction("Index", "Home", new { id = "100", name = "liu" });  
}  
           

也可以带上参数

RedirectToRoute:指定路由进行跳转

public ActionResult RedirectRouteResult()  
{  
    return RedirectToRoute("Default", new { controller = "Home", action = "Index"});  
}  
           

Default为global.asax.cs中定义的路由名称

以上参考出处: 链接