解決Asp.net 實現文件下載時、輸出文件時文件名的中文亂碼和空格異常

在 asp.net 項目中，我們可以很方便地使用 Response.WriteFile() 方法向客戶端輸出一個文件。
實際使用 asp.net 向客戶端輸出文件流時，卻出現了異常：
1、空格問題，當原文件的文件名中含有空格時，將引發客戶端獲取到的文件名與服務器端不一致。
2、中文字符亂碼，準確的是非 ASCII 字符亂碼，當原文件的文件名中含有非 ASCII 字符時，將引發客戶端獲取到的文件名錯亂。
3、一些特殊字符不能被正常輸出（當然這裏我並不是那些不常見的符號）

注意，本文用 C# 代碼解決了在目前四種流行瀏覽器中Asp.net 輸出文件流時文件名的空格及中文字符亂碼這兩個問題。使用本文的代碼，你將可以讓 IE（Internet Explorer）、Opera、Firefox 及 Chrome 的用戶享受到沒有亂碼且支持空格文件名的文件輸出引擎，同時支持文件名中各種像“# $ % ^ &”等常見的符號，如 "Microsoft.Asp.Net.doc" 、“F ile;;!@%#^&y.doc” 這樣的文件名也可以了。請看下圖：

 

本文下面的內容將描述問題的具體表現，並對相關代碼做一些解釋；
如果你不需要閱讀這些內容，你可以直接下載示例代碼。

 

問題現象：

對於第一個問題

在IE中，當原文件名包含空格時，默認將被改成下劃線，即“_”；如果我們在輸出文件時對文件名使用 UrlEncode() 對其進行編碼，空格將變成加號，即“+”。
在 Opera 中，文件名不需要經過 UrlEncode() 即可正確地解析，但注意經過了 UrlEncode() 後也與IE一樣，空格變成了加號。
很遺憾， Firefox 似乎並不歡迎含有空格的文件名，它會直接捨棄空格後面的部分。對於上圖中的例子，沒有進行 UrlEncode() 之前，Firefox 會得到一個“My.axd”的文件名，可以看到，它對文件類型把握並沒有錯誤（只因爲這由別外的部分負責）；進行 UrlEncode() 之後，它的結果與 IE、Opera 等一致，空格變成了加號。

 

對於第二個問題

第二個問題有點複雜了。
當原文件名包含中文或其他非英文字符時，由於編碼的錯誤，默認情況很糟糕，竟然完全是無法辨識的亂碼；如果我們在輸出文件時對文件名進行 UrlEncode() 對其進行編碼，這些中文將能正確地被顯示；
但注意，問題並沒有完。在Opera 或 Firefox 中，不需要經過 UrlEncode() 即能正確地顯示了；不幸地是，如果經過了 UrlEncode()，它們將無法正確地解析。
看下面幾個圖，分別是沒有使用 UrlEncode() 編碼文件名和使用了 UrlEncode() 的時候，全英文的原文件名的文件輸出到客戶端的情況：

 

未進行 UrlEncode() 的中文文件名，IE 瀏覽器：

 

 

已進行 UrlEncode() 的中文文件名，IE 瀏覽器：

 

 

 

已進行 UrlEncode() 的中文文件名，Opera 瀏覽器

 

 

 至於 Firefox 與 Chrome 的圖就不貼了，它們與 Opera 基本一致。

 

 

問題的解決

我們可以總結如下規律：
 Internet Explorer 能在客戶端已經UrlEncode() 的字符，包括空格在內；而 Opera 等其他瀏覽器可以解析未經 UrlEncode() 的直接輸出的字符（這意味着，對於使用Opera或其他客戶端的客戶，我們不應該對它進行 UrlEncode()編碼）

爲了正確地編碼，我參考一位外國人士的代碼，使用並改進了16進制編碼方法。參考下面的代碼，可以大部分的解決問題。由於 Firefox 默認不支持中文，特別對 Firefox 用戶做了一些處理，在下面的代碼中能夠體現。

 

在輸出文件地地方使用的代碼：

