当前位置:Gxlcms > asp.net > 在ASP.NET中支持断点续传下载大文件(ZT)源码

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

时间:2021-07-01 10:21:17 帮助过:43人阅读

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

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

五. 其它注意事项
如:文件名乱码的问题、文件名中空格变加号、强制客户端显示下载对话框等,详见源码注释:

/**//// <summary> 
/// 下载文件,支持大文件、续传、速度限制。支持续传的响应头Accept-Ranges、ETag,请求头Range 。 
/// Accept-Ranges:响应头,向客户端指明,此进程支持可恢复下载.实现后台智能传输服务(BITS),值为:bytes; 
/// ETag:响应头,用于对客户端的初始(200)响应,以及来自客户端的恢复请求, 
/// 必须为每个文件提供一个唯一的ETag值(可由文件名和文件最后被修改的日期组成),这使客户端软件能够验证它们已经下载的字节块是否仍然是最新的。 
/// Range:续传的起始位置,即已经下载到客户端的字节数,值如:bytes=1474560- 。 
/// 另外:UrlEncode编码后会把文件名中的空格转换中+(+转换为%2b),但是浏览器是不能理解加号为空格的,所以在浏览器下载得到的文件,空格就变成了加号; 
/// 解决办法:UrlEncode 之后, 将 "+" 替换成 "%20",因为浏览器将%20转换为空格 
/// </summary> 
/// <param name="httpContext">当前请求的HttpContext</param> 
/// <param name="filePath">下载文件的物理路径,含路径、文件名</param> 
/// <param name="speed">下载速度:每秒允许下载的字节数</param> 
/// <returns>true下载成功,false下载失败</returns> 
public static bool DownloadFile(HttpContext httpContext, string filePath, long speed) 
{ 
bool ret = true; 
try 
{ 
#region--验证:HttpMethod,请求的文件是否存在 
switch (httpContext.Request.HttpMethod.ToUpper()) 
{ //目前只支持GET和HEAD方法 
case "GET": 
case "HEAD": 
break; 
default: 
httpContext.Response.StatusCode = 501; 
return false; 
} 
if (!File.Exists(filePath)) 
{ 
httpContext.Response.StatusCode = 404; 
return false; 
} 
#endregion 

#region 定义局部变量 
long startBytes = 0; 
int packSize = 1024 * 10; //分块读取,每块10K bytes 
string fileName = Path.GetFileName(filePath); 
FileStream myFile = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite); 
BinaryReader br = new BinaryReader(myFile); 
long fileLength = myFile.Length; 

int sleep = (int)Math.Ceiling(1000.0 * packSize / speed);//毫秒数:读取下一数据块的时间间隔 
string lastUpdateTiemStr = File.GetLastWriteTimeUtc(filePath).ToString("r"); 
string eTag = HttpUtility.UrlEncode(fileName, Encoding.UTF8) + lastUpdateTiemStr;//便于恢复下载时提取请求头; 
#endregion 

#region--验证:文件是否太大,是否是续传,且在上次被请求的日期之后是否被修 
if (myFile.Length > Int32.MaxValue) 
{//-------文件太大了------- 
httpContext.Response.StatusCode = 413;//请求实体太大 
return false; 
} 

if (httpContext.Request.Headers["If-Range"] != null)//对应响应头ETag:文件名+文件最后修改时间 
{ 
//----------上次被请求的日期之后被修改过-------------- 
if (httpContext.Request.Headers["If-Range"].Replace("\"", "") != eTag) 
{//文件修改过 
httpContext.Response.StatusCode = 412;//预处理失败 
return false; 
} 
} 
#endregion 

try 
{ 
#region -------添加重要响应头、解析请求头、相关验证------------------- 
httpContext.Response.Clear(); 
httpContext.Response.Buffer = false; 
httpContext.Response.AddHeader("Content-MD5", GetMD5Hash(myFile));//用于验证文件 
httpContext.Response.AddHeader("Accept-Ranges", "bytes");//重要:续传必须 
httpContext.Response.AppendHeader("ETag", "\"" + eTag + "\"");//重要:续传必须 
httpContext.Response.AppendHeader("Last-Modified", lastUpdateTiemStr);//把最后修改日期写入响应 
httpContext.Response.ContentType = "application/octet-stream";//MIME类型:匹配任意文件类型 
httpContext.Response.AddHeader("Content-Disposition", "attachment;filename=" + HttpUtility.UrlEncode(fileName, Encoding.UTF8).Replace("+", "%20")); 
httpContext.Response.AddHeader("Content-Length", (fileLength - startBytes).ToString()); 
httpContext.Response.AddHeader("Connection", "Keep-Alive"); 
httpContext.Response.ContentEncoding = Encoding.UTF8; 
if (httpContext.Request.Headers["Range"] != null) 
{//------如果是续传请求,则获取续传的起始位置,即已经下载到客户端的字节数------ 
httpContext.Response.StatusCode = 206;//重要:续传必须,表示局部范围响应。初始下载时默认为200 
string[] range = httpContext.Request.Headers["Range"].Split(new char[] { '=', '-' });//"bytes=1474560-" 
startBytes = Convert.ToInt64(range[1]);//已经下载的字节数,即本次下载的开始位置 
if (startBytes < 0 || startBytes >= fileLength) 
{//无效的起始位置 
return false; 
} 
} 
if (startBytes > 0) 
{//------如果是续传请求,告诉客户端本次的开始字节数,总长度,以便客户端将续传数据追加到startBytes位置后---------- 
httpContext.Response.AddHeader("Content-Range", string.Format(" bytes {0}-{1}/{2}", startBytes, fileLength - 1, fileLength)); 
} 
#endregion 

#region -------向客户端发送数据块------------------- 
br.BaseStream.Seek(startBytes, SeekOrigin.Begin); 
int maxCount = (int)Math.Ceiling((fileLength - startBytes + 0.0) / packSize);//分块下载,剩余部分可分成的块数 
for (int i = 0; i < maxCount && httpContext.Response.IsClientConnected; i++) 
{//客户端中断连接,则暂停 
httpContext.Response.BinaryWrite(br.ReadBytes(packSize)); 
httpContext.Response.Flush(); 
if (sleep > 1) Thread.Sleep(sleep); 
} 
#endregion 
} 
catch 
{ 
ret = false; 
} 
finally 
{ 
br.Close(); 
myFile.Close(); 
} 
} 
catch 
{ 
ret = false; 
} 
return ret; 
}

人气教程排行