我想在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%有效,但答案可能仍然令人感兴趣。


当前回答

对于愿意设置和获取类型化财产的TypeScript用户:

/**
 * Silly wrapper to be able to type the storage keys
 */
export class TypedStorage<T> {

    public removeItem(key: keyof T): void {
        localStorage.removeItem(key);
    }

    public getItem<K extends keyof T>(key: K): T[K] | null {
        const data: string | null =  localStorage.getItem(key);
        return JSON.parse(data);
    }

    public setItem<K extends keyof T>(key: K, value: T[K]): void {
        const data: string = JSON.stringify(value);
        localStorage.setItem(key, data);
    }
}

示例用法:

// write an interface for the storage
interface MyStore {
   age: number,
   name: string,
   address: {city:string}
}

const storage: TypedStorage<MyStore> = new TypedStorage<MyStore>();

storage.setItem("wrong key", ""); // error unknown key
storage.setItem("age", "hello"); // error, age should be number
storage.setItem("address", {city:"Here"}); // ok

const address: {city:string} = storage.getItem("address");

其他回答

为Storage对象创建外观是一个很棒的解决方案。这样,您就可以实现自己的get和set方法。对于我的API,我为localStorage创建了一个外观,然后在设置和获取时检查它是否是一个对象。

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

循环引用

在这个答案中,我专注于具有循环引用的仅数据对象(没有函数等),并开发maja和mathheadinclouds提到的想法(我使用了他的测试用例和我的代码短了几倍)。

实际上,我们可以使用带有适当替换符的JSON.stringify-如果源对象包含对某个对象的多个引用,或者包含循环引用,那么我们可以通过特殊路径字符串(类似于JSONPath)来引用它。

//JSON.strify具有circ-ref的对象的替换器函数refReplacer(){设m=new Map(),v=new Map),init=null;返回函数(字段,值){让p=m.get(this)+(Array.isArray(this)`[${field}]“:”.“+字段);让isComplex=value==对象(值)如果(isComplex)m.set(值,p);让pp=v.get(value)||'';let path=p.replace(/未定义\.\?/,“”);让val=pp`#REF:${pp[0]==“[”?“$”:“$.”}${pp}“:value;!初始化?(init=value):(val===init?val=“#REF:$”:0);if(!pp&&isComplex)v.set(value,path);返回值;}}// ---------------//测试// ---------------//生成具有重复/循环引用的obj让obj={我:{五十: {v:“lorem”},R: {v:“ipsum”}},R:{五十: {v:“dolor”},R:{五十: {v:“坐”},R: {v:“amet”}}}}obj.R.L.uncle=对象L;obj.R..uncle=对象L;obj.R.L..uncle=obj.R.L;obj.R.R..uncle=obj.R.L;obj.L.L.uncle=对象R;obj.L.R.unncle=对象R;testObject=obj;让json=json.stringify(testObject,refReplacer(),4);console.log(“测试对象\n”,testObject);console.log(“带有JSONpath引用的JSON”,JSON);

使用类似JSONpath的引用解析此类JSON内容:

