IT教程 ·

浅谈ActionResult之FileResult

FileResult是一个基于文件的ActionResult,应用FileResult,我们能够很轻易的将某个物理文件的内容响应给客户端,ASP.NET MVC定义了三个详细的FileResult,分别是 FileContentResult、FilePathResult、FileStreamResult。在这篇文章中,我们来讨论一下三种详细的FileResult是如何将文件内容对要求举行响应的。

一、FileResult

以下面的代码片断所示,FileResult具有一个示意媒体范例的只读属性ContentType,该属性在组织函数中被初始化。当我们基于某个物理文件建立响应的FileResult对象的时刻,应当依据文件的范例指定媒体范例,比如说,目的文件是一个.JPG图片,那末对应的媒体范例就应当是“image/jpeg”,关于一个.pdf文件,则采纳“application/pdf”。

浅谈ActionResult之FileResult IT教程 第1张

 1 public abstract class FileResult : ActionResult  2 {  3     private string _fileDownloadName;  4         
 5     protected FileResult(string contentType)  6  {  7         if (string.IsNullOrEmpty(contentType))  8  {  9             throw new ArgumentException(MvcResources.Common_NullOrEmpty, "contentType");  10  }  11         this.ContentType = contentType;  12  }  13         
 14     public override void ExecuteResult(ControllerContext context)  15  {  16         if (context == null)  17  {  18             throw new ArgumentNullException("context");  19  }  20         HttpResponseBase response = context.HttpContext.Response;  21         response.ContentType = this.ContentType;  22         if (!string.IsNullOrEmpty(this.FileDownloadName))  23  {  24             string headerValue = ContentDispositionUtil.GetHeaderValue(this.FileDownloadName);  25             context.HttpContext.Response.AddHeader("Content-Disposition", headerValue);  26  }  27         this.WriteFile(response);  28  }  29         
 30     protected abstract void WriteFile(HttpResponseBase response);  31         
 32     public string ContentType { get; private set; }  33         
 34     public string FileDownloadName  35  {  36         get
 37  {  38             return (this._fileDownloadName ?? string.Empty);  39  }  40         set
 41  {  42             this._fileDownloadName = value;  43  }  44  }  45         
 46     internal static class ContentDispositionUtil  47  {  48         private const string HexDigits = "0123456789ABCDEF";  49             
 50         private static void AddByteToStringBuilder(byte b, StringBuilder builder)  51  {  52             builder.Append('%');  53             int num = b;  54             AddHexDigitToStringBuilder(num >> 4, builder);  55             AddHexDigitToStringBuilder(num % 0x10, builder);  56  }  57             
 58         private static void AddHexDigitToStringBuilder(int digit, StringBuilder builder)  59  {  60             builder.Append("0123456789ABCDEF"[digit]);  61  }  62             
 63         private static string CreateRfc2231HeaderValue(string filename)  64  {  65             StringBuilder builder = new StringBuilder("attachment; filename*=UTF-8''");  66             foreach (byte num in Encoding.UTF8.GetBytes(filename))  67  {  68                 if (IsByteValidHeaderValueCharacter(num))  69  {  70                     builder.Append((char) num);  71  }  72                 else
 73  {  74  AddByteToStringBuilder(num, builder);  75  }  76  }  77             return builder.ToString();  78  }  79             
 80         public static string GetHeaderValue(string fileName)  81  {  82             foreach (char ch in fileName)  83  {  84                 if (ch > 'x007f')  85  {  86                     return CreateRfc2231HeaderValue(fileName);  87  }  88  }  89             ContentDisposition disposition = new ContentDisposition {  90                 FileName = fileName  91  };  92             return disposition.ToString();  93  }  94             
 95         private static bool IsByteValidHeaderValueCharacter(byte b)  96  {  97             if ((0x30 <= b) && (b <= 0x39))  98  {  99                 return true; 100  } 101             if ((0x61 <= b) && (b <= 0x7a)) 102  { 103                 return true; 104  } 105             if ((0x41 <= b) && (b <= 90)) 106  { 107                 return true; 108  } 109             switch (b) 110  { 111                 case 0x3a: 112                 case 0x5f: 113                 case 0x7e: 114                 case 0x24: 115                 case 0x26: 116                 case 0x21: 117                 case 0x2b: 118                 case 0x2d: 119                 case 0x2e: 120                     return true; 121  } 122             return false; 123  } 124  } 125 }

