1. 程式人生 > >ASP.NET MVC中幾種常用ActionResult

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種)的簡單應用

using MvcApp.Filter;
using System;
using System.IO;
using System.Web.Mvc;

namespace MvcApp.Controllers
{
    public class HomeController : Controller
    {
        /// <summary>
        /// ContentResult用法(返回文字)
        /// http://localhost:11853/home/ContentResultDemo
        /// </summary>
        /// <returns>返回文字</returns>
        public ActionResult ContentResultDemo()
        {
            string str = "ContentResultDemo!";
            return Content(str);
        }

        /// <summary>
        /// EmptyResult的用法(返回空物件)
        /// http://localhost:11853/home/EmptyResultDemo
        /// </summary>
        /// <returns>返回一個空物件</returns>
        public ActionResult EmptyResultDemo()
        {
            return new EmptyResult();
        }

        /// <summary>
        /// FileContentResult的用法(返回圖片)
        /// http://localhost:11853/home/FileContentResultDemo
        /// </summary>
        /// <returns>顯示一個檔案內容</returns>
        public ActionResult FileContentResultDemo()
        {
            FileStream fs = new FileStream(Server.MapPath(@"/Images/001.jpg"), FileMode.Open, FileAccess.Read);
            byte[] buffer = new byte[Convert.ToInt32(fs.Length)];
            fs.Read(buffer, 0, Convert.ToInt32(fs.Length));
            string contentType = "image/jpeg";
            return File(buffer, contentType);
        }

        /// <summary>
        /// FilePathResult的用法(返回圖片)
        /// http://localhost:11853/home/FilePathResultDemo/002
        /// </summary>
        /// <param name="id">圖片id</param>
        /// <returns>直接將返回一個檔案物件</returns>
        public FilePathResult FilePathResultDemo(string id)
        {
            string path = Server.MapPath(@"/Images/" + id + ".jpg");
            //定義內容型別(圖片)
            string contentType = "image/jpeg";
            //FilePathResult直接返回file物件
            return File(path, contentType);
        }

        /// <summary>
        /// FileStreamResult的用法(返回圖片)
        /// http://localhost:11853/home/FileStreamResultDemo
        /// </summary>
        /// <returns>返回檔案流(圖片)</returns>
        public ActionResult FileStreamResultDemo()
        {
            FileStream fs = new FileStream(Server.MapPath(@"/Images/001.jpg"), FileMode.Open, FileAccess.Read);
            string contentType = "image/jpeg";
            return File(fs, contentType);
        }

        /// <summary>
        /// HttpUnauthorizedResult 的用法(丟擲401錯誤)
        /// http://localhost:11853/home/HttpUnauthorizedResult
        /// </summary>
        /// <returns></returns>
        public ActionResult HttpUnauthorizedResultDemo()
        {
            return new HttpUnauthorizedResult();
        }

        /// <summary>
        /// HttpStatusCodeResult的方法(返回錯誤狀態資訊)
        ///  http://localhost:11853/home/HttpStatusCodeResult
        /// </summary>
        /// <returns></returns>
        public ActionResult HttpStatusCodeResultDemo()
        {
            return new HttpStatusCodeResult(500, "System Error");
        }

        /// <summary>
        /// HttpNotFoundResult的使用方法
        /// http://localhost:11853/home/HttpNotFoundResultDemo
        /// </summary>
        /// <returns></returns>
        public ActionResult HttpNotFoundResultDemo()
        {
            return new HttpNotFoundResult("not found action");
        }

        /// <summary>
        /// JavaScriptResult 的用法(返回指令碼檔案)
        /// http://localhost:11853/home/JavaScriptResultDemo
        /// </summary>
        /// <returns>返回指令碼內容</returns>
        public ActionResult JavaScriptResultDemo()
        {
            //return Content("<script>alert('Test JavaScriptResultDemo!')</script>");
            return JavaScript(@"<script>alert('Test JavaScriptResultDemo!')</script>");
        }

        /// <summary>
        /// JsonResult的用法(返回一個json物件)
        /// http://localhost:11853/home/JsonResultDemo
        /// </summary>
        /// <returns>返回一個json物件</returns>
        public ActionResult JsonResultDemo()
        {
            var tempObj = new { Controller = "HomeController", Action = "JsonResultDemo" };
            return Json(tempObj,JsonRequestBehavior.AllowGet);
        }

        /// <summary>
        /// RedirectResult的用法(跳轉url地址)
        /// http://localhost:11853/home/RedirectResultDemo
        /// </summary>
        /// <returns></returns>
        public ActionResult RedirectResultDemo()
        {
            return Redirect(@"http://wwww.baidu.com");
        }

        /// <summary>
        /// RedirectToRouteResult的用法(跳轉的action名稱)
        /// http://localhost:11853/home/RedirectToRouteResultDemo
        /// </summary>
        /// <returns></returns>
        public ActionResult RedirectToRouteResultDemo()
        {
            return RedirectToAction(@"FileStreamResultDemo");
        }

        /// <summary>
        /// PartialViewResult的用法(返回部分檢視)
        /// http://localhost:11853/home/PartialViewResultDemo
        /// </summary>
        /// <returns></returns>
        public PartialViewResult PartialViewResultDemo()
        {
            return PartialView();
        }

        /// <summary>
        /// ViewResult的用法(返回檢視)
        ///  http://localhost:11853/home/ViewResultDemo
        /// </summary>
        /// <returns></returns>
        public ActionResult ViewResultDemo()
        {
            //如果沒有傳入View名稱, 預設尋找與Action名稱相同的View頁面.
            return View();
        }
    }
}

原文地址:https://www.cnblogs.com/xielong/p/5940535.html