在ASP.NET中支持斷點續(xù)傳下載大文件(ZT)源碼

字號:


    這篇文章主要為大家介紹了在ASP.NET中如何做到支持斷點續(xù)傳下載大文件(ZT),需要的朋友可以參考下。
    IE的自帶下載功能中沒有斷點續(xù)傳功能,要實現斷點續(xù)傳功能,需要用到HTTP協(xié)議中鮮為人知的幾個響應頭和請求頭。
    一. 兩個必要響應頭Accept-Ranges、ETag
    客戶端每次提交下載請求時,服務端都要添加這兩個響應頭,以保證客戶端和服務端將此下載識別為可以斷點續(xù)傳的下載:
    Accept-Ranges:告知下載客戶端這是一個可以恢復續(xù)傳的下載,存放本次下載的開始字節(jié)位置、文件的字節(jié)大小;
    ETag:保存文件的唯一標識(我在用的文件名+文件最后修改時間,以便續(xù)傳請求時對文件進行驗證);
    Last-Modified:可選響應頭,存放服務端文件的最后修改時間,用于驗證
    二. 一個重要請求頭Range
    Range:首次下載時,Range頭為null,此時服務端的響應頭中必須添加響應頭Accept-Ranges、ETag;
    續(xù)傳請求時,其值表示客戶端已經收到的字節(jié)數,即本次下載的開始字節(jié)位置,服務端依據這個 值從相應位置讀取數據發(fā)送到客戶端。
    三. 用于驗證的請求頭If-Range、
    當響應頭中包含有Accept-Ranges、ETag時,續(xù)傳請求時,將包含這些請求頭:
    If-Range:對應響應頭ETag的值;
    Unless-Modified-Since:對應響應頭Last-Modified的值。
    續(xù)傳請求時,為了保證客戶端與服務端的文件的一致性和正確性,有必要對文件進行驗證,驗證需要自己寫驗證代碼,就根據解析這兩個請求頭的值,將客戶端已下載的部分與服務端的文件進行對比,如果不吻合,則從頭開始下載,如果吻合,則斷點續(xù)傳。
    四. 速度限制
    程序中加入了速度限制,用于對客戶端進行權限控制的流量限制。
    五. 其它注意事項
    如:文件名亂碼的問題、文件名中空格變加號、強制客戶端顯示下載對話框等,詳見源碼注釋:
    /**//// <summary>
    /// 下載文件,支持大文件、續(xù)傳、速度限制。支持續(xù)傳的響應頭Accept-Ranges、ETag,請求頭Range 。
    /// Accept-Ranges:響應頭,向客戶端指明,此進程支持可恢復下載.實現后臺智能傳輸服務(BITS),值為:bytes;
    /// ETag:響應頭,用于對客戶端的初始(200)響應,以及來自客戶端的恢復請求,
    /// 必須為每個文件提供一個唯一的ETag值(可由文件名和文件最后被修改的日期組成),這使客戶端軟件能夠驗證它們已經下載的字節(jié)塊是否仍然是最新的。
    /// Range:續(xù)傳的起始位置,即已經下載到客戶端的字節(jié)數,值如:bytes=1474560- 。
    /// 另外:UrlEncode編碼后會把文件名中的空格轉換中+(+轉換為%2b),但是瀏覽器是不能理解加號為空格的,所以在瀏覽器下載得到的文件,空格就變成了加號;
    /// 解決辦法:UrlEncode 之后, 將 "+" 替換成 "%20",因為瀏覽器將%20轉換為空格
    /// </summary>
    /// <param name="httpContext">當前請求的HttpContext</param>
    /// <param name="filePath">下載文件的物理路徑,含路徑、文件名</param>
    /// <param name="speed">下載速度:每秒允許下載的字節(jié)數</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--驗證:文件是否太大,是否是續(xù)傳,且在上次被請求的日期之后是否被修
    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");//重要:續(xù)傳必須
    httpContext.Response.AppendHeader("ETag", "\"" + eTag + "\"");//重要:續(xù)傳必須
    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)
    {//------如果是續(xù)傳請求,則獲取續(xù)傳的起始位置,即已經下載到客戶端的字節(jié)數------
    httpContext.Response.StatusCode = 206;//重要:續(xù)傳必須,表示局部范圍響應。初始下載時默認為200
    string[] range = httpContext.Request.Headers["Range"].Split(new char[] { '=', '-' });//"bytes=1474560-"
    startBytes = Convert.ToInt64(range[1]);//已經下載的字節(jié)數,即本次下載的開始位置
    if (startBytes < 0 || startBytes >= fileLength)
    {//無效的起始位置
    return false;
    }
    }
    if (startBytes > 0)
    {//------如果是續(xù)傳請求,告訴客戶端本次的開始字節(jié)數,總長度,以便客戶端將續(xù)傳數據追加到startBytes位置后----------
    httpContext.Response.AddHeader("Content-Range", string.Format(" bytes {0}-{1}/{2}", startBytes, fileLength - 1, fileLength));
    }
    #endregion
    #region -------向客戶端發(fā)送數據塊-------------------
    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;
    }