我想在HTML5 localStorage中存储一个JavaScript对象,但我的对象显然被转换为字符串。

我可以使用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存储规范的误解,而不是浏览器特定的错误或限制。

我已经试图理解2公共基础设施中描述的结构化克隆算法。我不完全理解它的意思,但也许我的问题与对象的财产不可枚举有关(???)。

有简单的解决方法吗?


更新:W3C最终改变了对结构化克隆规范的想法,并决定更改规范以匹配实现。请参阅12111–存储对象getItem(key)方法的规范与实现行为不匹配。因此,这个问题不再100%有效,但答案可能仍然令人感兴趣。


当前回答

另一种选择是使用现有的插件。

例如,persisto是一个开源项目,它为localStorage/sessionStorage提供了一个简单的接口,并自动实现表单字段(输入、单选按钮和复选框)的持久性。

(免责声明:我是作者。)

其他回答

您可以使用ejson将对象存储为字符串。

EJSON是JSON的扩展,以支持更多类型。它支持所有JSON安全类型,以及:日期(JavaScript日期)二进制(JavaScript Uint8Array或EJSON.newBinary的结果)用户定义的类型(请参阅EJSON.addType。例如,Mongo.ObjectID就是这样实现的。)所有EJSON序列化也是有效的JSON。例如,具有日期和二进制缓冲区的对象将在EJSON中序列化为:{“d”:{“$date”:1358205756553},“b”:{“$binary”:“c3VyZS4=”}}

这是我使用ejson的localStorage包装器

https://github.com/UziTech/storage.js

我在包装器中添加了一些类型,包括正则表达式和函数

对变体的一个小改进:

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。如果值为“”(空字符串;JSON.parse()无法处理),它也不会引发SyntaxError异常。

localStorage.setItem('obj',JSON.stringify({name:'Akash'})); // Set Object in localStorage
localStorage.getItem('obj'); // Get Object from localStorage

sessionStorage.setItem('obj',JSON.stringify({name:'Akash'})); // Set Object in sessionStorage
sessionStorage.getItem('obj'); // Get Object from sessionStorage

有一个很棒的库,它封装了许多解决方案,因此它甚至支持称为jStorage的旧浏览器

可以设置对象

$.jStorage.set(key, value)

轻松检索

value = $.jStorage.get(key)
value = $.jStorage.get(key, "default 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()是邪恶的,会导致安全、优化和调试方面的问题。

通常,eval()不应在JavaScript代码中使用。

私人成员

使用JSON.stringify()存储对象的问题是,该函数不能串行化私有成员。

这个问题可以通过重写.toString()方法来解决(在web存储中存储数据时隐式调用):

// 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;
    }
});

然而,找到存储循环引用的有效解决方案高度依赖于需要解决的任务,恢复这样的数据也并非易事。

关于堆栈溢出处理这个问题已经有一些问题:Stringify(转换为JSON)一个具有循环引用的JavaScript对象