//使用对象的JSONpath引用解析JSON内容函数parseRefJSON(json){let objToPath=新映射();let pathToObj=新映射();let o=JSON.parse(JSON);让遍历=(父级,字段)=>{让obj=父级;let path=“#REF:$”;if(字段!==未定义){obj=父[字段];path=objToPath.get(父)+(Array.isArray(父)`[${field}]`:`${field?'。'+字段:''}`);}objToPath.set(obj,路径);pathToObj.set(路径,对象);let ref=路径目标获取(obj);如果(ref)父[字段]=ref;for(让f在obj中)if(obj==对象(obj))遍历(obj,f);}横向(o);返回o;}// ---------------//测试1// ---------------让json=`{“L”:{“L”:{“v”:“lorem”,“叔叔”:{“L”:{“v”:“dolor”,“叔叔”:“#REF:$.L”},“R”:{“L”:{“v”:“坐”,“叔叔”:“#REF:$.L.L叔叔.L”},“R”:{“v”:“amet”,“叔叔”:“#REF:$.L.L叔叔.L”},“叔叔”:“#REF:$.L”}}},“R”:{“v”:“ipsum”,“叔叔”:“#REF:$.L.L叔叔”}},“R”:“#REF:$.L.L叔叔”}`;let testObject=parseRefJSON(json);console.log(“测试对象\n”,testObject);// ---------------//测试2// ---------------console.log('来自mathheadinclouds的测试答案:');let recovered=测试对象;let obj={//原始对象我:{五十: {v:“lorem”},R: {v:“ipsum”}},R:{五十: {v:“dolor”},R:{五十: {v:“坐”},R: {v:“amet”}}}}obj.R.L.uncle=对象L;obj.R..uncle=对象L;obj.R.L..uncle=obj.R.L;obj.R.R..uncle=obj.R.L;obj.L.L.uncle=对象R;obj.L.R.unncle=对象R;[目标L.L.v===恢复L.L.v,目标L.R.v===恢复L.R.v,目标R.L.v===恢复的R.L.v,目标R.R.L.v===恢复的R.R.L.v,obj.R.R.R.v===恢复的R.R.R.v,obj.R.L.包含==obj.L,对象.R.R.uncle==对象L,obj.R.L.包含==obj.R.L,obj.R.R.包含==obj.R.L,对象.L.L.uncle==对象R,obj.L.R.包含==obj.R,recovered.R.L叔叔==已恢复.L,恢复.R.R.叔叔==恢复.L,恢复.R.R.L叔叔==恢复.R.L,恢复.R.R.R.叔叔==恢复.R.L,recovered.L.L叔叔==恢复。R,已恢复.L.R叔叔==已恢复.R].forEach(x=>console.log('测试通过:'+x));

要将生成的JSON内容加载/保存到存储中,请使用以下代码:

localStorage.myObject = JSON.stringify(testObject, refReplacer());  // Save
testObject = parseRefJSON(localStorage.myObject);                   // Load

这个问题已经从仅JavaScript的角度得到了充分的回答,其他人已经注意到localStorage.getItem和localStorage.setItem都没有对象的概念,它们只处理字符串和字符串。这个答案提供了一个TypeScript友好的解决方案,它结合了其他人在纯JavaScript解决方案中的建议。

TypeScript 4.2.3

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

Storage.prototype.getObject = function (key: string) {
  const value = this.getItem(key);
  if (!value) {
    return null;
  }

  return JSON.parse(value);
};

declare global {
  interface Storage {
    setObject: (key: string, value: unknown) => void;
    getObject: (key: string) => unknown;
  }
}

用法

localStorage.setObject('ages', [23, 18, 33, 22, 58]);
localStorage.getObject('ages');

解释

我们在Storage原型上声明setObject和getObject函数,localStorage就是这种类型的实例。除了getObject中的空处理之外,我们真的没有什么特别需要注意的。由于getItem可以返回null,我们必须提前退出,因为对null值调用JSON.parse将引发运行时异常。

在存储原型上声明函数之后,我们将其类型定义包含在全局命名空间中的存储类型上。

注意:如果我们用箭头函数定义这些函数,我们需要假设我们调用的存储对象总是localStorage,这可能不是真的。例如,上述代码还将向sessionStorage添加setObject和getObject支持。

https://github.com/adrianmay/rhaboo是一个localStorage糖层,允许您编写如下内容:

var store = Rhaboo.persistent('Some name');
store.write('count', store.count ? store.count+1 : 1);
store.write('somethingfancy', {
  one: ['man', 'went'],
  2: 'mow',
  went: [  2, { mow: ['a', 'meadow' ] }, {}  ]
});
store.somethingfancy.went[1].mow.write(1, 'lawn');

它不使用JSON.stringify/parse,因为这对于大型对象来说是不准确和缓慢的。相反,每个终端值都有自己的localStorage条目。

你可能会猜到我可能和rhaboo有关系。

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对象