目錄
- 背景
- 接口格式
- 離線資源包格式
- 離線資源下發(fā)
- 離線資源緩存
背景
由于線上樂刻客戶端 App 第一次打開平臺 H5 需要幾秒的加載時間，這個體驗(yàn)對用戶來說并不友好，為了讓用戶跳轉(zhuǎn) H5 和跳轉(zhuǎn)到原生一樣的用戶體驗(yàn)，就需要把 H5 相關(guān)的離線資源包下發(fā)給客戶端，客戶端就可以使用離線資源來代替實(shí)際網(wǎng)絡(luò)請求，節(jié)省用戶等待時間和流量消耗。并且隨著業(yè)務(wù)的發(fā)展，不同的業(yè)務(wù)升級進(jìn)度不一樣，就需要 App 支持模塊化升級。
接口格式
offlineResourceInfo 接口請求方法: POST
offlineResourceInfo 接口請求參數(shù):
Json 形式：
{
//"appVersion": "2.4.0", 可以去掉，因?yàn)檎埱箢^會包含
"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 接口返回結(jié)構(gòu)體:
{
"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
}
]
}
}
參數(shù)說明：
"name": 模塊名
"version": 升級版本
"url": 資源包下載地址
"md5": 資源包 md5
"isfull": 是否是全量升級包
離線資源包格式
增量和全量升級包擁有同樣的結(jié)構(gòu)，包含 config.json 文件和資源文件。
config.json 格式如下，version 記錄的是下發(fā)的資源版本號，validate 記錄的是所有文件的路勁和相應(yīng)的 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
離線資源下發(fā)
下發(fā)時機(jī)
App 啟動時設(shè)置定時器定時器-> wifi 環(huán)境下 -> 請求服務(wù)器接口獲取 offlineResourceinfo 接口 response，根據(jù)resourceList 的結(jié)果來決定是否需要更新，需要更新的模塊可以下載 zip 文件
資源包存放目錄
按模塊目錄存放資源包。其中目錄 moduleszip 用于存放資源壓縮包的路徑，目錄 modules 用于存放解壓后的壓縮包路徑。
所以每次請求 offlineResourceInfo 接口的時候，也需要遍歷所有模塊目錄下的 config.json 去獲取資源版本號。所以第一次請求的話，由于本地目錄是空的，對于接口 offlineResourceInfo 的參數(shù) 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
資源包解壓
解壓
當(dāng)下載完資源包，解壓之前需要根據(jù)接口返回的 md5 值來校驗(yàn)資源包的合法性。
校驗(yàn)子文件過程：需要結(jié)合 config.json 和資源來校驗(yàn)每個文件的合法性，如果不合法，就不添加該資源文件 就不保留整個資源包。
更新資源
增量更新：文件的替換和增加。而且需要合并新老 config.json。
全量更新：覆蓋模塊目錄。
模塊資源包更新之前，需要先備份之前的模塊資源。例如：拷貝目錄 offlineResource/modules/m 到目錄offlineResource/moduleszip/m/backup 來進(jìn)行備份。
容錯處理
需要設(shè)置標(biāo)志位，并持久化到 flag.json:
{
"doingUpgradeFlag": false, // false, 表示升級過程正常，否則升級過程有錯誤。
"doingBackupFlag": false // false, 表示備份過程正常，否則備份過程有錯誤。
}
- 正在升級標(biāo)志位 (總標(biāo)志位)
- 正在備份標(biāo)志位 (是正在升級標(biāo)志位的一個子集)
正在升級的過程包括， md5 校驗(yàn)資源包，md5 校驗(yàn)每個資源文件，備份和更新過程。
如果整個升級過程中發(fā)生普通錯誤，恢復(fù)所有標(biāo)志位，然后結(jié)束升級流程。
如果整個升級過程中發(fā)生崩潰或者被殺掉進(jìn)程，App 再次啟動后。此時 正在升級標(biāo)志位 沒有復(fù)位 (升級失敗)，有以下幾種情況需要做容錯處理:
- 如果
正在備份標(biāo)志位也沒有復(fù)位 (備份失敗)，此時并不會影響目標(biāo)模塊資源，直接恢復(fù)所有標(biāo)志位。 - 如果
正在備份標(biāo)志位已經(jīng)復(fù)位 (備份成功)，先清空目標(biāo)模塊資源，然后做回滾操作：- 回滾成功，直接復(fù)位所有標(biāo)志位。
- 回滾失敗，先清空目標(biāo)模塊資源：
- 正常失敗，恢復(fù)所有標(biāo)志位。
- App 崩潰或被殺掉進(jìn)程，Nothing To Do.
容錯副作用
當(dāng) 正在升級標(biāo)志位 沒有復(fù)位時。此時 App webview 請求不走緩存系統(tǒng)。
否則 App webview 可以繼續(xù)使用緩存系統(tǒng)。
升級流程圖
離線資源緩存
使用緩存時機(jī)
只針對 webview 的以 xxx.com 為主域名的請求進(jìn)行攔截，然后根據(jù)請求鏈接，找到具體文件緩存。
找具體文件緩存的方式：
- 遍歷所有模塊下的
config.json文件，看能否找到具體的資源文件。這樣效率會比較慢，但是更適合現(xiàn)有的場景。根據(jù)鏈接的一級路徑找到對應(yīng)模塊下的config.json文件，看能否找到具體的資源文件。這樣效率會比較高，但是目前鏈接的一級路徑并不規(guī)范。- 直接根據(jù)請求
URL的PATH去本地查找是否存在具體的資源文件。PATH的一級路徑代表模塊名，剩余部分代表資源路徑。
App 這里會使用第二種方式去找緩存文件，這樣的話就需要前端小伙伴規(guī)范鏈接路徑。
拿到緩存文件之后，需要再次校驗(yàn)緩存文件的合法性，合法則使用緩存，不合法就需要下面的容錯處理。
使用緩存容錯處理
如果找到的緩存文件已經(jīng)損壞或者不存在（解壓過程被中斷，殺掉進(jìn)程或者 crash），此時需要繼續(xù)走網(wǎng)絡(luò)，并且把網(wǎng)絡(luò)結(jié)果進(jìn)行 md5 校驗(yàn)，如果合法，需要把該結(jié)果保存到緩存系統(tǒng)，如果不合法，不做處理。
