摘要：表示備份過程正常，否則備份過程有錯誤。此時請求不走緩存系統。升級流程圖離線資源緩存使用緩存時機只針對的以為主域名的請求進行攔截，然后根據請求鏈接，找到具體文件緩存。

背景

接口格式

離線資源包格式

離線資源下發

離線資源緩存

由于線上樂刻客戶端 App 第一次打開平臺 H5 需要幾秒的加載時間，這個體驗對用戶來說并不友好，為了讓用戶跳轉 H5 和跳轉到原生一樣的用戶體驗，就需要把 H5 相關的離線資源包下發給客戶端，客戶端就可以使用離線資源來代替實際網絡請求，節省用戶等待時間和流量消耗。并且隨著業務的發展，不同的業務升級進度不一樣，就需要 App 支持模塊化升級。

offlineResourceInfo 接口請求方法: POST

offlineResourceInfo 接口請求參數:

Json 形式：

{
    //"appVersion": "2.4.0", 可以去掉，因為請求頭會包含
    "resourceversionList": [{
        "name": "m",
        "version": "1.0.0"
    },{
        "name": "coach",
        "version": "1.0.0"
    },{
        "name": "activity",
        "version": "1.0.0"
    }]
}

Form 表單形式：

resourceNames=m,coach,activity&resourceVersions=1.0.0,1.0.0,1.0.0

offlineResourceInfo 接口返回結構體:

{
    "data": {
        "resourceList": [{
                "name": "m",
                "version": "1.0.1",
                "url": "http://cdn.xxx.com/resource/m/m_update_1.0.0_1.0.1.zip",
                "md5": "a4d7feecbcae8e2ccba3b5ba90aa8a83",
                "isfull": false
            },{
                "name": "coach",
                "version": "1.0.1",
                "url":  "http://cdn.xxx.com/resource/coach/coach_full_1.0.1.zip",
                "md5": "a4d7feecbcae8e2ccba3b5ba90aa8a83",
                "isfull": true
            }
        ]
    }
}

參數說明：

"name": 模塊名
"version": 升級版本
"url": 資源包下載地址
"md5": 資源包 md5
"isfull": 是否是全量升級包

增量和全量升級包擁有同樣的結構，包含 config.json 文件和資源文件。

config.json 格式如下，version 記錄的是下發的資源版本號，validate 記錄的是所有文件的路勁和相應的 md5 hash 值。

{
    "version": "1.0.1",
    "validate": [{
       "path": "528/app.min.cs",
       "md5": "md5($cssFileContent)"
    },{
       "path": "528/app.min.js",
       "md5": "md5($jsFileContent)"
    }]
}

具體的資源與 config.json 平級。

--[528]
----app.min.css
----app.min.js

App 啟動時設置定時器定時器-> wifi 環境下 -> 請求服務器接口獲取 offlineResourceinfo 接口 response，根據resourceList 的結果來決定是否需要更新，需要更新的模塊可以下載 zip 文件

按模塊目錄存放資源包。其中目錄 moduleszip 用于存放資源壓縮包的路徑，目錄 modules 用于存放解壓后的壓縮包路徑。

所以每次請求 offlineResourceInfo 接口的時候，也需要遍歷所有模塊目錄下的 config.json 去獲取資源版本號。所以第一次請求的話，由于本地目錄是空的，對于接口 offlineResourceInfo 的參數 resourceversionList 也是空的。

--[offlineResource]
----[moduleszip]
------[m]
--------[zip]
----------m.update.1.0.0_1.0.1.zip
----------m.full.1.0.1.zip
--------[temp] 解壓臨時目錄
--------[backup] 原有資源備份目錄

------[coach]
--------[zip]
----------coach.update.1.0.0_1.0.1.zip
----------coach.full.1.0.1.zip
--------[temp] 解壓臨時目錄
--------[backup] 原有資源備份目錄

----[modules]
------[m]
--------config.json
--------其他資源文件

------[coach]
--------config.json
--------其他資源文件

----[modulesflag]
------[m]
--------flag.json

------[coach]
--------flag.json

當下載完資源包，解壓之前需要根據接口返回的 md5 值來校驗資源包的合法性。

校驗子文件過程：需要結合 config.json 和資源來校驗每個文件的合法性，如果不合法，就不添加該資源文件 就不保留整個資源包。

增量更新：文件的替換和增加。而且需要合并新老 config.json。
全量更新：覆蓋模塊目錄。

模塊資源包更新之前，需要先備份之前的模塊資源。例如：拷貝目錄 offlineResource/modules/m 到目錄offlineResource/moduleszip/m/backup 來進行備份。

需要設置標志位，并持久化到 flag.json:

{
    "doingUpgradeFlag": false, // false, 表示升級過程正常，否則升級過程有錯誤。
    "doingBackupFlag": false // false, 表示備份過程正常，否則備份過程有錯誤。
}

正在升級標志位 (總標志位)

正在備份標志位 (是正在升級標志位的一個子集)

正在升級的過程包括， md5 校驗資源包，md5 校驗每個資源文件，備份和更新過程。

如果整個升級過程中發生普通錯誤，恢復所有標志位，然后結束升級流程。

如果整個升級過程中發生崩潰或者被殺掉進程，App 再次啟動后。此時 正在升級標志位 沒有復位 (升級失敗)，有以下幾種情況需要做容錯處理:

如果 正在備份標志位 也沒有復位 (備份失敗)，此時并不會影響目標模塊資源，直接恢復所有標志位。

如果 正在備份標志位 已經復位 (備份成功)，先清空目標模塊資源，然后做回滾操作：

回滾成功，直接復位所有標志位。

回滾失敗，先清空目標模塊資源：

正常失敗，恢復所有標志位。

App 崩潰或被殺掉進程，Nothing To Do.

當 正在升級標志位 沒有復位時。此時 App webview 請求不走緩存系統。
否則 App webview 可以繼續使用緩存系統。

只針對 webview 的以 xxx.com 為主域名的請求進行攔截，然后根據請求鏈接，找到具體文件緩存。

找具體文件緩存的方式：

遍歷所有模塊下的 config.json 文件，看能否找到具體的資源文件。這樣效率會比較慢，但是更適合現有的場景。

根據鏈接的一級路徑找到對應模塊下的 config.json 文件，看能否找到具體的資源文件。這樣效率會比較高，但是目前鏈接的一級路徑并不規范。

直接根據請求 URL 的 PATH 去本地查找是否存在具體的資源文件。PATH 的一級路徑代表模塊名，剩余部分代表資源路徑。

App 這里會使用第二種方式去找緩存文件，這樣的話就需要前端小伙伴規范鏈接路徑。

拿到緩存文件之后，需要再次校驗緩存文件的合法性，合法則使用緩存，不合法就需要下面的容錯處理。

如果找到的緩存文件已經損壞或者不存在（解壓過程被中斷，殺掉進程或者 crash），此時需要繼續走網絡，并且把網絡結果進行 md5 校驗，如果合法，需要把該結果保存到緩存系統，如果不合法，不做處理。