HTML5本地儲存Localstorage
什麼是localstorage
前幾天在老專案中發現有對cookie的操作覺得很奇怪，諮詢下來是要快取一些資訊，以避免在URL上面傳遞引數，但沒有考慮過cookie會帶來什麼問題：
① cookie大小限制在4k左右，不適合存業務資料 ② cookie每次隨HTTP事務一起傳送，浪費頻寬
我們是做移動專案的，所以這裡真實適合使用的技術是localstorage，localstorage可以說是對cookie的優化，使用它可以方便在客戶端儲存資料，並且不會隨著HTTP傳輸，但也不是沒有問題：
① localstorage大小限制在500萬字元左右，各個瀏覽器不一致 ② localstorage在隱私模式下不可讀取 ③ localstorage本質是在讀寫檔案，資料多的話會比較卡（firefox會一次性將資料匯入記憶體，想想就覺得嚇人啊） ④ localstorage不能被爬蟲爬取，不要用它完全取代URL傳參
瑕不掩瑜，以上問題皆可避免，所以我們的關注點應該放在如何使用localstorage上，並且是如何正確使用。
localstorage的使用
基礎知識
localstorage儲存物件分為兩種：
① sessionStrage： session即會話的意思，在這裡的session是指使用者瀏覽某個網站時，從進入網站到關閉網站這個時間段，session物件的有效期就只有這麼長。
② localStorage： 將資料儲存在客戶端硬體裝置上，不管它是什麼，意思就是下次開啟計算機時候資料還在。
兩者區別就是一個作為臨時儲存，一個長期儲存。
這裡來一段簡單的程式碼說明其基本使用：
<div id="msg" style="margin: 10px 0; border: 1px solid black; padding: 10px; width: 300px;
height: 100px;">
</div>
<input type="text" id="text" />
<select id="type">
<option value="session">sessionStorage</option>
<option value="local">localStorage</option>
</select>
<button onclick="save();">
儲存資料</button>
<button onclick="load();">
讀取資料</button>
<script type="text/javascript">
var msg = document.getElementById('msg'),
text = document.getElementById('text'),
type = document.getElementById('type');
function save() {
var str = text.value;
var t = type.value;
if (t == 'session') {
sessionStorage.setItem('msg', str);
} else {
localStorage.setItem('msg', str);
}
}
function load() {
var t = type.value;
if (t == 'session') {
msg.innerHTML = sessionStorage.getItem('msg');
} else {
msg.innerHTML = localStorage.getItem('msg');
}
}
</script>
真實場景
實際工作中對localstorage的使用一般有以下需求：
① 快取一般資訊，如搜尋頁的出發城市，達到城市，非實時定位資訊
② 快取城市列表資料，這個資料往往比較大
③ 每條快取資訊需要可追蹤，比如伺服器通知城市資料更新，這個時候在最近一次訪問的時候要自動設定過期
④ 每條資訊具有過期日期狀態，在過期外時間需要由伺服器拉取資料
⑤ ……
define([], function () {
var Storage = _.inherit({
//預設屬性
propertys: function () {
//代理物件，預設為localstorage
this.sProxy = window.localStorage;
//60 * 60 * 24 * 30 * 1000 ms ==30天
this.defaultLifeTime = 2592000000;
//本地快取用以存放所有localstorage鍵值與過期日期的對映
this.keyCache = 'SYSTEM_KEY_TIMEOUT_MAP';
//當快取容量已滿，每次刪除的快取數
this.removeNum = 5;
},
assert: function () {
if (this.sProxy === null) {
throw 'not override sProxy property';
}
},
initialize: function (opts) {
this.propertys();
this.assert();
},
/*
新增localstorage
資料格式包括唯一鍵值，json字串，過期日期，存入日期
sign 為格式化後的請求引數，用於同一請求不同引數時候返回新資料，比如列表為北京的城市，後切換為上海，會判斷tag不同而更新快取資料，tag相當於簽名
每一鍵值只會快取一條資訊
*/
set: function (key, value, timeout, sign) {
var _d = new Date();
//存入日期
var indate = _d.getTime();
//最終儲存的資料
var entity = null;
if (!timeout) {
_d.setTime(_d.getTime() + this.defaultLifeTime);
timeout = _d.getTime();
}
//
this.setKeyCache(key, timeout);
entity = this.buildStorageObj(value, indate, timeout, sign);
try {
this.sProxy.setItem(key, JSON.stringify(entity));
return true;
} catch (e) {
//localstorage寫滿時,全清掉
if (e.name == 'QuotaExceededError') {
// this.sProxy.clear();
//localstorage寫滿時，選擇離過期時間最近的資料刪除，這樣也會有些影響，但是感覺比全清除好些，如果快取過多，此過程比較耗時，100ms以內
if (!this.removeLastCache()) throw '本次資料儲存量過大';
this.set(key, value, timeout, sign);
}
console && console.log(e);
}
return false;
},
//刪除過期快取
removeOverdueCache: function () {
var tmpObj = null, i, len;
var now = new Date().getTime();
//取出鍵值對
var cacheStr = this.sProxy.getItem(this.keyCache);
var cacheMap = [];
var newMap = [];
if (!cacheStr) {
return;
}
cacheMap = JSON.parse(cacheStr);
for (i = 0, len = cacheMap.length; i < len; i++) {
tmpObj = cacheMap[i];
if (tmpObj.timeout < now) {
this.sProxy.removeItem(tmpObj.key);
} else {
newMap.push(tmpObj);
}
}
this.sProxy.setItem(this.keyCache, JSON.stringify(newMap));
},
removeLastCache: function () {
var i, len;
var num = this.removeNum || 5;
//取出鍵值對
var cacheStr = this.sProxy.getItem(this.keyCache);
var cacheMap = [];
var delMap = [];
//說明本次儲存過大
if (!cacheStr) return false;
cacheMap.sort(function (a, b) {
return a.timeout - b.timeout;
});
//刪除了哪些資料
delMap = cacheMap.splice(0, num);
for (i = 0, len = delMap.length; i < len; i++) {
this.sProxy.removeItem(delMap[i].key);
}
this.sProxy.setItem(this.keyCache, JSON.stringify(cacheMap));
return true;
},
setKeyCache: function (key, timeout) {
if (!key || !timeout || timeout < new Date().getTime()) return;
var i, len, tmpObj;
//獲取當前已經快取的鍵值字串
var oldstr = this.sProxy.getItem(this.keyCache);
var oldMap = [];
//當前key是否已經存在
var flag = false;
var obj = {};
obj.key = key;
obj.timeout = timeout;
if (oldstr) {
oldMap = JSON.parse(oldstr);
if (!_.isArray(oldMap)) oldMap = [];
}
for (i = 0, len = oldMap.length; i < len; i++) {
tmpObj = oldMap[i];
if (tmpObj.key == key) {
oldMap[i] = obj;
flag = true;
break;
}
}
if (!flag) oldMap.push(obj);
//最後將新陣列放到快取中
this.sProxy.setItem(this.keyCache, JSON.stringify(oldMap));
},
buildStorageObj: function (value, indate, timeout, sign) {
var obj = {
value: value,
timeout: timeout,
sign: sign,
indate: indate
};
return obj;
},
get: function (key, sign) {
var result, now = new Date().getTime();
try {
result = this.sProxy.getItem(key);
if (!result) return null;
result = JSON.parse(result);
//資料過期
if (result.timeout < now) return null;
//需要驗證簽名
if (sign) {
if (sign === result.sign)
return result.value;
return null;
} else {
return result.value;
}
} catch (e) {
console && console.log(e);
}
return null;
},
//獲取簽名
getSign: function (key) {
var result, sign = null;
try {
result = this.sProxy.getItem(key);
if (result) {
result = JSON.parse(result);
sign = result && result.sign
}
} catch (e) {
console && console.log(e);
}
return sign;
},
remove: function (key) {
return this.sProxy.removeItem(key);
},
clear: function () {
this.sProxy.clear();
}
});
Storage.getInstance = function () {
if (this.instance) {
return this.instance;
} else {
return this.instance = new this();
}
};
return Storage;
});
這段程式碼包含了localstorage的基本操作，並且對以上問題做了處理，而真實的使用還要再抽象：
define(['AbstractStorage'], function (AbstractStorage) {
var Store = _.inherit({
//預設屬性
propertys: function () {
//每個物件一定要具有儲存鍵，並且不能重複
this.key = null;
//預設一條資料的生命週期，S為秒，M為分，D為天
this.lifeTime = '30M';
//預設返回資料
// this.defaultData = null;
//代理物件，localstorage物件
this.sProxy = new AbstractStorage();
},
setOption: function (options) {
_.extend(this, options);
},
assert: function () {
if (this.key === null) {
throw 'not override key property';
}
if (this.sProxy === null) {
throw 'not override sProxy property';
}
},
initialize: function (opts) {
this.propertys();
this.setOption(opts);
this.assert();
},
_getLifeTime: function () {
var timeout = 0;
var str = this.lifeTime;
var unit = str.charAt(str.length - 1);
var num = str.substring(0, str.length - 1);
var Map = {
D: 86400,
H: 3600,
M: 60,
S: 1
};
if (typeof unit == 'string') {
unit = unit.toUpperCase();
}
timeout = num;
if (unit) timeout = Map[unit];
//單位為毫秒
return num * timeout * 1000 ;
},
//快取資料
set: function (value, sign) {
//獲取過期時間
var timeout = new Date();
timeout.setTime(timeout.getTime() + this._getLifeTime());
this.sProxy.set(this.key, value, timeout.getTime(), sign);
},
//設定單個屬性
setAttr: function (name, value, sign) {
var key, obj;
if (_.isObject(name)) {
for (key in name) {
if (name.hasOwnProperty(key)) this.setAttr(k, name[k], value);
}
return;
}
if (!sign) sign = this.getSign();
//獲取當前物件
obj = this.get(sign) || {};
if (!obj) return;
obj[name] = value;
this.set(obj, sign);
},
getSign: function () {
return this.sProxy.getSign(this.key);
},
remove: function () {
this.sProxy.remove(this.key);
},
removeAttr: function (attrName) {
var obj = this.get() || {};
if (obj[attrName]) {
delete obj[attrName];
}
this.set(obj);
},
get: function (sign) {
var result = [], isEmpty = true, a;
var obj = this.sProxy.get(this.key, sign);
var type = typeof obj;
var o = { 'string': true, 'number': true, 'boolean': true };
if (o[type]) return obj;
if (_.isArray(obj)) {
for (var i = 0, len = obj.length; i < len; i++) {
result[i] = obj[i];
}
} else if (_.isObject(obj)) {
result = obj;
}
for (a in result) {
isEmpty = false;
break;
}
return !isEmpty ? result : null;
},
getAttr: function (attrName, tag) {
var obj = this.get(tag);
var attrVal = null;
if (obj) {
attrVal = obj[attrName];
}
return attrVal;
}
});
Store.getInstance = function () {
if (this.instance) {
return this.instance;
} else {
return this.instance = new this();
}
};
return Store;
});
我們真實使用的時候是使用store這個類操作localstorage，程式碼結束簡單測試：
儲存完成，以後都不會走請求，於是今天的程式碼基本結束 ，最後在android Hybrid中有一後退按鈕，此按鈕一旦按下會回到上一個頁面，這個時候裡面的localstorage可能會讀取失效！一個簡單不靠譜的解決方案是在webapp中加入：
window.onunload = function () { };//適合單頁應用，不要問我為什麼，我也不知道
結語
localstorage是移動開發必不可少的技術點，需要深入瞭解，具體業務程式碼後續會放到git上，有興趣的朋友可以去了解
相關文章
- 本地儲存localStorage使用
- web本地儲存（localStorage、sessionStorage）WebSession
- HTML5本地儲存localStorage與sessionStorage詳解HTMLSession
- js—localstorage (本地儲存）必知JS
- 在vue中，localStorage本地儲存應用。Vue
- HTML5 之本地儲存HTML
- H5本地儲存：sessionStorage和localStorageH5Session
- store.js - 輕鬆實現本地儲存（LocalStorage）JS
- 使用LocalStorage實現Form表單內容本地儲存ORM
- HTML5系列：HTML5本地儲存HTML
- Html5 Web的5中離線儲存方式之localStorageHTMLWeb
- JavaScript使用localStorage儲存資料JavaScript
- localStorage設定儲存時間
- localStorage和sessionStorage儲存封裝Session封裝
- 本地儲存
- 前端儲存除了 localStorage 還有啥前端
- JavaScript 本地儲存JavaScript
- web本地儲存Web
- angular 本地儲存Angular
- BOM_資料儲存Cookie& localStorageCookie
- 【HTML5初探之本地儲存】如果沒有資料庫。。。HTML資料庫
- OpenHarmony頁面級UI狀態儲存：LocalStorageUI
- HTML5 web儲存HTMLWeb
- iOS如何本地儲存PHAssetiOS
- (十二)本地儲存及同步
- 聊聊前端的本地儲存前端
- 儲存檔案到本地
- Javascript 本地儲存小結JavaScript
- 瀏覽器本地儲存瀏覽器
- HTML5本地快取localStorage和sessionStorage的操作方法收集HTML快取Session
- 容器化RDS—— 計算儲存分離 or 本地儲存
- html5-web本地儲存HTMLWeb
- flutter本地資料儲存 sqfliteFlutter
- HTML5中的localStorage用法HTML
- 給自己組一個本地儲存
- Javascrip—前端本地儲存講解（16）Java前端
- JavaScript本地儲存（1）：cookie在前端JavaScriptCookie前端
- Java常見的本地儲存方式Java