View Code

 针对文件的响应具有两种情势,内联(Inline)和附件(Attachment)。平常来说,前者会应用浏览器直接翻开响应文件,而后者则会以自力的文件下载到客户端。关于后者,我们平常会为下载的文件指定一个文件名,这个文件名能够经由过程FileResult的FileDownloadName属性来指定。文件响应在默许情况下采纳内联体式格局,假如须要采纳附件的情势,须要为响应建立一个名为Content-Disposition的报头,该报头值的花样为“attachment;filename={FileDownloadName}”。

FileResult仅仅是一个笼统类,文件内容的输出实如今笼统要领WriteFile中,该要领会在重写的ExecuteResult要领中挪用。假如FileDownloadName属性不为空,意味着会采纳附件的情势举行文件响应,FileResult会在重写的ExecuteResult要领中举行Content-Disposition响应报头的设置。以下面的代码片断,基本上表现了ExecuteResult要领在FileResult中的表现。

浅谈ActionResult之FileResult IT教程 第1张

 1 public override void ExecuteResult(ControllerContext context)  2 {  3     if (context == null)  4  {  5         throw new ArgumentNullException("context");  6  }  7     HttpResponseBase response = context.HttpContext.Response;  8     response.ContentType = this.ContentType;  9     if (!string.IsNullOrEmpty(this.FileDownloadName)) 10  { 11         string headerValue = ContentDispositionUtil.GetHeaderValue(this.FileDownloadName); 12         context.HttpContext.Response.AddHeader("Content-Disposition", headerValue); 13  } 14     this.WriteFile(response); 15 }

View Code

ASP.NET MVC定义了三个详细的FileResult,分别是FileContentResult、FilePathResult、FileStreamResult。接下来我们对他们举行零丁引见。

二、FileContentResult

FileContentResult是针对文件内容建立的FileResult。以下面的代码片断所示,FileContentResult具有一个字节数组范例的只读属性FileContents示意响应文件的内容,该属性在组织函数中指定。FileContentResult针对文件内容的响应完成也很简单,从以下示的WriteFile要领定义能够看出,它只是挪用当前HttpResponse的OutputStream属性的Write要领直接将示意文件内容的字节数组写入响应输出流。

浅谈ActionResult之FileResult IT教程 第1张

 1 public class FileContentResult : FileResult  2 {  3     public FileContentResult(byte[] fileContents, string contentType) : base(contentType)  4  {  5         if (fileContents == null)  6  {  7             throw new ArgumentNullException("fileContents");  8  }  9         this.FileContents = fileContents; 10  } 11         
12     protected override void WriteFile(HttpResponseBase response) 13  { 14         response.OutputStream.Write(this.FileContents, 0, this.FileContents.Length); 15  } 16         
17     public byte[] FileContents { get; private set; } 18 } 19 public abstract class Controller : ControllerBase, IActionFilter, IAuthorizationFilter, IDisposable, IExceptionFilter, IResultFilter, IAsyncController, IController, IAsyncManagerContainer 20 { 21     protected internal FileContentResult File(byte[] fileContents, string contentType) 22  { 23         return this.File(fileContents, contentType, null); 24  } 25     protected internal virtual FileContentResult File(byte[] fileContents, string contentType, string fileDownloadName) 26  { 27         return new FileContentResult(fileContents, contentType) { FileDownloadName = fileDownloadName }; 28  } 29 }

