基于HTML5 FileSystem API的使用介紹

字號:


    HTML5的強大之一就是允許web程序申請一些臨時或者永久的空間(Quota)在這里可以進行 數(shù)據(jù)的存儲甚至文件的操作。
    FileSystem提供了文件夾和文件的創(chuàng)建、移動、刪除等操作,大大方便了數(shù)據(jù)的本地處理, 而且所有的數(shù)據(jù)都是在沙盒(sandboxed)中,不同的web程序不能互相訪問,這就保證了數(shù)據(jù) 的完整和安全。
    在CatWrite項目中,運用了HTML5的這個特性進行數(shù)據(jù)的存儲,很是方便,只是目前來說只有 Chrome瀏覽器對FileSystem API支持的比較好,所以只能運行在Chrome瀏覽器中。
    在完成這個功能的時候,查閱了很多資料,有一些資料是一年前的,但是隨著瀏覽器版本的 變化,一些代碼已經(jīng)老化,在這里一一總結(jié)和整理。這里只列舉了項目中用到的API,算是 對完成功能的一次梳理。
    申請空間
    為了進行數(shù)據(jù)的存儲,必須要向瀏覽器進行申請,如果是永久存儲還會向用戶進行詢問,只有 同意后才會繼續(xù)執(zhí)行。
    首先必須要聲明想要的權(quán)限。
    代碼如下:
    window.requestFileSystem = window.requestFileSystem || window.webkitRequestFileSystem; //文件系統(tǒng)請求標(biāo)識
    window.resolveLocalFileSystemURL = window.resolveLocalFileSystemURL || window.webkitResolveLocalFileSystemURL; //根據(jù)URL取得文件的讀取權(quán)限
    得到系統(tǒng)的權(quán)限后就可以向瀏覽器申請空間
    代碼如下:
    window.requestFileSystem(window.PERSISTENT, //persistent(永久) or temporary(臨時)
    1024*1024, //1M
    onInitFs, //成功后的回調(diào)函數(shù)
    errorHandler); //錯誤后的回調(diào)函數(shù)
    回調(diào)函數(shù)
    代碼如下:
    function onInitFs(fs){
    fs.root.getDirectory('catwrite_documents', {create: true}, function(dirEntry) {
    console.log('You have just created the ' + dirEntry.name + ' directory.');
    }, errorHandler);
    }
    //錯誤回調(diào)
    function errorHandler(err){
    var msg = 'An error occured: ';
    switch (err.code) {
    case FileError.NOT_FOUND_ERR:
    msg += 'File or directory not found';
    break;
    case FileError.NOT_READABLE_ERR:
    msg += 'File or directory not readable';
    break;
    case FileError.PATH_EXISTS_ERR:
    msg += 'File or directory already exists';
    break;
    case FileError.TYPE_MISMATCH_ERR:
    msg += 'Invalid filetype';
    break;
    default:
    msg += 'Unknown Error';
    break;
    };
    console.log(msg + err);
    }
    如果成功后悔調(diào)用OnInitFs回調(diào)函數(shù),在里面用了getDirectory方法用來創(chuàng)建一個文件夾,這下面再說。
    但是這是有個問題,這樣做的話每次加載頁面都會申請,這肯定不是我們想要的,我們要 的是在有數(shù)據(jù)的時候就可以讀取數(shù)據(jù)。
    判斷是否申請過空間
    所以我們需要讀取瀏覽器的數(shù)據(jù),看看是否已有存儲。這就用到了另一個API:
    代碼如下:
    void queryUsageAndQuota(
    in DOMString url,
    in EntryCallback successCallback,
    in optional ErrorCallback errorCallback
    );
    這個API可以查詢當(dāng)前web的空間情況,如果成功的話就會調(diào)用successCallback回調(diào)函數(shù) 并把已用空間和全部空間作為參數(shù)傳入方法中。如果失敗則調(diào)去errorCallback。
    代碼如下:
    window.webkitStorageInfo.queryUsageAndQuota(webkitStorageInfo.PERSISTENT,
    function(used, remaining){
    if(remaining == ""){
    console.log("未申請空間。");
    }else{
    console.log("已使用空間"+used);
    console.log("全部空間"+remaining);
    }
    },
    errorHandler); </p> <p>
    我們可以通過判斷remaining參數(shù)來判斷是否有申請空間,如果沒有申請,則返回上一步申請空間。 如果已經(jīng)有空間的話,則需要得到空間的跟文件,這樣才能操作數(shù)據(jù)。
    獲取文件入口
    FileSystem使用了特殊的文件系統(tǒng)和沙盒模式,在電腦上或者其他web中是無法訪問沙盒中的文件的 ,只能用對應(yīng)的格式去訪問。
    在瀏覽器中輸入:
    ?filesystem:http://catcoder.com/persistent/
    這樣可以訪問catcoder.com這個網(wǎng)站在本機永久數(shù)據(jù),把persistent換成temporary則是讀取臨時空間。
    然后我們就可以通過URL和對應(yīng)API獲取文件的入口(Lets you look up the entry for a file or directory with a local URL)。
    代碼如下:
    void resolveLocalFileSystemURL(
    in DOMString url,
    in EntryCallback successCallback,
    in optional ErrorCallback errorCallback
    );
    下面就可以讀取本機存儲的數(shù)據(jù)了
    代碼如下:
    var url = "filesystem:http://" + window.location.host + "/persistent/catwrite_documents/";
    window.resolveLocalFileSystemURL(url,function(fileEntry){
    console.log(fileEntry);
    var dirReader = fileEntry.createReader();
    var readEntries = function(){
    dirReader.readEntries(function(results){
    if(!results.length){
    create_file_title("默認文件", "");
    console.log("沒有文件!");
    }else{
    console.log("讀取到" + results.length + "個文件");
    for(var i = 0; i < results.length; i++){
    console.log(results[i].name);
    getFileContentByName(fileEntry, results[i].name);
    }
    }
    },errorHandler);
    };
    readEntries();
    },errorHandler);