在ASP.NET中跟踪和恢复大文件下载
2024-07-10 12:55:30
供稿：网友
在web应用程序中处理大文件下载的问题一直出了名的困难，因此对于大多数站点来说，如果用户的下载被中断了，它们只能说悲哀降临到用户的身上了。但是我们现在不必这样了，因为你可以使自己的asp.net应用程序有能力支持可恢复（继续）的大文件下载。使用本文提供的方法的时候，你可以跟踪下载的过程，这样你就可以处理动态建立的文件--而且要达到这个目标根本不需要旧式的isapi动态链接库和非受控的（unmanaged）c++代码。
为客户端提供从互联网上下载文件的服务最容易了，对吗？仅仅只需要把可下载的文件复制到你的web应用程序目录中，发布链接并让iis完成所有相关的工作。但是，文件服务不应该比脖子上的疼痛还要多（还要麻烦），你不希望整个世界都能访问自己的数据，你不希望服务器被数百个静态文件塞满了，你甚至于希望下载临时文件--只有当客户端开始下载后的空闲时间才建立这些文件。
不幸的是，使用iis对下载请求的默认的响应是不可能达到这些效果的。因此在一般情况下，为了获得对下载过程的控制权，开发者需要链接到一个定制的.aspx页面，在这个页面中它们检查用户凭证（credential）、建立可以下载的文件并使用下面的代码把该文件推送给客户端：
response.writefile
response.end()
而这就是出现真正麻烦的地方。
有什么问题？
writefile方法看起来非常完美，它使文件的二进制数据流向客户端。但是直到最近我们才知道，writefile方法是一个出名的内存占用狂，它把整个文件载入服务器的ram中来提供服务（实际上它甚至于会占用文件两倍大小的空间）。对于大文件，这会引起服务内存问题，并且可能重复asp.net过程。但是在2004年6月微软发布了一个补丁解决了这个问题。这个补丁现在是.net framework 1.1补丁包（sp1）的一部分。
这个补丁引入了transmitfile方法，它把一个磁盘文件读入到较小的内存缓冲区之后就开始传输该文件。尽管这个方案解决了内存和循环的问题，但是它仍然不能令人满意。你不能控制响应的生命周期。你无法知道下载是否正确地完成了，你没有办法知道下载是否被中断了，并且（如果你建立了临时文件）你也不知道是否应该、以及什么时候可以删除这些文件。更糟的是，如果下载的确失败了，transmitfile方法又从客户端下次尝试的文件头部开始下载。
其中一种可能的解决方案--实现后台智能传输服务（bits）对于多数站点来说是不可行的，因为这会毁掉维持客户端浏览器和操作系统独立性而作出的努力。
令人满意的解决方案的基础还是来自微软用于解决writefile引起的内存混乱问题的第一次尝试（见知识库文章812406）。那篇文章演示了智能的大块数据下载过程，它从文件流中读取数据。在服务器把字节块发送给客户端之前，它使用response.isclientconnected属性检查客户端是否仍然保持着连接。如果仍然保持连接，它就继续发送流字节，否则就停止，以防止服务器发送不必要的数据。
这就是我们采用的方法，特别是在下载临时文件的时候。在isclientconnected返回false的情况下，你就知道下载过程被中断了，你应该保存文件；反之，当这个过程成功完成的时候，你就删除临时文件。此外，为了恢复中断了的下载，你需要做的工作是从上次下载尝试过程中客户端连接失败的文件点开始下载。
http协议和头信息（header）支持
http协议支持可以用于处理被中断下载的头信息。使用少量的http头信息，你可以增强自己的下载过程，使它完全遵循http协议规范。这个规范与ranges一起提供恢复被中断的下载所需要的一切信息。
下面是它的工作方式。首先，如果服务器支持客户端断点续传，它就在初始的响应中发送accept-ranges头信息。服务器还发送一个实体标签（entity tag）头信息（etag），它包含一个唯一的标识字符串。
下面的代码显示了iis发送给客户端的用于响应一个初始下载请求的一些头信息，它向客户端传递了被请求的文件的详细信息。
http/1.1 200 ok
connection: close
date: tue, 19 oct 2004 15:11:23 gmt
accept-ranges: bytes
last-modified: sun, 26 sep 2004 15:52:45 gmt
etag: "47febb2cfd76c41:2062"
cache-control: private
content-type: application/x-zip-compressed
content-length: 2844011
在接收这些头信息之后，如果下载被中断了，ie浏览器在后来的下载请求中会把etag值和range头信息发送回服务器。下面的代码显示了尝试恢复被中断下载时ie发送给服务器的一些头信息。
get http://192.168.100.100/download.zip http/1.0
range: bytes=822603-
unless-modified-since: sun, 26 sep 2004 15:52:45 gmt
if-range: "47febb2cfd76c41:2062"
这些头信息表明ie缓存了iis提供的实体标签，并在if-range头信息中把它发送回服务器了，这是确保下载从准确相同的文件恢复的一种途径。不幸的是，并非所有的浏览器的工作方式都相同。客户端发送的用于验证文件的其它http头信息可能是if-match、if-unmodified-since或者unless-modified-since。很明显，该规范对于客户端软件必须支持哪些头信息，或者必须使用哪些头信息没有明确的规定。因此，有些客户端根本就没有使用头信息，而ie只使用if-range和unless-modified-since。你最好用代码检查这些信息。采用这种方式的时候，你的应用程序可以在非常高的层次遵循http规范，并可以使用多种浏览器。range头信息指明了被请求的字节范围--在例子中它是服务器应该恢复文件流的起始点。
当iis接收到恢复下载的请求类型时，它发回包含下面的头信息的响应信息：
http/1.1 206 partial content
content-range: bytes 822603-2844010/2844011
accept-ranges: bytes
last-modified: sun, 26 sep 2004 15:52:45 gmt
etag: "47febb2cfd76c41:2062"
cache-control: private
content-type: application/x-zip-compressed
content-length: 2021408
请注意上面的代码与最初的下载请求的http响应有点差别--恢复下载的请求是206而最初下载的请求是200。这表明通过线路传递进来的内容是部分文件。这一次content-range头信息指出了被传递字节的精确数量和位置。
ie对于这些头信息是很挑剔的。如果最初的响应没有包含etag头信息，ie永远不会尝试恢复下载。我测试过的其它客户端不使用etag头信息，它们简单得依赖于文件名、请求范围，并使用last-modified头信息（如果它们试图验证该文件）。
深入了解http协议
前面的部分中显示的头信息对于使恢复下载的解决方案运行来说是足够的，但是它没有完全覆盖http规范。
在单个请求中，range头信息可以询问多个范围，这种特性称为"多部分范围（multipart ranges）"。请不要与分段下载（segmented downloading）混淆，几乎所有的下载工具都使用分段下载来提高下载速度。这些工具声称通过打开两个或多个并发的连接（每个连接请求文件的不同范围）提高了下载速度。
多部分范围的想法并没有开启多个连接，但是它可以使客户端软件可以在单个请求/响应周期中请求某个文件的最前面的十个和最后面的十个字节。
诚实地说，我从来都没有找到使用这种特性软件片断。但是我拒绝在代码声明中写入"它并不是完全的http兼容的"。略去这个特性必定会触犯墨菲法则（murphy's law）。无论如何，多部分范围还是被用于电子邮件传输中，把头信息、普通文本和附件分开。
示例代码
我们知道了客户端和服务器如何交换头信息以保证可恢复的下载，把这些知识与文件块流的思想结合起来，你就可以给自己的asp.net应用程序增加可靠的下载管理能力了。
获取下载过程的控制权的方法是从客户端截取下载请求、读取头信息并适当地响应。在.net之前，你必须编写isapi（internet服务器api）应用程序来实现这种功能，但是.net框架组件提供了一个ihttphandler接口，在类中实现的时候，它允许你仅仅使用.net代码就能够截取和处理请求。这意味着你的应用程序对于下载过程有完全控制权和响应性，再也不会涉及或使用iis的自动化函数。
示例代码在httphandler.vb文件中包含了一个自定义的httphandler类（ziphandler）。ziphandler实现了ihttphandler接口，并且处理对所有.zip文件的请求。
为了测试示例代码，你需要在iis中建立一个新的虚拟目录，并把源文件复制到那儿。在该目录中建立一个叫做download.zip的文件（请注意iis和asp.net不能处理大于2gb的下载，因此要确保你的文件没有超过该限制）。配置你的iis虚拟目录，通过aspnet_isapi.dll映射.zip扩展名。
httphandler类：ziphandler
在asp.net中映射了.zip扩展名之后，客户端每次向服务器请求.zip文件的时候，iis调用ziphandler类的processrequest方法（见下载代码）。
processrequest方法首先建立自定义的fileinformation类（见下载代码）的一个实例，它封装了下载的状态（例如进行中、被中断了等等）。示例把download.zip示例文件的路径硬编码到代码中了。如果把这段代码应用于你自己的应用程序，需要修改它来打开被请求的文件。
' 使用objrequest检测请求了哪个文件，用该文件打开objfile。
' 例如objfile = new download.fileinformation(<完整文件名>)
objfile = new download.fileinformation( _
objcontext.server.mappath("~/download.zip"))
接下来，程序使用描述的http头信息（如果请求提供了头信息）执行一系列的验证检查。它把每种检查都封装在小型私有函数中，如果验证成功的话就返回true。如果某个验证检查失败了，响应会立即终止，并发送适当的statuscode值。
if not objrequest.httpmethod.equals(http_method_get) or not
objrequest.httpmethod.equals(http_method_head) then
' 目前只支持get和head方法
objresponse.statuscode = 501 ' 没有执行
elseif not objfile.exists then
' 无法找到被请求的文件
objresponse.statuscode = 404 ' 没有找到
elseif objfile.length > int32.maxvalue then
' 文件太大了
objresponse.statuscode = 413 ' 请求实体太大
elseif not parserequestheaderrange(objrequest, alrequestedrangesbegin, alrequestedrangesend, _
objfile.length, bisrangerequest) then
' range请求中包含无用的实体
objresponse.statuscode = 400 ' 无用的请求
elseif not checkifmodifiedsince(objrequest,objfile) then
' 实体没有被修改过
objresponse.statuscode = 304 ' 没有被修改过
elseif not checkifunmodifiedsince(objrequest,objfile) then
' 实体在上次被请求的日期之后被修改过
objresponse.statuscode = 412 ' 预处理失败
elseif not checkifmatch(objrequest, objfile) then
' 实体与请求不匹配
objresponse.statuscode = 412 ' 预处理失败
elseif not checkifnonematch(objrequest, objresponse,objfile) then
' 实体的确与none-match请求匹配。
' 响应代码位于checkifnonematch函数中
else
' 初步检查成功
这些初步检查的函数中的parserequestheaderrange（见下载代码）检查客户端是否请求了文件范围（这意味着是一个局部下载）。如果被请求的范围是无效的（无效范围指超越文件大小或包含不合理数字的范围数值），该方法把bisrangerequest设置为true。如果请求了范围，checkifrange方法会验证ifrange头信息。
如果被请求的范围是有效的，代码会计算响应信息的大小。如果客户端请求了多个范围，响应信息大小的数值会包含多部分头部信息长度的数值。
如果不能确定某个发送的头部信息值，程序将把这个下载请求作为最初请求而不是部分下载来处理，从文件的顶部开始发送一个新的下载流。
if bisrangerequest andalso checkifrange(objrequest, objfile) then
' 这是范围请求
' 如果range数组包含多个实体，它还是一个多部分范围请求
bmultipart = cbool(alrequestedrangesbegin.getupperbound(0)>0)
' 进入每个范围来获取整个响应长度
for iloop = alrequestedrangesbegin.getlowerbound(0) to alrequestedrangesbegin.getupperbound(0)
' 内容的长度(这个范围的)
iresponsecontentlength += convert.toint32(alrequestedrangesend( _
iloop) - alrequestedrangesbegin(iloop)) + 1
if bmultipart then
' 如果是多部分范围请求，计算出将发送的中间头信息的长度
iresponsecontentlength += multipart_boundary.length
iresponsecontentlength += objfile.contenttype.length
iresponsecontentlength += alrequestedrangesbegin(iloop).tostring.length
iresponsecontentlength += alrequestedrangesend(iloop).tostring.length
iresponsecontentlength += objfile.length.tostring.length
' 49是多部分下载中换行和其它必要的字符的长度
iresponsecontentlength += 49
end if
next iloop
if bmultipart then
' 如果是多部分范围请求，
' 我们还必须计算出将发送的最后一个中间头信息的长度
iresponsecontentlength +=multipart_boundary.length
' 8 是破折号和换行符的长度
iresponsecontentlength += 8
else
' 不是多部分下载，因此我们必须说明初始http头信息的响应范围
objresponse.appendheader( http_header_content_range, "bytes " & _
alrequestedrangesbegin(0).tostring & "-" & _
alrequestedrangesend(0).tostring & "/" & _
objfile.length.tostring)
'end if
' 范围响应
objresponse.statuscode = 206 ' 局部响应
else
' 这不是范围请求，或者被请求的范围实体id与当前的实体id不匹配，
' 因此开始新的下载
' 指明文件完成部分的大小等于内容的长度
iresponsecontentlength =convert.toint32(objfile.length)
' 返回正常的ok状态
objresponse.statuscode = 200
end if
' 接下来服务器必须发送几个重要的响应头信息，例如内容长度、etag、和文件的内容类型：
' 把内容长度写入响应
objresponse.appendheader( http_header_content_length,iresponsecontentlength.tostring)
' 把最后修改日期写入响应
objresponse.appendheader( http_header_last_modified,objfile.lastwritetimeutc.tostring("r"))
' 告诉客户端软件我们接受了范围请求
objresponse.appendheader( http_header_accept_ranges,http_header_accept_ranges_bytes)
' 把文件的实体标签写入响应（用引号括起来）
objresponse.appendheader(http_header_entity_tag, """" & objfile.entitytag & """")
' 把内容类型写入响应
if bmultipart then
' 多部分消息有这种特殊的类型
' 在例子中文件实际的mime类型在以后才写入响应
objresponse.contenttype = multipart_contenttype
else
' 单个部分消息拥有的文件内容类型
objresponse.contenttype = objfile.contenttype
end if
下载所需要的一切都准备好了，可以开始下载文件了。你将使用filestream对象从文件中读取字节块。把fileinformation实例objfile的state属性设置为fsdownloadinprogress。只要客户端保持连接，服务器就从文件中读取字节块并发送给客户端。对于多部分下载，这段代码会发送特定的头信息。如果客户端中断连接，服务器就把文件状态设置为fsdownloadbroken。如果服务器完成了被请求范围的发送过程，它会把状态设置为fsdownloadfinished（见下载代码）。
fileinformation辅助类
在ziphandler部分中你会发现，fileinformation是一个辅助类，它封装了下载状态信息（例如下载中、中断等等）。
为了建立fileinformation的实例，你需要把被请求文件的路径传递给该类的构造函数：
public sub new(byval spath as string)
m_objfile = new system.io.fileinfo(spath)
end sub
fileinformation使用system.io.fileinfo对象来获取文件的信息，这些信息是作为该对象的属性暴露的（例如文件是否存在、文件全名、大小等等）。这个类还暴露了一个downloadstate枚举，它描述了下载请求的多种状态：
<flags()> enum downloadstate
' clear：没有下载过程，文件可能在维护
fsclear = 1
' locked：动态建立的文件不能被更改
fslocked = 2
' in progress：文件被锁定了，下载过程正在进行
fsdownloadinprogress = 6
' broken：文件被锁定了，下载过程正在进行，但是被取消了
fsdownloadbroken = 10
' finished：文件被锁定了，下载过程完成了
fsdownloadfinished = 18
end enum
fileinformation还提供了entitytag属性值。示例代码中的这个值是硬编码的，这是由于示例代码只使用了一个下载文件，并且该文件不会被改变，但是对于实际应用程序来说，你会提供多个文件，甚至于动态地建立文件，你的代码必须为每个文件提供一个唯一的entitytag值。此外，每次改变或修改该文件的时候，这个值也必须改变。这使客户端软件能够验证它们已经下载的字节块是否仍然是最新的。下面是示例代码中返回硬编码entitytag值的部分：
public readonly property entitytag() as string
' entitytag用于对客户端的初始（200）响应，以及来自客户端的恢复请求
get
' 为文件建立唯一的字符串。
' 注意，只要文件没有发生改变，该唯一码就必须保留。
' 但是，如果文件的确改变了或者被修改了，这个码必须改变。
return "myexamplefileid"
end get
end property
一个简单的和大致足够安全的entitytag可能由文件名和文件最后被修改的日期组成。无论使用什么方法，你都必须确保这个值是真的是唯一的，不会与其它文件的entitytag混淆。我希望在自己的应用程序中按照客户、顾客和邮编索引来动态地替被建立的文件命名，并把用作entitytag的guid存储在数据库中。
zipfilehandler类读取和设置公共的state属性。在完成下载以后，它把state设置为fsdownloadfinished。这个时候你就可以删除临时文件了。这儿一般需要调用save方法来维持状态。
public property state() as downloadstate
get
return m_nstate
end get
set(byval nstate as downloadstate)
m_nstate = nstate
' 可选操作：这个时候你可以自动地删除文件。
' 如果状态被设置为finished ，你就再也不需要这个文件了。
' if nstate =downloadstate.fsdownloadfinished then
' clear()
' else
' save()
' end if
save()
end set
end property
在文件状态发生改变的任何时候zipfilehandler都应该调用save方法，保存文件的状态，这样在以后才能显示给用户。你还可以用它来保存你自己建立的entitytag。请不要把文件的状态和entitytag值保存在application、session或cache中--你必须跨越所有的这些这些对象的生命周期来保存信息。
private sub save()
' 把该文件下载的状态保存到数据库或xml文件中。
' 当然，如果你并没有动态地建立文件，就不需要保存这个状态。
end sub
前面提到，示例代码只处理一个已有的文件（download.zip），但是你可以进一步增强这个程序，根据需要建立被请求的文件。
测试示例代码的时候，你的本地系统或lan可能太快了，以至于无法中断下载过程，因此我推荐你使用慢速lan连接（在iis中减少站点的带宽是一种模拟的方法）或者把服务器放到互联网上。
在客户端上下载文件仍然很艰难。isp操作的不对的或配置错误的web缓冲服务器都可能使大文件下载过程失败，包括下载状况恶化或早期对话终结。如果文件大小超过了255mb，你就应该鼓励顾客使用第三方下载管理软件，尽管某些最新的浏览器内建了基本的下载管理器。
如果你希望进一步扩展示例代码，查阅一下http规范是有益的。你可以为下载建立md5校验值，使用content-md5头信息添加它们，提供一种验证下载文件完整性的途径。示例代码除了get和head之外没有涉及到其它的http方法。
