在ASP.NET中支持断点续传下载大文件(ZT)源码

时间：2021-11-05 17:31:21

IE的自带下载功能中没有断点续传功能，要实现断点续传功能，需要用到HTTP协议中鲜为人知的几个响应头和请求头。

一. 两个必要响应头Accept-Ranges、ETag

客户端每次提交下载请求时，服务端都要添加这两个响应头，以保证客户端和服务端将此下载识别为可以断点续传的下载：

Accept-Ranges：告知下载客户端这是一个可以恢复续传的下载，存放本次下载的开始字节位置、文件的字节大小;

ETag：保存文件的唯一标识(我在用的文件名+文件最后修改时间，以便续传请求时对文件进行验证);

Last-Modified：可选响应头，存放服务端文件的最后修改时间，用于验证

二. 一个重要请求头Range

Range：首次下载时，Range头为null，此时服务端的响应头中必须添加响应头Accept-Ranges、ETag;

续传请求时，其值表示客户端已经收到的字节数，即本次下载的开始字节位置，服务端依据这个 值从相应位置读取数据发送到客户端。

三. 用于验证的请求头If-Range、

当响应头中包含有Accept-Ranges、ETag时，续传请求时，将包含这些请求头：

If-Range：对应响应头ETag的值;

Unless-Modified-Since：对应响应头Last-Modified的值。

续传请求时，为了保证客户端与服务端的文件的一致性和正确性，有必要对文件进行验证，验证需要自己写验证代码，就根据解析这两个请求头的值，将客户端已下载的部分与服务端的文件进行对比，如果不吻合，则从头开始下载，如果吻合，则断点续传。

四. 速度限制

程序中加入了速度限制，用于对客户端进行权限控制的流量限制。

五. 其它注意事项

如：文件名乱码的问题、文件名中空格变加号、强制客户端显示下载对话框等，详见源码注释：

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

相关文章