欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2024-02-22 17:23:04
ie的自带下载功能中没有断点续传功能,要实现断点续传功能,需要用到http协议中鲜为人知的几个响应头和请求头。 一. 两个必要响应头accept-ranges、etag...

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; 
}