推薦一個開源免費的 Spring Boot 實戰專案

vbcjnmkk發表於2024-09-01
Spring Boot

最近由於筆者所在的研發集團產品需要，需要支援高效能的大檔案（大都數是4GB以上）的http上傳，並且要求支援http斷點續傳。筆者在以前的部落格如何實現支援大檔案的高效能HTTP檔案上傳伺服器已經介紹了實現大檔案上傳的一些基本概念，其實非常簡單，這裡在簡要歸納一下，方便記憶：

伺服器端由C語言實現，而不是用java、PHP這種解釋型語言來實現；伺服器端即時寫入硬碟，因此無需再次呼叫move_uploaded_file、InputStreamReader 這種需要快取的技術來避免伺服器記憶體佔用與瀏覽器請求超時；支援HTML5與IFRAME（針對老瀏覽器），並且支援獲取檔案上傳進度。為了更好的適應當前的移動網際網路，要求對上傳服務支援斷點續傳，斷線重連。因為移動網際網路並不非常穩定；再者，上傳一個大檔案發生異常掉線的可能性非常大，為了避免重新上傳，支援斷點續傳就變得非常必要了。

推薦一個開源免費的 Spring Boot 實戰專案：

https://github.com/javastacks/spring-boot-best-practice

Part2實現思路
支援斷點續傳的思路是：
客戶端（通常是瀏覽器）向伺服器端上傳某個檔案，伺服器端不斷記錄上傳的進度，如果一旦掉線或發生其它異常，客戶端可以向伺服器查詢某個檔案已經上傳的狀態，從上次上傳的檔案位置接著上傳。
網上也有大師採用分片檔案上傳方式來實現大檔案上傳，方法是將檔案切成小片，例如4MB一個片段，伺服器端每次接收一小片檔案儲存成一個臨時檔案，等待所有片段傳輸完畢後，再執行合併。筆者認為，如果原始檔案足夠小，這種方式是可以的，但一旦檔案有幾百兆或者幾個GB或者幾十個GB，則合併檔案的時間會非常長，常常導致瀏覽器響應超時或伺服器阻塞。
如果自己實現獨立客戶端（或瀏覽器的ActiveX外掛）來上傳檔案，則支援斷點續傳將是一件非常簡單的事情，只需在客戶端記錄檔案上傳狀態。而支援瀏覽器斷點續傳（無需安裝第三方外掛）一般來說是要比自己做獨立客戶端上傳難度大一些，但也不難。

我的實現思路如下：
瀏覽器在上傳某個檔案時候，先給這個檔案生成一個HASH值，必須在瀏覽器端生成這個HASH值。

不能單循地依據檔名來查詢檔案上傳記錄，檔名的重複性很大，檔名 + 檔案尺寸組成的值重複性縮小，如果再加上檔案修改時間，則重複性進一步縮小，如果再加上一個瀏覽器的 ID可以進一步縮小重複性衝突。最好的HASH值的計算方法是用檔案的內容進行MD5計算，但計算量極大（其實也沒有必要這麼做），過多的耗時會影響上傳的體驗。

基於上述理由，我的HASH值計算思路如下：

首先給瀏覽器賦予一個ID，這個ID儲存在Cookie裡；
瀏覽器的 ID+ 檔案的修改時間 + 檔名 + 檔案尺寸 的結果進行MD5來計算一個檔案的HASH值；
瀏覽器的ID 是系統在瀏覽器訪問檔案上傳站點時自動給瀏覽器授予的。
//簡單的Cookie幫助函式
function setCookie(cname,cvalue,exdays)
{
var d = new Date();
d.setTime(d.getTime()+(exdays2460601000));
var expires = "expires="+d.toGMTString();
document.cookie = cname + "=" + cvalue + "; " + expires;
}