if (context != null) { HttpRequest request = context.Request; HttpResponse response = context.Response; //本文件使用了 QueryString 來傳遞文件名，你也可以不使用 if (!string.IsNullOrEmpty(context.Request.QueryString["file"])) { //取得客戶端正在請求的文件的物理路徑 //不使用 QueryString 時，你可以使用 request.PhysicalPath 獲取 string path = context.Server.MapPath("~/") + context.Server.UrlDecode(context.Request.QueryString["file"]).Replace("/", "//").ToLower(); if (File.Exists(path)) { string extension = Path.GetExtension(path); response.ContentType = GetMimeType(extension); string fileName = System.IO.Path.GetFileName(path); if (request.UserAgent.ToLower().IndexOf("msie") > -1) { //當客戶端使用IE時，對其進行編碼；We should encode the filename when our visitors use IE //使用 ToHexString 代替傳統的 UrlEncode()；We use "ToHexString" replaced "context.Server.UrlEncode(fileName)" fileName = ToHexString(fileName); } if (request.UserAgent.ToLower().IndexOf("firefox") > -1) { //爲了向客戶端輸出空格，需要在當客戶端使用 Firefox 時特殊處理 response.AddHeader("Content-Disposition", "attachment;filename=/"" + fileName + "/""); } else response.AddHeader("Content-Disposition", "attachment;filename=" + fileName); response.WriteFile(path); response.End(); return; } } } //正在請求的文件不存在；Cannot find the specified file context.Response.Clear(); context.Response.Write("the data you are wanting to get does not exsit."); context.Response.End();

 

 
下面是核心處理，應該置於上述代碼同一文件或可訪問的其他類：

#region 編碼 /// <summary> /// 對字符串中的非 ASCII 字符進行編碼 /// </summary> /// <param name="s"></param> /// <returns></returns> public static string ToHexString(string s) { char[] chars = s.ToCharArray(); StringBuilder builder = new StringBuilder(); for (int index = 0; index < chars.Length; index++) { bool needToEncode = NeedToEncode(chars[index]); if (needToEncode) { string encodedString = ToHexString(chars[index]); builder.Append(encodedString); } else { builder.Append(chars[index]); } } return builder.ToString(); } /// <summary> /// 判斷字符是否需要使用特殊的 ToHexString 的編碼方式 /// </summary> /// <param name="chr"></param> /// <returns></returns> private static bool NeedToEncode(char chr) { string reservedChars = "$-_.+!*'(),@=&"; if (chr > 127) return true; if (char.IsLetterOrDigit(chr) || reservedChars.IndexOf(chr) >= 0) return false; return true; } /// <summary> /// 爲非 ASCII 字符編碼 /// </summary> /// <param name="chr"></param> /// <returns></returns> private static string ToHexString(char chr) { UTF8Encoding utf8 = new UTF8Encoding(); byte[] encodedBytes = utf8.GetBytes(chr.ToString()); StringBuilder builder = new StringBuilder(); for (int index = 0; index < encodedBytes.Length; index++) { builder.AppendFormat("%{0}", Convert.ToString(encodedBytes[index], 16)); } return builder.ToString(); } #endregion /// <summary> /// 根據文件後綴來獲取MIME類型字符串 /// </summary> /// <param name="extension">文件後綴</param> /// <returns></returns> static string GetMimeType(string extension) { string mime = string.Empty; extension = extension.ToLower(); switch (extension) { case ".avi": mime = "video/x-msvideo"; break; case ".bin": case ".exe": case ".msi": case ".dll": case ".class": mime = "application/octet-stream"; break; case ".csv": mime = "text/comma-separated-values"; break; case ".html": case ".htm": case ".shtml": mime = "text/html"; break; case ".css": mime = "text/css"; break; case ".js": mime = "text/javascript"; break; case ".doc": case ".dot": case ".docx": mime = "application/msword"; break; case ".xla": case ".xls": case ".xlsx": mime = "application/msexcel"; break; case ".ppt": case ".pptx": mime = "application/mspowerpoint"; break; case ".gz": mime = "application/gzip"; break; case ".gif": mime = "image/gif"; break; case ".bmp": mime = "image/bmp"; break; case ".jpeg": case ".jpg": case ".jpe": case ".png": mime = "image/jpeg"; break; case ".mpeg": case ".mpg": case ".mpe": case ".wmv": mime = "video/mpeg"; break; case ".mp3": case ".wma": mime = "audio/mpeg"; break; case ".pdf": mime = "application/pdf"; break; case ".rar": mime = "application/octet-stream"; break; case ".txt": mime = "text/plain"; break; case ".7z": case ".z": mime = "application/x-compress"; break; case ".zip": mime = "application/x-zip-compressed"; break; default: mime = "application/octet-stream"; break; } return mime; }

 

 此外，針對一些瀏覽器做了一些特殊的處理，已經體現在本文示例代碼的註釋中。此代碼已經能非常完好地解決問題了，在 Internet Explorer 、Opera、Firefox 及 Chrome 中得到的體驗一致，支持中文，支持空格的正常輸出。

 

如果複製代碼後運行不正常，可以參考在示例代碼文件的處理情況，在這裏下載示例代碼文件，示例文件是一個 HttpHandler，因此你可能需要爲它在 Web.Config 中做相關配置，關於配置方法，請參考其他資料。你可以按你的需要來修改示例代碼。

 

本文版權：陳計節

轉載請註明出處。

歡迎訪問本文在 ciznx.com 的原地址：http://blog.ciznx.com/post/aspnetstreamdownloaddisplaynonunicodespacechar.aspx