[转]ASP.NET文件下载各种方式比较:对性能的影响、对大文件的支持、对断点续传和多线程下载的支持
Posted on 2012-04-23 17:28 Baode 阅读(406) 评论(0) 编辑 收藏 举报
asp.net里提供了多种方式,从服务器端向客户端写文件流,实现客户端下载文件。这种技术在做防下载系统时比较有用处。
主些技术主要有:WriteFile、TransmitFile和BinaryWrite
其中WriteFilet和BinaryWrite出现得比较早,对文件流的输出可以启动作用,但由于都是将整个文件读到内存后再往客户端写,因此会占用大量的内存资源,特别是要下载的文件比较大时,影响asp.net应用的稳定运行。
TransmitFile是为了弥补WriteFile和BinaryWrite的不足才出现的方法,比WriteFile和BinaryWrite更加的稳定强大,对大文件的支持也不错。但其也有不足之处,对断点续传的支持不行,一个大的文件如果一次性没有下载完成的话,就需要从头再来。
主些技术主要有:WriteFile、TransmitFile和BinaryWrite
其中WriteFilet和BinaryWrite出现得比较早,对文件流的输出可以启动作用,但由于都是将整个文件读到内存后再往客户端写,因此会占用大量的内存资源,特别是要下载的文件比较大时,影响asp.net应用的稳定运行。
TransmitFile是为了弥补WriteFile和BinaryWrite的不足才出现的方法,比WriteFile和BinaryWrite更加的稳定强大,对大文件的支持也不错。但其也有不足之处,对断点续传的支持不行,一个大的文件如果一次性没有下载完成的话,就需要从头再来。
那么一个对性能影响小、支持大文件下载、支持断点续传甚至是多线程下载程序还是需要自己来写的。其实BinaryWrite和WriteFile之所以会影响性能,是因为将整个文件读到内存后再往客户端写,那么我们可以控制他的输出方式,一次只读一块内容到内存,再往客户端写,这些就可以自定义下载的和个细节了。下面提供一个相对不错的下载函数供大家参考。
1 /**/
2 /// <summary>
3 /// 下载文件,支持大文件、续传、速度限制。支持续传的响应头Accept-Ranges、ETag,请求头Range 。
4 /// Accept-Ranges:响应头,向客户端指明,此进程支持可恢复下载.实现后台智能传输服务(BITS),值为:bytes;
5 /// ETag:响应头,用于对客户端的初始(200)响应,以及来自客户端的恢复请求,
6 /// 必须为每个文件提供一个唯一的ETag值(可由文件名和文件最后被修改的日期组成),这使客户端软件能够验证它们已经下载的字节块是否仍然是最新的。
7 /// Range:续传的起始位置,即已经下载到客户端的字节数,值如:bytes=1474560- 。
8 /// 另外:UrlEncode编码后会把文件名中的空格转换中+(+转换为%2b),但是浏览器是不能理解加号为空格的,所以在浏览器下载得到的文件,空格就变成了加号;
9 /// 解决办法:UrlEncode 之后, 将 "+" 替换成 "%20",因为浏览器将%20转换为空格
10 /// </summary>
11 /// <param name="httpContext">当前请求的HttpContext</param>
12 /// <param name="filePath">下载文件的物理路径,含路径、文件名</param>
13 /// <param name="speed">下载速度:每秒允许下载的字节数</param>
14 /// <returns>true下载成功,false下载失败</returns>
15 public static bool DownloadFile(HttpContext httpContext, string filePath, long speed)
16 {
17 httpContext.Response.Clear();
18 bool ret = true;
19 try
20 {
21 #region --验证:HttpMethod,请求的文件是否存在#region
22 switch (httpContext.Request.HttpMethod.ToUpper())
23 { //目前只支持GET和HEAD方法
24 case "GET":
25 case "HEAD":
26 break;
27 default:
28 httpContext.Response.StatusCode = 501;
29 return false;
30 }
31 if (!File.Exists(filePath))
32 {
33 httpContext.Response.StatusCode = 404;
34 return false;
35 }
36 #endregion
37
38 #region 定义局部变量#region 定义局部变量
39 long startBytes = 0;
40 long stopBytes = 0;
41 int packSize = 1024 * 10; //分块读取,每块10K bytes
42 string fileName = Path.GetFileName(filePath);
43 FileStream myFile = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
44 BinaryReader br = new BinaryReader(myFile);
45 long fileLength = myFile.Length;
46
47 int sleep = (int)Math.Ceiling(1000.0 * packSize / speed);//毫秒数:读取下一数据块的时间间隔
48 string lastUpdateTiemStr = File.GetLastWriteTimeUtc(filePath).ToString("r");
49 string eTag = HttpUtility.UrlEncode(fileName, Encoding.UTF8) + lastUpdateTiemStr;//便于恢复下载时提取请求头;
50 #endregion
51
52 #region --验证:文件是否太大,是否是续传,且在上次被请求的日期之后是否被修改过
53 if (myFile.Length > long.MaxValue)
54 {//-------文件太大了-------
55 httpContext.Response.StatusCode = 413;//请求实体太大
56 return false;
57 }
58
59 if (httpContext.Request.Headers["If-Range"] != null)//对应响应头ETag:文件名+文件最后修改时间
60 {
61 //----------上次被请求的日期之后被修改过--------------
62 if (httpContext.Request.Headers["If-Range"].Replace("\"", "") != eTag)
63 {//文件修改过
64 httpContext.Response.StatusCode = 412;//预处理失败
65 return false;
66 }
67 }
68 #endregion
69
70 try
71 {
72 #region -------添加重要响应头、解析请求头、相关验证
73 httpContext.Response.Clear();
74
75 if (httpContext.Request.Headers["Range"] != null)
76 {//------如果是续传请求,则获取续传的起始位置,即已经下载到客户端的字节数------
77 httpContext.Response.StatusCode = 206;//重要:续传必须,表示局部范围响应。初始下载时默认为200
78 string[] range = httpContext.Request.Headers["Range"].Split(new char[] { '=', '-' });//"bytes=1474560-"
79 startBytes = Convert.ToInt64(range[1]);//已经下载的字节数,即本次下载的开始位置
80 if (startBytes < 0 || startBytes >= fileLength)
81 {//无效的起始位置
82 return false;
83 }
84 if (range.Length == 3)
85 {
86 stopBytes = Convert.ToInt64(range[2]);//结束下载的字节数,即本次下载的结束位置
87 if (startBytes < 0 || startBytes >= fileLength)
88 {
89 return false;
90 }
91 }
92 }
93
94 httpContext.Response.Buffer = false;
95 httpContext.Response.AddHeader("Content-MD5", FileHash.MD5File(filePath));//用于验证文件
96 httpContext.Response.AddHeader("Accept-Ranges", "bytes");//重要:续传必须
97 httpContext.Response.AppendHeader("ETag", "\"" + eTag + "\"");//重要:续传必须
98 httpContext.Response.AppendHeader("Last-Modified", lastUpdateTiemStr);//把最后修改日期写入响应
99 httpContext.Response.ContentType = "application/octet-stream";//MIME类型:匹配任意文件类型
100 httpContext.Response.AddHeader("Content-Disposition", "attachment;filename=" + HttpUtility.UrlEncode(fileName, Encoding.UTF8).Replace("+", "%20"));
101 httpContext.Response.AddHeader("Content-Length", (fileLength - startBytes).ToString());
102 httpContext.Response.AddHeader("Connection", "Keep-Alive");
103 httpContext.Response.ContentEncoding = Encoding.UTF8;
104 if (startBytes > 0)
105 {//------如果是续传请求,告诉客户端本次的开始字节数,总长度,以便客户端将续传数据追加到startBytes位置后----------
106 httpContext.Response.AddHeader("Content-Range", string.Format("bytes {0}-{1}/{2}", startBytes, fileLength - 1, fileLength));
107 }
108 #endregion
109
110 #region -------向客户端发送数据块-------------------
111 br.BaseStream.Seek(startBytes, SeekOrigin.Begin);
112 int maxCount = (int)Math.Ceiling((fileLength - startBytes + 0.0) / packSize);//分块下载,剩余部分可分成的块数
113 for (int i = 0; i < maxCount && httpContext.Response.IsClientConnected; i++)
114 {//客户端中断连接,则暂停
115 httpContext.Response.BinaryWrite(br.ReadBytes(packSize));
116 httpContext.Response.Flush();
117 if (sleep > 1) Thread.Sleep(sleep);
118 }
119 #endregion
120 }
121 catch
122 {
123 ret = false;
124 }
125 finally
126 {
127 br.Close();
128 myFile.Close();
129 }
130 }
131 catch
132 {
133 ret = false;
134 }
135 return ret;
136 }
137
2 /// <summary>
3 /// 下载文件,支持大文件、续传、速度限制。支持续传的响应头Accept-Ranges、ETag,请求头Range 。
4 /// Accept-Ranges:响应头,向客户端指明,此进程支持可恢复下载.实现后台智能传输服务(BITS),值为:bytes;
5 /// ETag:响应头,用于对客户端的初始(200)响应,以及来自客户端的恢复请求,
6 /// 必须为每个文件提供一个唯一的ETag值(可由文件名和文件最后被修改的日期组成),这使客户端软件能够验证它们已经下载的字节块是否仍然是最新的。
7 /// Range:续传的起始位置,即已经下载到客户端的字节数,值如:bytes=1474560- 。
8 /// 另外:UrlEncode编码后会把文件名中的空格转换中+(+转换为%2b),但是浏览器是不能理解加号为空格的,所以在浏览器下载得到的文件,空格就变成了加号;
9 /// 解决办法:UrlEncode 之后, 将 "+" 替换成 "%20",因为浏览器将%20转换为空格
10 /// </summary>
11 /// <param name="httpContext">当前请求的HttpContext</param>
12 /// <param name="filePath">下载文件的物理路径,含路径、文件名</param>
13 /// <param name="speed">下载速度:每秒允许下载的字节数</param>
14 /// <returns>true下载成功,false下载失败</returns>
15 public static bool DownloadFile(HttpContext httpContext, string filePath, long speed)
16 {
17 httpContext.Response.Clear();
18 bool ret = true;
19 try
20 {
21 #region --验证:HttpMethod,请求的文件是否存在#region
22 switch (httpContext.Request.HttpMethod.ToUpper())
23 { //目前只支持GET和HEAD方法
24 case "GET":
25 case "HEAD":
26 break;
27 default:
28 httpContext.Response.StatusCode = 501;
29 return false;
30 }
31 if (!File.Exists(filePath))
32 {
33 httpContext.Response.StatusCode = 404;
34 return false;
35 }
36 #endregion
37
38 #region 定义局部变量#region 定义局部变量
39 long startBytes = 0;
40 long stopBytes = 0;
41 int packSize = 1024 * 10; //分块读取,每块10K bytes
42 string fileName = Path.GetFileName(filePath);
43 FileStream myFile = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
44 BinaryReader br = new BinaryReader(myFile);
45 long fileLength = myFile.Length;
46
47 int sleep = (int)Math.Ceiling(1000.0 * packSize / speed);//毫秒数:读取下一数据块的时间间隔
48 string lastUpdateTiemStr = File.GetLastWriteTimeUtc(filePath).ToString("r");
49 string eTag = HttpUtility.UrlEncode(fileName, Encoding.UTF8) + lastUpdateTiemStr;//便于恢复下载时提取请求头;
50 #endregion
51
52 #region --验证:文件是否太大,是否是续传,且在上次被请求的日期之后是否被修改过
53 if (myFile.Length > long.MaxValue)
54 {//-------文件太大了-------
55 httpContext.Response.StatusCode = 413;//请求实体太大
56 return false;
57 }
58
59 if (httpContext.Request.Headers["If-Range"] != null)//对应响应头ETag:文件名+文件最后修改时间
60 {
61 //----------上次被请求的日期之后被修改过--------------
62 if (httpContext.Request.Headers["If-Range"].Replace("\"", "") != eTag)
63 {//文件修改过
64 httpContext.Response.StatusCode = 412;//预处理失败
65 return false;
66 }
67 }
68 #endregion
69
70 try
71 {
72 #region -------添加重要响应头、解析请求头、相关验证
73 httpContext.Response.Clear();
74
75 if (httpContext.Request.Headers["Range"] != null)
76 {//------如果是续传请求,则获取续传的起始位置,即已经下载到客户端的字节数------
77 httpContext.Response.StatusCode = 206;//重要:续传必须,表示局部范围响应。初始下载时默认为200
78 string[] range = httpContext.Request.Headers["Range"].Split(new char[] { '=', '-' });//"bytes=1474560-"
79 startBytes = Convert.ToInt64(range[1]);//已经下载的字节数,即本次下载的开始位置
80 if (startBytes < 0 || startBytes >= fileLength)
81 {//无效的起始位置
82 return false;
83 }
84 if (range.Length == 3)
85 {
86 stopBytes = Convert.ToInt64(range[2]);//结束下载的字节数,即本次下载的结束位置
87 if (startBytes < 0 || startBytes >= fileLength)
88 {
89 return false;
90 }
91 }
92 }
93
94 httpContext.Response.Buffer = false;
95 httpContext.Response.AddHeader("Content-MD5", FileHash.MD5File(filePath));//用于验证文件
96 httpContext.Response.AddHeader("Accept-Ranges", "bytes");//重要:续传必须
97 httpContext.Response.AppendHeader("ETag", "\"" + eTag + "\"");//重要:续传必须
98 httpContext.Response.AppendHeader("Last-Modified", lastUpdateTiemStr);//把最后修改日期写入响应
99 httpContext.Response.ContentType = "application/octet-stream";//MIME类型:匹配任意文件类型
100 httpContext.Response.AddHeader("Content-Disposition", "attachment;filename=" + HttpUtility.UrlEncode(fileName, Encoding.UTF8).Replace("+", "%20"));
101 httpContext.Response.AddHeader("Content-Length", (fileLength - startBytes).ToString());
102 httpContext.Response.AddHeader("Connection", "Keep-Alive");
103 httpContext.Response.ContentEncoding = Encoding.UTF8;
104 if (startBytes > 0)
105 {//------如果是续传请求,告诉客户端本次的开始字节数,总长度,以便客户端将续传数据追加到startBytes位置后----------
106 httpContext.Response.AddHeader("Content-Range", string.Format("bytes {0}-{1}/{2}", startBytes, fileLength - 1, fileLength));
107 }
108 #endregion
109
110 #region -------向客户端发送数据块-------------------
111 br.BaseStream.Seek(startBytes, SeekOrigin.Begin);
112 int maxCount = (int)Math.Ceiling((fileLength - startBytes + 0.0) / packSize);//分块下载,剩余部分可分成的块数
113 for (int i = 0; i < maxCount && httpContext.Response.IsClientConnected; i++)
114 {//客户端中断连接,则暂停
115 httpContext.Response.BinaryWrite(br.ReadBytes(packSize));
116 httpContext.Response.Flush();
117 if (sleep > 1) Thread.Sleep(sleep);
118 }
119 #endregion
120 }
121 catch
122 {
123 ret = false;
124 }
125 finally
126 {
127 br.Close();
128 myFile.Close();
129 }
130 }
131 catch
132 {
133 ret = false;
134 }
135 return ret;
136 }
137
对的就做,做的就对