题 在HTML5 localStorage中存储对象


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

我可以使用存储和检索原始JavaScript类型和数组 localStorage,但对象似乎不起作用。他们应该吗?

这是我的代码:

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网络存储 spec,不是特定于浏览器的错误或限制。

我试图理解这个 结构化克隆 算法描述于 http://www.w3.org/TR/html5/infrastructure.html。我不完全理解它的含义,但也许我的问题与我的对象的属性不可枚举(???)

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


更新:W3C最终改变了对结构化克隆规范的看法,并决定更改规范以匹配实现。看到 https://www.w3.org/Bugs/Public/show_bug.cgi?id=12111。所以这个问题不再是100%有效,但答案仍然可能是有意义的。


2057
2018-01-06 04:05


起源


顺便说一句,你对“结构化克隆算法”的阅读是正确的,只是在实现完成后,规范从仅字符串值更改为此。我提交了bug bugzilla.mozilla.org/show_bug.cgi?id=538142 与mozilla一起追踪这个问题。 - Nickolay
这似乎是indexedDB的一项工作...... - markasoftware
如何在localStorage中存储一个对象数组?我面临同样的问题,它正在转换为字符串。 - Jayant Pareek
你可以改为序列化数组吗?喜欢使用JSON stringify的商店然后在加载时再次解析? - Brandito
您可以使用 localDataStorage 透明地存储javascript数据类型(Array,Boolean,Date,Float,Integer,String和Object) - Mac


答案:


看着 苹果Mozilla的 和 微软 文档,功能似乎仅限于处理字符串键/值对。

解决方法可以是 字符串化 您的对象在存储之前,稍后在检索它时解析它:

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

2654
2018-01-06 04:25



请注意,将删除任何元数据。你只需要一个带有键值对的对象,所以任何有行为的对象都需要重建。 - oligofren
@CMS如果数据超出容量,setItem会抛出一些异常吗? - Ashish Negi
...仅适用于带圆形引用的对象, JSON.stringify() 将引用的对象扩展为我们stringify对象中的完整“内容”(隐式字符串化)。看到: stackoverflow.com/a/12659424/2044940 - CoDEmanX
如果您必须处理大型数组或对象,则此方法的问题是性能问题。 - Monkey King
@oligofren是真的,但是 玛雅 正确建议eval()=>,这是一个很好的使用,你可以轻松检索功能代码=>将其存储为字符串然后eval()它回来:) - jave.web


一个小小的改进 变种

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

因为 短路评估getObject() 将 立即 返回 null 如果 key 不在存储中。它也不会抛出 SyntaxError 异常如果 value 是 "" (空字符串; JSON.parse() 无法处理)。


563
2018-06-30 06:45



我只想快速添加用法,因为它对我来说不是很清楚: var userObject = { userId: 24, name: 'Jack Bauer' };  并设置它localStorage.setObject('user', userObject);  然后从存储中取回它userObject = localStorage.getObject('user');  如果需要,您甚至可以存储一组对象。 - zuallauz
它只是布尔表达式。仅当左边一个为真时才评估第二部分。在那种情况下,整个表达的结果将来自右边部分。它是基于布尔表达式评估方式的流行技术。 - Guria
我没有看到局部变量的点和这里的快捷方式评估(除了小的性能改进)。如果 key 不在本地存储中, window.localStorage.getItem(key) 回报 null  - 确实如此 不 抛出“非法访问”例外 - 和 JSON.parse(null) 回报 null 同样 - 它确实如此 不 无论是在Chromium 21还是在 ES 5.1第15.12.2节因为 String(null) === "null" 这可以解释为 JSON文字。 - PointedEars
本地存储中的值始终是原始字符串值。那么这个快捷方式评估所处理的是当有人存储时 "" (空字符串)之前。因为它类型转换为 false 和 JSON.parse(""),这会抛出一个 SyntaxError 异常,不叫。 - PointedEars
这在IE8中不起作用,所以如果你需要支持它,你最好使用确认答案中的功能。 - Ezeke


您可能会发现使用这些方便的方法扩展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下面只支持字符串。


196
2018-01-06 04:42



将CMS的方法包装到函数中是一个好主意,它只需要一个功能测试:一个用于JSON.stringify,一个用于JSON.parse,另一个用于测试localStorage是否可以实际设置和检索对象。修改主机对象不是一个好主意;我宁愿把它看作一个单独的方法而不是 localStorage.setObject。 - Garrett
这个 getObject() 会抛出一个 SyntaxError 如果存储的值是异常 ""因为 JSON.parse() 无法处理。有关详细信息,请参阅我对Guria答案的编辑。 - PointedEars
只是我的两分钱,但我很确定扩展供应商提供的对象并不是一个好主意。 - Sethen


扩展Storage对象是一个很棒的解决方案。对于我的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;
  }
}

