ASP.NET MVC中常用的ActionResult类型
一、定义
MVC中ActionResult是Action的返回结果。ActionResult 有多个派生类,每个子类功能均不同,并不是所有的子类都需要返回视图View,有些直接返回流,有些返回字符串等。ActionResult是一个抽象类,它定义了唯一的ExecuteResult方法,参数为一个ControllerContext,下面为您介绍MVC中的ActionResult 的用法。
二、什么是ActionResult
ActionResult是控制器方法执行后返回的结果类型,控制器方法可以返回一个直接或间接从ActionResult抽象类继承的类型,如果返回的 是非ActionResult类型,控制器将会将结果转换为一个ContentResult类型。默认的ControllerActionInvoker 调用ActionResult.ExecuteResult方法生成应答结果。
三、常见的ActionResult
1、ViewResult
表示一个视图结果,它根据视图模板产生应答内容。对应得Controller方法为View。
2、PartialViewResult
表示一个部分视图结果,与ViewResult本质上一致,只是部分视图不支持母版,对应于ASP.NET,ViewResult相当于一个Page,而PartialViewResult 则相当于一个UserControl。它对应得Controller方法的PartialView.
3、RedirectResult
表示一个连接跳转,相当于ASP.NET中的Response.Redirect方法,对应得Controller方法为Redirect。
4、RedirectToRouteResult
同样表示一个跳转,MVC会根据我们指定的路由名称或路由信息(RouteValueDictionary)来生成Url地址,然后调用Response.Redirect跳转。对应的Controller方法为RedirectToAction和RedirectToRoute.
5、ContentResult
返回简单的纯文本内容,可通过ContentType属性指定应答文档类型,通过ContentEncoding属性指定应答文档的字符编码。可通过Controller类中的Content方法便捷地返回ContentResult对象。如果控制器方法返回非ActionResult对象,MVc将简单地以返回对象的toString()内容为基础产生一个ContentResult对象。
6、EmptyResult
返回一个空的结果,如果控制器方法返回一个null ,MVC将其转换成EmptyResult对象。
7、JavaScriptResult
本质上是一个文本内容,只是将Response.ContentType设置为application/x-javascript,此结果应该和MicrosoftMvcAjax.js脚本配合使用,客户端接收到Ajax应答后,将判断Response.ContentType的值,如果是application/x-javascript,则直接eval 执行返回的应答内容,此结果类型对应得Controller方法为JavaScript.
8、JsonResult
表示一个Json结果。MVC将Response.ContentType 设置为application/json,并通过JavaScriptSerializer类指定对象序列化为Json表示方式。需要注意,默认情况下,Mvc不允许GET请求返回Json结果,要解除此限制,在生成JsonResult对象时,将其JsonRequestBehavior属性设置为JsonRequestBehavior.AllowGet,此结果对应Controller方法的Json.
9、FileResult(FilePathResult、FileContentResult、FileStreamResult)
这三个类继承于FileResult,表示一个文件内容,三者区别在于,FilePath 通过路径传送文件到客户端,FileContent 通过二进制数据的方式,而FileStream 是通过Stream(流)的方式来传送。Controller为这三个文件结果类型提供了一个名为File的重载方法。
FilePathResult: 直接将一个文件发送给客户端
FileContentResult: 返回byte字节给客户端(比如图片)
FileStreamResult: 返回流
10、HttpUnauthorizedResult
表示一个未经授权访问的错误,MVC会向客户端发送一个401的应答状态。如果在web.config 中开启了表单验证(authenication mode=”Forms”),则401状态会将Url 转向指定的loginUrl 链接。
11、HttpStatusCodeResult
返回一个服务器的错误信息
12、HttpNoFoundResult
返回一个找不到Action错误信息
四、ActionResult子类之间的关系表
五、ActionResult(12种)的简单应用
源码:
1 using StudyMVC4.Models;
2 using System;
3 using System.Collections.Generic;
4 using System.IO;
5 using System.Linq;
6 using System.Net;
7 using System.Net.Http;
8 using System.Web.Http;
9 using System.Web.Mvc;
10
11 namespace StudyMVC4.Controllers
12 {
13 public class HomeController : Controller
14 {
15
16 public ActionResult Index() {
17 return View();
18 }
19
20 /// <summary>
21 /// ContentResult用法(返回文本)
22 /// http://localhost:30735/home/ContentResultDemo
23 /// </summary>
24 /// <returns>返回文本</returns>
25 public ActionResult ContentResultDemo(){
26 string str = "ContentResultDemo!";
27 return Content(str);
28 }
29
30 /// <summary>
31 /// EmptyResult的用法(返回空对象)
32 /// http://localhost:30735/home/EmptyResultDemo
33 /// </summary>
34 /// <returns>返回一个空对象</returns>
35 public ActionResult EmptyResultDemo (){
36 return new EmptyResult();
37 }
38
39 /// <summary>
40 /// FileContentResult的用法(返回图片)
41 /// http://localhost:30735/home/FileContentResultDemo
42 /// </summary>
43 /// <returns>显示一个文件内容</returns>
44 public ActionResult FileContentResultDemo() {
45 FileStream fs = new FileStream(Server.MapPath(@"/Images/001.jpg"), FileMode.Open, FileAccess.Read);
46 byte[] buffer = new byte[Convert.ToInt32(fs.Length)];
47 fs.Read(buffer, 0, Convert.ToInt32(fs.Length));
48 string contentType = "image/jpeg";
49 return File(buffer, contentType);
50 }
51
52 /// <summary>
53 /// FilePathResult的用法(返回图片)
54 /// http://localhost:30735/home/FilePathResultDemo/002
55 /// </summary>
56 /// <param name="id">图片id</param>
57 /// <returns>直接将返回一个文件对象</returns>
58 public FilePathResult FilePathResultDemo(string id)
59 {
60 string path = Server.MapPath(@"/Images/"+id +".jpg");
61 //定义内容类型(图片)
62 string contentType = "image/jpeg";
63 //FilePathResult直接返回file对象
64 return File(path, contentType);
65 }
66
67 /// <summary>
68 /// FileStreamResult的用法(返回图片)
69 /// http://localhost:30735/home/FileStreamResultDemo
70 /// </summary>
71 /// <returns>返回文件流(图片)</returns>
72 public ActionResult FileStreamResultDemo()
73 {
74 FileStream fs = new FileStream(Server.MapPath(@"/Images/001.jpg"), FileMode.Open, FileAccess.Read);
75 string contentType = "image/jpeg";
76 return File(fs, contentType);
77 }
78
79 /// <summary>
80 /// HttpUnauthorizedResult 的用法(抛出401错误)
81 /// http://localhost:30735/home/HttpUnauthorizedResult
82 /// </summary>
83 /// <returns></returns>
84 public ActionResult HttpUnauthorizedResultDemo()
85 {
86 return new HttpUnauthorizedResult();
87 }
88
89 /// <summary>
90 /// HttpStatusCodeResult的方法(返回错误状态信息)
91 /// http://localhost:30735/home/HttpStatusCodeResult
92 /// </summary>
93 /// <returns></returns>
94 public ActionResult HttpStatusCodeResultDemo() {
95 return new HttpStatusCodeResult(500, "System Error");
96 }
97
98 /// <summary>
99 /// HttpNotFoundResult的使用方法
100 /// http://localhost:30735/home/HttpNotFoundResultDemo
101 /// </summary>
102 /// <returns></returns>
103 public ActionResult HttpNotFoundResultDemo() {
104 return new HttpNotFoundResult("not found action");
105 }
106
107 /// <summary>
108 /// JavaScriptResult 的用法(返回脚本文件)
109 /// http://localhost:30735/home/JavaScriptResultDemo
110 /// </summary>
111 /// <returns>返回脚本内容</returns>
112 public ActionResult JavaScriptResultDemo()
113 {
114 return JavaScript(@"<script>alert('Test JavaScriptResultDemo!')</script>");
115 }
116
117 /// <summary>
118 /// JsonResult的用法(返回一个json对象)
119 /// http://localhost:30735/home/JsonResultDemo
120 /// </summary>
121 /// <returns>返回一个json对象</returns>
122 public ActionResult JsonResultDemo()
123 {
124 var tempObj = new { Controller = "HomeController", Action = "JsonResultDemo" };
125 return Json(tempObj);
126 }
127
128 /// <summary>
129 /// RedirectResult的用法(跳转url地址)
130 /// http://localhost:30735/home/RedirectResultDemo
131 /// </summary>
132 /// <returns></returns>
133 public ActionResult RedirectResultDemo()
134 {
135 return Redirect(@"http://wwww.baidu.com");
136 }
137
138 /// <summary>
139 /// RedirectToRouteResult的用法(跳转的action名称)
140 /// http://localhost:30735/home/RedirectToRouteResultDemo
141 /// </summary>
142 /// <returns></returns>
143 public ActionResult RedirectToRouteResultDemo()
144 {
145 return RedirectToAction(@"FileStreamResultDemo");
146 }
147
148 /// <summary>
149 /// PartialViewResult的用法(返回部分视图)
150 /// http://localhost:30735/home/PartialViewResultDemo
151 /// </summary>
152 /// <returns></returns>
153 public PartialViewResult PartialViewResultDemo()
154 {
155 return PartialView();
156 }
157
158 /// <summary>
159 /// ViewResult的用法(返回视图)
160 /// http://localhost:30735/home/ViewResultDemo
161 /// </summary>
162 /// <returns></returns>
163 public ActionResult ViewResultDemo()
164 {
165 //如果没有传入View名称, 默认寻找与Action名称相同的View页面.
166 return View();
167 }
168 }
169 }
推荐阅读
-
ASP.NET MVC中的Global.asax文件
-
ASP.NET MVC中的Global.asax文件
-
浅谈ASP.NET中MVC 4 的JS/CSS打包压缩功能
-
ASP.NET MVC中图表控件的使用方法
-
ASP.NET中MVC传递数据的几种形式总结
-
ASP.NET MVC中图表控件的使用方法
-
解决Asp.net Mvc返回JsonResult中DateTime类型数据格式问题的方法
-
解读ASP.NET 5 & MVC6系列教程(12):基于Lamda表达式的强类型Routing实现
-
解读ASP.NET 5 & MVC6系列教程(17):MVC中的其他新特性
-
解决Asp.net Mvc返回JsonResult中DateTime类型数据格式问题的方法