function getCookie(cname)
{
var name = cname + "=";
var ca = document.cookie.split(';');
for(var i=0; i<ca.length; i++)
{
var c = ca[i].trim();
if (c.indexOf(name)==0) return c.substring(name.length,c.length);
}
return "";
}
//
//簡單的檔案HASH值計算，如果您不是十分考究，應該可以用於產品。
//由於計算檔案HASH值用到了多種資料，因此在HYFileUploader系統範圍內發生HASH衝突的可能性應該非常小，應該可以放心使用。
//獲取檔案的ID可以用任何演算法來實現，只要保證做到同一檔案的ID是相同的即可，獲取的ID長度不要超過32位元組
//
function getFileId (file)
{
//給瀏覽器授予一個唯一的ID用於區分不同的瀏覽器例項（不同機器或者相同機器不同廠家的瀏覽器）
var clientid = getCookie("HUAYIUPLOAD");
if (clientid == "") {
//用一個隨機值來做瀏覽器的ID，將作為檔案HASH值的一部分
var rand = parseInt(Math.random() * 1000);
var t = (new Date()).getTime();
clientid =rand+'T'+t;

setCookie("HUAYIUPLOAD",clientid,365);
}

var info = clientid;
if (file.lastModified)
info += file.lastModified;
if (file.name)
info += file.name;
if (file.size)
info += file.size;
//https://cdn.bootcss.com/blueimp-md5/2.10.0/js/md5.min.js
var fileid = md5(info);
return fileid;
}
筆者認為：不必透過讀取檔案的內容來計算HASH值，這樣會非常慢的。如果確實需要實現HTTP秒傳，可能得這麼做，這樣如果不同的人上傳的檔案內容一致，就可避免重複上傳，直接返回結果即可。

只所以給瀏覽器賦予一個ID，這樣可以進一步避免別的計算機的同名同尺寸檔案的HASH值衝突。

2查詢檔案的HASH值
在檔案上傳支援，先透過檔案的HASH值從上傳伺服器查詢檔案的上傳進度資訊，然後從上傳進度位置開始上傳，程式碼如下：

var fileObj = currentfile;
var fileid = getFileId(fileObj);
var t = (new Date()).getTime();
//透過以下URL獲取檔案的斷點續傳資訊，必須的引數為fileid，後面追加t引數是避免瀏覽器快取
var url = resume_info_url + '?fileid='+fileid + '&t='+t;

var ajax = new XMLHttpRequest();

ajax.onreadystatechange = function () {
if(this.readyState == 4){
if (this.status == 200){
var response = this.responseText;

        var result = JSON.parse(response);
        if (!result) {
            alert('伺服器返回的資料不正確，可能是不相容的伺服器');
            return;
        }
        //斷點續傳資訊返回的檔案物件包含已經上傳的尺寸
        var uploadedBytes = result.file && result.file.size;
        if (!result.file.finished && uploadedBytes < fileObj.size) {
            upload_file(fileObj,uploadedBytes,fileid);
        }
        else {
            //檔案已經上傳完成了，就不要再上傳了，直接返回結果就可以了
            showUploadedFile(result.file);
            //模擬進度完成
            //var progressBar = document.getElementById('progressbar');
            //progressBar.value = 100;
        }
        
    }else {
        alert('獲取檔案斷點續傳資訊失敗');
    }  
}

}

ajax.open('get',url,true);
ajax.send(null);
以上是透過 jQuery-file-upload元件的實現，透過原始Javascript的實現程式碼請參見demos目錄的h4resume.html樣本程式碼。

3執行上傳
在查詢完檔案的斷點續傳資訊後，如果檔案確實以前已經上傳，伺服器將返回已經上傳過的檔案尺寸，我們接著從已經上傳的檔案尺寸位置開始上傳資料即可。

html5的File物件的 slice 可以用於從檔案切取片段來上傳。

定義和用法
slice() 方法可提取字檔案的某個部分，並以新的字串返回被提取的部分。

語法
File.slice(start,end)

