ASP.Net MVC 之FileResult

FileResult是一个基于文件的ActionResult，利用FileResult我们可以很容易地将从某个物理文件的内容响应给客户端。ASP.NET MVC定义了三个具体的FileResult，分别是FileContentResult、FilePathResult和FileStreamResult。在这篇文章中我们将探讨三种具体的FileResult是如何将文件内容对请求进行响应的。[本文已经同步到《How ASP.NET MVC Works?》中]

目录 
一、FileResult 
二、FileContentResult 
三、FilePathResult 
四、FileStreamResult 
五、实例演示：通过FileResult发布图片

一、FileResult

如下面的代码片断所示，FileResult具有一个表示媒体类型的只读属性ContentType，该属性在构造函数中被初始化。当我们基于某个物理文件创建相应的FileResult对象的时候应该根据文件的类型指定媒体类型，比如说目标文件是一个.jpg图片，那么对应的媒体类型为“image/jpeg”，对于一个.pdf文件，则采用“application/pdf”。

 public abstract class FileResult : ActionResult
 {    
     protected FileResult(string contentType);
     public override void ExecuteResult(ControllerContext context);
     protected abstract void WriteFile(HttpResponseBase response);
     
     public string ContentType { get; }
     public string FileDownloadName { get; set; }   
 }

针对文件的响应具有两种形式，即内联（Inline）和附件（Attachment）。一般来说，前者会利用浏览器直接打开响应的文件，而后者会以独立的文件下载到客户端。对于后者，我们一般会为下载的文件指定一个文件名，这个文件名可以通过FileResult的FileDownloadName属性来指定。文件响应在默认情况下采用内联的方式，如果需要采用附件的形式，需要为响应创建一个名称为Content-Disposition的报头，该报头值的格式为“attachment; filename={ FileDownloadName }”。

FileResult仅仅是一个抽象类，文件内容的输出实现在抽象方法WriteFile中，该方法会在重写的ExecuteResult方法中调用。如果FileDownloadName属性不为空，意味着会采用附件的形式进行文件响应，FileResult会在重写的ExecuteResult方法中进行Content-Disposition响应报头的设置。如下面的代码片断基本上体现了ExecuteResult方法在FileResult中的实现。

public abstract class FileResult : ActionResult
{
    //其他成员
    public override void ExecuteResult(ControllerContext context)
    {        
        HttpResponseBase response = context.HttpContext.Response;
        response.ContentType = this.ContentType;
        if (!string.IsNullOrEmpty(this.FileDownloadName))
        {
            //生成Content-Disposition响应报头值
            string headerValue = ContentDispositionUtil.GetHeaderValue(this.FileDownloadName);
            context.HttpContext.Response.AddHeader("Content-Disposition", headerValue);
        }
        this.WriteFile(response);
    }
}

 

ASP.NET MVC定义了三个具体的FileResult，分别是FileContentResult、FilePathResult和FileStreamResult，接下来我们对它们进行单独介绍。

二、FileContentResult

FileContentResult是针对文件内容创建的FileResult。如下面的代码片断所示，FileContentResult具有一个字节数组类型的只读属性FileContents表示响应文件的内容，该属性在构造函数中指定。FileContentResult针对文件内容的响应实现也很简单，从如下所示的WriteFile方法定义可以看出，它只是调用当前HttpResponse的OutputStream属性的Write方法直接将表示文件内容的字节数组写入响应输出流。

public class FileContentResult : FileResult
{
    public byte[] FileContents { get; }
    public FileContentResult(byte[] fileContents, string contentType) ；
 
    protected override void WriteFile(HttpResponseBase response)
    {
        response.OutputStream.Write(this.FileContents, 0, this.FileContents.Length);
    }    
}
 
public abstract class Controller : ControllerBase, ...
{
    // 其他成员   
    protected FileContentResult File(byte[] fileContents, string contentType);
    protected virtual FileContentResult File(byte[] fileContents, string contentType, string     fileDownloadName);
}

 

抽象类Controller中定义了如上两个File重载根据指定的字节数组、媒体类型和下载文件名（可选）生成相应的FileContentResult。由于FileContentResult是根据字节数组创建的，当我们需要动态生成响应文件内容（而不是从物理文件中读取）时，FileContentResult是一个不错的选择。

三、FilePathResult

