在 HTML5 localStorage 中存储对象

我想将 JavaScript 对象存储在 HTML5 localStorage ,但是我的对象显然正在转换为字符串。

我可以使用localStorage存储和检索原始 JavaScript 类型和数组,但是对象似乎无法正常工作。应该吗

这是我的代码:

var testObject = { 'one': 1, 'two': 2, 'three': 3 };
console.log('typeof testObject: ' + typeof testObject);
console.log('testObject properties:');
for (var prop in testObject) {
    console.log('  ' + prop + ': ' + testObject[prop]);
}

// Put the object into storage
localStorage.setItem('testObject', testObject);

// Retrieve the object from storage
var retrievedObject = localStorage.getItem('testObject');

console.log('typeof retrievedObject: ' + typeof retrievedObject);
console.log('Value of retrievedObject: ' + retrievedObject);

控制台输出为

typeof testObject: object
testObject properties:
  one: 1
  two: 2
  three: 3
typeof retrievedObject: string
Value of retrievedObject: [object Object]

在我看来, setItem方法在存储输入之前将输入转换为字符串。

我在 Safari,Chrome 和 Firefox 中看到了这种行为,因此我认为这是我对HTML5 Web 存储规范的误解,而不是浏览器特定的错误或限制。

我试图弄清http://www.w3.org/TR/html5/infrastructure.html 中描述的结构化克隆算法。我不完全明白这是什么意思,但也许我的问题与我的对象的属性不可枚举有关(???)

有一个简单的解决方法吗?


更新:W3C 最终改变了对结构化克隆规范的想法,并决定更改规范以匹配实现。参见https://www.w3.org/Bugs/Public/show_bug.cgi?id=12111 。因此,此问题不再 100%有效,但答案可能仍然很有趣。

答案

再次查看AppleMozillaMozilla文档,该功能似乎仅限于处理字符串键 / 值对。

一种解决方法是在存储对象之前先对其进行字符串化 ,然后在检索它时对其进行解析:

var testObject = { 'one': 1, 'two': 2, 'three': 3 };

// Put the object into storage
localStorage.setItem('testObject', JSON.stringify(testObject));

// Retrieve the object from storage
var retrievedObject = localStorage.getItem('testObject');

console.log('retrievedObject: ', JSON.parse(retrievedObject));

变体的小改进:

Storage.prototype.setObject = function(key, value) {
    this.setItem(key, JSON.stringify(value));
}

Storage.prototype.getObject = function(key) {
    var value = this.getItem(key);
    return value && JSON.parse(value);
}

由于短路评估 ,如果key不在 Storage 中,则getObject()立即返回null 。如果value"" (空字符串; JSON.parse()无法处理),它也不会引发SyntaxError异常。

您可能会发现使用以下方便的方法扩展 Storage 对象很有用:

Storage.prototype.setObject = function(key, value) {
    this.setItem(key, JSON.stringify(value));
}

Storage.prototype.getObject = function(key) {
    return JSON.parse(this.getItem(key));
}

这样,即使在 API 下仅支持字符串,您也可以获得真正想要的功能。

扩展存储对象是一个了不起的解决方案。对于我的 API,我为 localStorage 创建了一个 Facade,然后在设置和获取时检查它是否为对象。

var data = {
  set: function(key, value) {
    if (!key || !value) {return;}

    if (typeof value === "object") {
      value = JSON.stringify(value);
    }
    localStorage.setItem(key, value);
  },
  get: function(key) {
    var value = localStorage.getItem(key);

    if (!value) {return;}

    // assume it is an object that has been stringified
    if (value[0] === "{") {
      value = JSON.parse(value);
    }

    return value;
  }
}

Stringify 不能解决所有问题

似乎这里的答案并未涵盖 JavaScript 中所有可能的类型,因此以下是一些有关如何正确处理它们的简短示例:

//Objects and Arrays:
    var obj = {key: "value"};
    localStorage.object = JSON.stringify(obj);  //Will ignore private members
    obj = JSON.parse(localStorage.object);