引數 描述
start 要抽取的片斷的起始下標。如果是負數，則該引數規定的是從字串的尾部開始算起的位置。也就是說，-1 指字串的最後一個字元，-2 指倒數第二個字元，以此類推。
end 緊接著要抽取的片段的結尾的下標。若未指定此引數，則要提取的子串包括 start 到原字串結尾的字串。如果該引數是負數，那麼它規定的是從字串的尾部開始算起的位置。
實現分片檔案上傳的程式碼如下：
/*
檔案上傳處理程式碼
fileObj : html5 File 物件
start_offset: 上傳的資料相對於檔案頭的起始位置
fileid: 檔案的ID，這個是上面的getFileId 函式獲取的，
*/
function upload_file(fileObj,start_offset,fileid)
{
var xhr = new XMLHttpRequest();
var formData = new FormData();

var blobfile;

if(start_offset >= fileObj.size){
return false;
}

var bitrateDiv = document.getElementById("bitrate");
var finishDiv = document.getElementById("finish");
var progressBar = document.getElementById('progressbar');
var progressDiv = document.getElementById('percent-label');

var oldTimestamp = 0;
var oldLoadsize = 0;
var totalFilesize = fileObj.size;
if (totalFilesize == 0) return;

var uploadProgress = function (evt) {
if (evt.lengthComputable) {
var uploadedSize = evt.loaded + start_offset;
var percentComplete = Math.round(uploadedSize * 100 / totalFilesize);

var timestamp = (new Date()).valueOf();
var isFinish = evt.loaded == evt.total;

if (timestamp > oldTimestamp || isFinish) {
var duration = timestamp - oldTimestamp;
if (duration > 500 || isFinish) {
var size = evt.loaded - oldLoadsize;

var bitrate = (size * 8 / duration /1024) * 1000; //kbps
if (bitrate > 1000)
 bitrate = Math.round(bitrate / 1000) + 'Mbps';
else
 bitrate = Math.round(bitrate) + 'Kbps';

var finish = evt.loaded + start_offset;

if (finish > 1048576)
 finish = (Math.round(finish / (1048576/100)) / 100).toString() + 'MB';
else
 finish = (Math.round(finish / (1024/100) ) / 100).toString() + 'KB';

progressBar.value = percentComplete;
progressDiv.innerHTML = percentComplete.toString() + '%';
bitrateDiv.innerHTML = bitrate;
finishDiv.innerHTML = finish;

oldTimestamp = timestamp;
oldLoadsize = evt.loaded;

}
}
}
else {
progressDiv.innerHTML = 'N/A';
}
}

xhr.onreadystatechange = function(){
if ( xhr.readyState == 4 && xhr.status == 200 ) {
console.log( xhr.responseText );

}

else if (xhr.status == 400) {
}
};
var uploadComplete = function (evt) {
progressDiv.innerHTML = '100%';

var result = JSON.parse(evt.target.responseText);
if (result.result == 'success') {
showUploadedFile(result.files[0]);
}
else {
alert(result.msg);
}
}

var uploadFailed = function (evt) {
alert("上傳檔案失敗！");
}

var uploadCanceled = function (evt) {
alert("上傳被取消或者瀏覽器斷開了連線！");
}

//設定超時時間,由於是上傳大檔案，因此千萬不要設定超時
//xhr.timeout = 20000;
//xhr.ontimeout = function(event){
// alert('檔案上傳時間太長，伺服器在規定的時間內沒有響應！');
//}

xhr.overrideMimeType("application/octet-stream");

var filesize = fileObj.size;
var blob = fileObj.slice(start_offset,filesize);
var fileOfBlob = new File([blob], fileObj.name);
//附加的檔案資料應該放在請求的前面
formData.append('filename', fileObj.name);
//必須將fileid資訊傳送給伺服器，伺服器只有在獲得了fileid資訊後才對檔案做斷點續傳處理
formData.append('fileid', fileid);
//請將檔案資料放在最後的域
//程式碼效果參考：https://www.h3cw.com/sitemap/post.xml
//formData.append("file",blob, fileObj.name);
formData.append('file', fileOfBlob);

xhr.upload.addEventListener("progress", uploadProgress, false);

xhr.addEventListener("load", uploadComplete, false);
xhr.addEventListener("error", uploadFailed, false);
xhr.addEventListener("abort", uploadCanceled, false);
xhr.open('POST', upload_file_url);
//
xhr.send(formData);
}
為了驗證檔案斷點續傳，筆者做了一個簡單的介面，用於顯示檔案上傳的過程中的狀態資訊，介面如下：

透過HTML可以計算檔案上傳的進度，檔案已經上傳的尺寸，檔案上傳的位率等資訊，如果在上傳過程中出現任何異常，則重新上傳即可，已經上傳的部分將不需要重新上傳。

相關文章