从名称可以看出，FilePathResult是一个根据物理文件路径创建FileResult。如下面的代码片断所示，表示响应文件的路径通过只读属性FileName表示，该属性在构造函数中被初始化。在实现的WriteFile方法中，FilePathResult直接将文件路径作为参数调用当前HttpResponse的TransmitFile实现了针对文件内容的响应。抽象类Controller同样定义了两个File方法重载来根据文件路径创建相应的FilePathResult。

public class FilePathResult : FileResult
{
    public string FileName { get; }
    public FilePathResult(string fileName, string contentType);
 
    protected override void WriteFile(HttpResponseBase response)
    {
        response.TransmitFile(this.FileName);
    }    
}
 
public abstract class Controller : ControllerBase, ...
{
    //其他成员
    protected FilePathResult File(string fileName, string contentType);
    protected virtual FilePathResult File(string fileName, string contentType, string fileDownloadName);
}

四、FileStreamResult

FileStreamResult允许我们通过一个用于读取文件内容的流来创建FileResult。如下面的代码片断所示，读取文件流通过只读属性FileStream表示，该属性在构造函数中被初始化。在实现的WriteFile方法中，FileStreamResult通过指定的文件流读取文件内容，并最终调用当前HttpResponse的OutputStream属性的Write方法将读取的内容写入当前HTTP响应的输出流中。抽象类Controller中同样定义了两个File方法重载根据文件读取流创建相应的FileStreamResult。

public class FileStreamResult : FileResult
{
    public Stream FileStream { get; }
    public FileStreamResult(Stream fileStream, string contentType);    
 
    protected override void WriteFile(HttpResponseBase response)
    {
        Stream outputStream = response.OutputStream;
        using (this.FileStream)
        {
            byte[] buffer = new byte[0x1000];
            while (true)
            {
                int count = this.FileStream.Read(buffer, 0, 0x1000);
                if (count == 0)
                {
                    return;
                }
                outputStream.Write(buffer, 0, count);
            }
        }
    }    
}
public abstract class Controller : ControllerBase, ...
{
    //其他成员
    protected FileStreamResult File(Stream fileStream, string contentType);
    protected virtual FileStreamResult File(Stream fileStream, string contentType, string fileDownloadName);
}

五、实例演示：通过FileResult发布图片

为了让读者对FileResult具有更加深刻地认识，我们通过一个实例来演示如何通过FileResult来对外发布图片。在通过Visual Studio的ASP.NET MVC项目模板创建的空Web应用中，我们在根目录下添加一个名为images的子目录来存放发布的.jpg图片，然后我们定义如下一个HomeController。

public class HomeController : Controller
{
    public ActionResult Index()
    {
        return View();
    }
 
    public ActionResult Image(string id)
    {
        string path = Server.MapPath("/images/" + id + ".jpg");
        return File(path, "image/jpeg");
    }
}

图片的发布体现在Action方法Image上，表示图片ID的参数同时作为图片的文件名（不含扩展名）。在该方法中，我们根据图片ID解析出对应文件的路径后，直接调用File方法创建一个媒体类型为“image/jpeg”的FilePathResult。在Action方法Index中呈现的View定义如下，我们通过一个列表显示6张图片。基于图片的<img>元素的src属性指定的地址正是指向定义在HomeController的Action方法Image，指定的表示图片ID的参数分别是001、002、…、006。

<html>
    <head>
        <title>Gallery</title>
        <style type = "text/css" >
            li{list-style-type:none; float:left; margin:10px 10px 0px 0px;}
            img{width:100px; height:100px;}
        </style>
    </head>
    <body>
        <ul>
            <li><img alt = "001" src="@Url.Action("Image", new { id = "001" })"/></li>
            <li><img alt = "002" src="@Url.Action("Image", new { id = "002" })"/></li>
            <li><img alt = "003" src="@Url.Action("Image", new { id = "003" })"/></li>
            <li><img alt = "004" src="@Url.Action("Image", new { id = "004" })"/></li>
            <li><img alt = "005" src="@Url.Action("Image", new { id = "005" })"/></li>
            <li><img alt = "006" src="@Url.Action("Image", new { id = "006" })"/></li>
        </ul>
    </body>
</html>

我们将6张.jpg图片存放到/imges目录下，并分别命名为001、002、…、006。