//Boolean:
    var bool = false;
    localStorage.bool = bool;
    bool = (localStorage.bool === "true");
//Numbers:
    var num = 42;
    localStorage.num = num;
    num = +localStorage.num;    //short for "num = parseFloat(localStorage.num);"
//Dates:
    var date = Date.now();
    localStorage.date = date;
    date = new Date(parseInt(localStorage.date));
//Regular expressions:
    var regex = /^No\.[\d]*$/i;     //usage example: "No.42".match(regex);
    localStorage.regex = regex;
    var components = localStorage.regex.match("^/(.*)/([a-z]*)$");
    regex = new RegExp(components[1], components[2]);
//Functions (not recommended):
    function func(){}
    localStorage.func = func;
    eval( localStorage.func );      //recreates the function with the name "func"

我不建议存储函数,因为eval()是邪恶的,可能导致有关安全性,优化和调试的问题。通常,不应在 JavaScript 代码中使用eval()

私人会员

使用JSON.stringify()存储对象的问题是,此函数无法序列化私有成员。可以通过覆盖.toString()方法(在 Web 存储中存储数据时隐式调用.toString()解决此问题:

//Object with private and public members:
    function MyClass(privateContent, publicContent){
        var privateMember = privateContent || "defaultPrivateValue";
        this.publicMember = publicContent  || "defaultPublicValue";

        this.toString = function(){
            return '{"private": "' + privateMember + '", "public": "' + this.publicMember + '"}';
        };
    }
    MyClass.fromString = function(serialisedString){
        var properties = JSON.parse(serialisedString || "{}");
        return new MyClass( properties.private, properties.public );
    };
//Storing:
    var obj = new MyClass("invisible", "visible");
    localStorage.object = obj;
//Loading:
    obj = MyClass.fromString(localStorage.object);

循环参考

stringify无法处理的另一个问题是循环引用:

var obj = {};
obj["circular"] = obj;
localStorage.object = JSON.stringify(obj);  //Fails

在此示例中, JSON.stringify()将引发TypeError “将圆形结构转换为 JSON” 。如果应该支持存储循环引用,则可以使用JSON.stringify()的第二个参数:

var obj = {id: 1, sub: {}};
obj.sub["circular"] = obj;
localStorage.object = JSON.stringify( obj, function( key, value) {
    if( key == 'circular') {
        return "$ref"+value.id+"$";
    } else {
        return value;
    }
});

但是,找到一种有效的解决方案来存储循环引用在很大程度上取决于需要解决的任务,并且恢复此类数据也不是一件容易的事。

因此,已经有一些关于 SO 处理此问题的问题: Stringify(转换为 JSON)具有循环引用的 JavaScript 对象

有一个很棒的库,其中包含许多解决方案,因此它甚至支持名为jStorage 的旧版浏览器。

您可以设置一个对象

$.jStorage.set(key, value)

并轻松检索

value = $.jStorage.get(key)
value = $.jStorage.get(key, "default value")

从理论上讲,可以存储具有以下功能的对象:

function store (a)
{
  var c = {f: {}, d: {}};
  for (var k in a)
  {
    if (a.hasOwnProperty(k) && typeof a[k] === 'function')
    {
      c.f[k] = encodeURIComponent(a[k]);
    }
  }

  c.d = a;
  var data = JSON.stringify(c);
  window.localStorage.setItem('CODE', data);
}

function restore ()
{
  var data = window.localStorage.getItem('CODE');
  data = JSON.parse(data);
  var b = data.d;

  for (var k in data.f)
  {
    if (data.f.hasOwnProperty(k))
    {
      b[k] = eval("(" + decodeURIComponent(data.f[k]) + ")");
    }
  }

  return b;
}

但是,函数序列化 / 反序列化是不可靠的,因为它依赖于实现

在碰到另一篇已与此副本重复的帖子之后,我到达了这篇文章。这篇文章的标题为 “如何在本地存储中存储数组?”。很好,除非两个线程都不能真正提供有关如何在 localStorage 中维护阵列的完整答案 - 但是我设法根据两个线程中包含的信息制定了一个解决方案。

因此,如果其他任何人都希望能够推送 / 弹出 / 移动数组中的项目,并且他们想要将该数组存储在 localStorage 或实际上是 sessionStorage 中,则可以执行以下操作:

Storage.prototype.getArray = function(arrayName) {
  var thisArray = [];
  var fetchArrayObject = this.getItem(arrayName);
  if (typeof fetchArrayObject !== 'undefined') {
    if (fetchArrayObject !== null) { thisArray = JSON.parse(fetchArrayObject); }
  }
  return thisArray;
}

Storage.prototype.pushArrayItem = function(arrayName,arrayItem) {
  var existingArray = this.getArray(arrayName);
  existingArray.push(arrayItem);
  this.setItem(arrayName,JSON.stringify(existingArray));
}

Storage.prototype.popArrayItem = function(arrayName) {
  var arrayItem = {};
  var existingArray = this.getArray(arrayName);
  if (existingArray.length > 0) {
    arrayItem = existingArray.pop();
    this.setItem(arrayName,JSON.stringify(existingArray));
  }
  return arrayItem;
}

Storage.prototype.shiftArrayItem = function(arrayName) {
  var arrayItem = {};
  var existingArray = this.getArray(arrayName);
  if (existingArray.length > 0) {
    arrayItem = existingArray.shift();
    this.setItem(arrayName,JSON.stringify(existingArray));
  }
  return arrayItem;
}

Storage.prototype.unshiftArrayItem = function(arrayName,arrayItem) {
  var existingArray = this.getArray(arrayName);
  existingArray.unshift(arrayItem);
  this.setItem(arrayName,JSON.stringify(existingArray));
}

Storage.prototype.deleteArray = function(arrayName) {
  this.removeItem(arrayName);
}

用法示例 - 将简单字符串存储在 localStorage 数组中:

localStorage.pushArrayItem('myArray','item one');
localStorage.pushArrayItem('myArray','item two');

用法示例 - 将对象存储在 sessionStorage 数组中:

var item1 = {}; item1.name = 'fred'; item1.age = 48;
sessionStorage.pushArrayItem('myArray',item1);

var item2 = {}; item2.name = 'dave'; item2.age = 22;
sessionStorage.pushArrayItem('myArray',item2);

操纵数组的常用方法:

.pushArrayItem(arrayName,arrayItem); -> adds an element onto end of named array
.unshiftArrayItem(arrayName,arrayItem); -> adds an element onto front of named array
.popArrayItem(arrayName); -> removes & returns last array element
.shiftArrayItem(arrayName); -> removes & returns first array element
.getArray(arrayName); -> returns entire array
.deleteArray(arrayName); -> removes entire array from storage

建议使用抽象库来实现此处讨论的许多功能以及更好的兼容性。很多选择:

您可以使用localDataStorage透明地存储 javascript 数据类型(数组,布尔值,日期,浮点数,整数,字符串和对象)。它还提供轻量级的数据混淆,自动压缩字符串,方便按键(名称)查询和按(键)值查询,并通过在键之前添加前缀来帮助在同一域中强制执行分段共享存储。

[免责声明] 我是实用程序 [/ 免责声明] 的作者

例子:

localDataStorage.set( 'key1', 'Belgian' )
localDataStorage.set( 'key2', 1200.0047 )
localDataStorage.set( 'key3', true )
localDataStorage.set( 'key4', { 'RSK' : [1,'3',5,'7',9] } )
localDataStorage.set( 'key5', null )

localDataStorage.get( 'key1' )   -->   'Belgian'
localDataStorage.get( 'key2' )   -->   1200.0047
localDataStorage.get( 'key3' )   -->   true
localDataStorage.get( 'key4' )   -->   Object {RSK: Array(5)}
localDataStorage.get( 'key5' )   -->   null

如您所见,原始值受到尊重。