64
2018-01-21 18:29



这几乎就是我所需要的。只需在注释之前添加if(value == null){return false},否则在检查localStorage上是否存在密钥时会导致错误。 - Francesco Frapporti
实际上这很酷。同意@FrancescoFrapporti你需要一个if in there for null值。我还添加了一个'|| value [0] ==“[”'测试,以防有数组存在。 - rob_james
好的,我会编辑这个。虽然你不需要null部分,但如果你这样做,我建议三个===。如果您使用JSHint或JSLint,则会警告您不要使用==。 - Alex Grande
对于非忍者(像我一样),有人可以提供这个答案的用法示例吗?是吗: data.set('username': 'ifedi', 'fullname': { firstname: 'Ifedi', lastname: 'Okonkwo'});? - Ifedi Okonkwo
确实是的!当我克服了用勺子喂食的欲望时,我拿了代码进行测试,并得到了它。我认为这个答案很好,因为1)与接受的答案不同,对字符串数据进行某些检查需要时间,2)与下一个不同,它不会扩展本机对象。 - Ifedi Okonkwo


有一个很棒的库可以包含许多解决方案,所以它甚至支持所谓的旧浏览器 jStorage

您可以设置一个对象

$.jStorage.set(key, value)

并轻松检索它

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

52
2017-08-23 03:52



$是非法的! - SuperUberDuper
@SuperUberDuper jStorage需要Prototype,MooTools或jQuery - JProgrammer


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

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

在处理这个问题的SO上已经存在一些问题: Stringify(转换为JSON)具有循环引用的JavaScript对象


50
2017-11-19 09:51





使用JSON对象进行本地存储:

//组

var m={name:'Hero',Title:'developer'};
localStorage.setItem('us', JSON.stringify(m));

//得到

var gm =JSON.parse(localStorage.getItem('us'));
console.log(gm.name);

//迭代所有本地存储密钥和值

for (var i = 0, len = localStorage.length; i < len; ++i) {
  console.log(localStorage.getItem(localStorage.key(i)));
}

//删除

localStorage.removeItem('us');
delete window.localStorage["us"];

29
2017-11-20 07:06





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

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

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


27
2018-04-05 21:20



函数序列化/反序列化是不可靠的,因为 它依赖于实现。此外,您想要替换 c.f[k] = escape(a[k]);  使用Unicode安全 c.f[k] = encodeURIComponent(a[k]); 和 eval('b.' + k + ' = ' + unescape(data.f[k])); 同 b[k] = eval("(" + decodeURIComponent(data.f[k]) + ")");。括号是必需的,因为你的函数,如果正确序列化,可能是匿名的,这不是有效的/ Statement /(所以 eval())会抛出一个 SyntaxError 否则)。 - PointedEars
和 typeof 是一个 操作者,不要把它写成一个函数。更换 typeof(a[k]) 同 typeof a[k]。 - PointedEars
除了应用我的建议并强调方法的不可靠性之外,我还修复了以下错误:1。并非所有变量都被声明。 2。 for - in 没有过滤自己的属性。 3.代码样式(包括引用)不一致。 - PointedEars
@PointedEars这有什么实际的区别?规范说 the use and placement of white space, line terminators, and semicolons within the representation String is implementation-dependent.  我没有看到任何功能差异。 - Michael
@Michael你引用的部分开头 Note *in particular* that …。但是返回值规范始于 An implementation-dependent representation of the function is returned. This representation has the syntax of a FunctionDeclaration. 返回值可以是 function foo () {}  - 假设一个 符合 实现。 - PointedEars


您也可以覆盖默认存储 setItem(key,value) 和 getItem(key) 处理对象/数组的方法,与任何其他数据类型一样。这样,你可以简单地打电话 localStorage.setItem(key,value) 和 localStorage.getItem(key) 像往常一样。

我没有对此进行过广泛的测试,但它似乎对我一直在修补的小项目没有问题。

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

Storage.prototype._getItem = Storage.prototype.getItem;
Storage.prototype.getItem = function(key)
{  
  try
  {
    return JSON.parse(this._getItem(key));
  }
  catch(e)
  {
    return this._getItem(key);
  }
}

22
2018-04-26 13:00



更改本机/内置对象API被认为是不好的做法。其他解决方案请参阅其他答案。 - Schmuli
很好,假设您从不想使用任何依赖于规范的库。 - Carl Smith


在点击另一个已经关闭的帖子后,我到达了这个帖子,这个帖子的标题是“如何在localstorage中存储数组?”。哪个好,除非两个线程实际上都没有提供关于如何在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

19
2018-05-07 11:35



这是一组非常方便的方法,用于操作存储在localStorage或sessionStorage中的数组,并且应该获得比它所吸引的更多的功劳。 @Andy Lorenz感谢您抽出宝贵时间分享! - Velojet