View Code

笼统类Controller中定义了如上两个File重载依据指定的字节数组、媒体范例和下载文件名(可选)生成响应的FileContentResult。因为FileContentResult是依据字节数组建立的,当我们须要动态生成响应文件内容(而不是从物理文件中读取)时,FileContentResult是一个不错的挑选。

三、FilePathResult

从称号能够看出,FilePathResult是一个依据物理文件途径建立FileResult。以下面的代码片断所示,示意响应文件的途径经由过程只读属性FileName示意,该属性在组织函数中被初始化。在完成的WriteFile要领中,FilePathResult直接将文件途径作为参数挪用当前HttpResponse的TransmiteFile完成了针对文件内容的响应。笼统类Controller一样定义了两个File要领重载来依据文件途径建立响应的FilePathResult。

浅谈ActionResult之FileResult IT教程 第1张

 1 public class FilePathResult : FileResult  2 {  3     public FilePathResult(string fileName, string contentType) : base(contentType)  4  {  5         if (string.IsNullOrEmpty(fileName))  6  {  7             throw new ArgumentException(MvcResources.Common_NullOrEmpty, "fileName");  8  }  9         this.FileName = fileName; 10  } 11         
12     protected override void WriteFile(HttpResponseBase response) 13  { 14         response.TransmitFile(this.FileName); 15  } 16         
17     public string FileName { get; private set; } 18 } 19 public abstract class Controller : ControllerBase,... 20 { 21     protected internal FilePathResult File(string fileName, string contentType) 22  { 23         return this.File(fileName, contentType, null); 24  } 25     protected internal virtual FilePathResult File(string fileName, string contentType, string fileDownloadName) 26  { 27         return new FilePathResult(fileName, contentType) { FileDownloadName = fileDownloadName }; 28  } 29  ..... 30 } 

View Code

四、FileStreamResult

FileStreamResult许可我们经由过程一个用于读取文件内容的流来建立FileResult。以下面的代码片断所示,读取文件流经由过程只读属性FileStream示意,该属性在组织函数中被初始化。在完成的WriteFile要领中,FileStreamResult经由过程指定的文件流读取文件内容,并终究挪用当前HttpResponse的OutputStream属性和Write要领将读取的内容写入当前Http响应的输出流中。笼统类Controller中一样定义了两个File要领重载依据文件杜宇流建立响应的FileStreamResult。

浅谈ActionResult之FileResult IT教程 第1张

 1 public class FileStreamResult : FileResult  2 {  3     private const int BufferSize = 0x1000;  4         
 5     public FileStreamResult(Stream fileStream, string contentType) : base(contentType)  6  {  7         if (fileStream == null)  8  {  9             throw new ArgumentNullException("fileStream"); 10  } 11         this.FileStream = fileStream; 12  } 13         
14     protected override void WriteFile(HttpResponseBase response) 15  { 16         Stream outputStream = response.OutputStream; 17         using (this.FileStream) 18  { 19             byte[] buffer = new byte[0x1000]; 20             while (true) 21  { 22                 int count = this.FileStream.Read(buffer, 0, 0x1000); 23                 if (count == 0) 24  { 25                     return; 26  } 27                 outputStream.Write(buffer, 0, count); 28  } 29  } 30  } 31         
32     public Stream FileStream { get; private set; } 33 } 34 public abstract class Controller : ControllerBase, ... 35 { 36     protected internal FileStreamResult File(Stream fileStream, string contentType) 37  { 38         return this.File(fileStream, contentType, null); 39  } 40     protected internal virtual FileStreamResult File(Stream fileStream, string contentType, string fileDownloadName) 41  { 42         return new FileStreamResult(fileStream, contentType) { FileDownloadName = fileDownloadName }; 43  } 44  ... 45 }

View Code

以上就是FileResult的三个子类。好了,关于FileResult的接收就到这里。

参与评论