首页 文章

在HTML5 localStorage中存储对象

提问于
浏览
2164

我想在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 Storage规范的误解,而不是特定于浏览器的错误或限制 .

我试图理解http://www.w3.org/TR/html5/infrastructure.html中描述的结构化克隆算法 . 我没有't fully understand what it'说,但也许我的问题与我的对象的属性不可枚举(???)

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


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

27 回答

  • 13

    更好的是你将函数设置为setter和getter localStorage ,这样你就可以获得更好的控制,并且不必重复JSON解析等等 . 它甚至可以顺利处理你的 (" ") 空字符串键/数据包 .

    function setItemInStorage(dataKey, data){
        localStorage.setItem(dataKey, JSON.stringify(data));
    }
    
    function getItemFromStorage(dataKey){
        var data = localStorage.getItem(dataKey);
        return data? JSON.parse(data): null ;
    }
    
    setItemInStorage('user', { name:'tony stark' });
    getItemFromStorage('user'); /* return {name:'tony stark'} */
    
  • 1

    使用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"];
    
  • 53

    variant的一个小改进:

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

    由于short-circuit evaluation,如果 key 不在存储中, getObject() 将立即返回 null . 如果 value"" (空字符串; JSON.parse() 无法处理),它也不会抛出 SyntaxError 异常 .

  • 3

    我已经修改了一个最高投票的答案 . 如果不需要,我就是拥有单一功能而不是2的粉丝 .

    Storage.prototype.object = function(key, val) {
        if ( typeof val === "undefined" ) {
            var value = this.getItem(key);
            return value ? JSON.parse(value) : null;
        } else {
            this.setItem(key, JSON.stringify(val));
        }
    }
    
    localStorage.object("test", {a : 1}); //set value
    localStorage.object("test"); //get value
    

    此外,如果未设置任何值,则返回 null 而不是 false . false 有一些含义, null 没有 .

  • 22

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

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

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

  • 4

    您可以使用localDataStorage透明地存储javascript数据类型(Array,Boolean,Date,Float,Integer,String和Object) . 它还提供轻量级数据混淆,自动压缩字符串,便于按键(名称)查询以及按(键)值查询,并通过为键添加前缀来帮助在同一域内实施分段共享存储 .

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

    例子:

    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
    

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

  • 5

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

    您可以设置一个对象

    $.jStorage.set(key, value)
    

    并轻松检索它

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

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

    EJSON是JSON的扩展,支持更多类型 . 它支持所有JSON安全类型,以及:Date(JavaScript Date)二进制(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

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

  • 8

    http://rhaboo.org是一个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有关;-)

    阿德里安 .

  • 3

    要存储对象,您可以创建一个字母,您可以使用这些字母将字符串中的对象转换为对象(可能没有意义) . 例如

    var obj = {a: "lol", b: "A", c: "hello world"};
    function saveObj (key){
        var j = "";
        for(var i in obj){
            j += (i+"|"+obj[i]+"~");
        }
        localStorage.setItem(key, j);
    } // Saving Method
    function getObj (key){
        var j = {};
        var k = localStorage.getItem(key).split("~");
        for(var l in k){
            var m = k[l].split("|");
            j[m[0]] = m[1];
        }
        return j;
    }
    saveObj("obj"); // undefined
    getObj("obj"); // {a: "lol", b: "A", c: "hello world"}
    

    如果你使用你用来分割对象的字母,这种技术会引起一些故障,而且它也是非常实验性的 .

  • 1

    对于愿意设置和获取类型属性的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);
        }
    }
    

    Example usage

    // 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");
    
  • 1

    Look this

    假设您有以下数组称为电影:

    var movies = ["Reservoir Dogs", "Pulp Fiction", "Jackie Brown", 
                  "Kill Bill", "Death Proof", "Inglourious Basterds"];
    

    使用stringify函数,可以使用以下语法将movies数组转换为字符串:

    localStorage.setItem("quentinTarantino", JSON.stringify(movies));
    

    请注意,我的数据存储在名为quentinTarantino的密钥下 .

    检索您的数据

    var retrievedData = localStorage.getItem("quentinTarantino");
    

    要将字符串转换回对象,请使用JSON解析函数:

    var movies2 = JSON.parse(retrievedData);
    

    您可以调用movies2上的所有数组方法

  • 1

    我想在本地,会话,cookie上避免那些问题你可以使用opendb库..

    前 - 你可以解决这个问题使用此代码段

    // for set object in db
    db.local.setJSON("key", {name: "xyz"});  
    
    // for get object form db
    db.local.getJSON("key");
    

    https://github.com/pankajbisht/openDB

    有关Web存储的更多详细信息,请阅读web storage文章 .

  • -6

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

  • 4

    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"
    

    I do not recommend 存储函数因为 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 "Converting circular structure to 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 (convert to JSON) a JavaScript object with circular reference

  • 2768

    您还可以覆盖默认的Storage 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);
      }
    }
    
  • 2

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

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

    However, Function serialization/deserialization is unreliable because it is implementation-dependent.

  • 202

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

  • 578

    这里是@danott发布的代码的一些扩展版本

    它还将从localstorage实现 delete 值,并显示如何添加Getter和Setter层而不是

    localstorage.setItem(preview, true)

    你可以写

    config.preview = true

    好的,这里是:

    var PT=Storage.prototype
    
    if (typeof PT._setItem >='u') PT._setItem = PT.setItem;
    PT.setItem = function(key, value)
    {
      if (typeof value >='u')//..ndefined
        this.removeItem(key)
      else
        this._setItem(key, JSON.stringify(value));
    }
    
    if (typeof PT._getItem >='u') PT._getItem = PT.getItem;
    PT.getItem = function(key)
    {  
      var ItemData = this._getItem(key)
      try
      {
        return JSON.parse(ItemData);
      }
      catch(e)
      {
        return ItemData;
      }
    }
    
    // Aliases for localStorage.set/getItem 
    get =   localStorage.getItem.bind(localStorage)
    set =   localStorage.setItem.bind(localStorage)
    
    // Create ConfigWrapperObject
    var config = {}
    
    // Helper to create getter & setter
    function configCreate(PropToAdd){
        Object.defineProperty( config, PropToAdd, {
          get: function ()      { return (  get(PropToAdd)      ) },
          set: function (val)   {           set(PropToAdd,  val ) }
        })
    }
    //------------------------------
    
    // Usage Part
    // Create properties
    configCreate('preview')
    configCreate('notification')
    //...
    
    // Config Data transfer
    //set
    config.preview = true
    
    //get
    config.preview
    
    // delete
    config.preview = undefined
    

    那你可以用 .bind(...) 删除别名部分 . 但是我只是把它放进去,因为知道这个真的很好 . 我花了几个小时才发现为什么一个简单的 get = localStorage.getItem; 不起作用

  • 1

    循环通过本地存储

    var retrievedData = localStorage.getItem("MyCart");                 
    
    retrievedData.forEach(function (item) {
       console.log(item.itemid);
    });
    
  • 4

    我做了一件不破坏现有存储对象的东西,但创建了一个包装器,这样你就可以做你想做的事 . 结果是一个普通的对象,没有方法,可以像任何对象一样进行访问 .

    The thing I made.

    如果你想要1 localStorage 属性是魔术:

    var prop = ObjectStorage(localStorage, 'prop');
    

    如果你需要几个:

    var storage = ObjectStorage(localStorage, ['prop', 'more', 'props']);
    

    你对 prop 或对象 inside storage 所做的一切都会自动保存到 localStorage 中 . 你总是玩一个真实的物体,所以你可以做这样的事情:

    storage.data.list.push('more data');
    storage.another.list.splice(1, 2, {another: 'object'});
    

    并且将自动跟踪每个新对象 inside 跟踪对象 .

    The very big downside: 这取决于 Object.observe() 所以它的浏览器支持非常有限 . 而且它很快就会为Firefox或Edge而来 .

  • 30

    对@Guria答案的改进:

    Storage.prototype.setObject = function (key, value) {
        this.setItem(key, JSON.stringify(value));
    };
    
    
    Storage.prototype.getObject = function (key) {
        var value = this.getItem(key);
        try {
            return JSON.parse(value);
        }
        catch(err) {
            console.log("JSON parse failed for lookup of ", key, "\n error was: ", err);
            return null;
        }
    };
    
  • 1

    扩展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;
      }
    }
    
  • 67

    我用另外20行代码创建了另一个简约包装器,以允许它像它应该使用它:

    localStorage.set('myKey',{a:[1,2,5], b: 'ok'});
    localStorage.has('myKey');   // --> true
    localStorage.get('myKey');   // --> {a:[1,2,5], b: 'ok'}
    localStorage.keys();         // --> ['myKey']
    localStorage.remove('myKey');
    

    https://github.com/zevero/simpleWebstorage

  • 4

    查看AppleMozillaMicrosoft文档,该功能似乎仅限于处理字符串键/值对 .

    解决方法可以在存储之前对您的对象进行处理,然后在检索它时对其进行解析:

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

    在点击另一个已经关闭的帖子后,我到达了这个帖子, Headers 是“如何在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
    
  • 52

    使用localStorage跟踪来自联系人的已接收消息的库的一个小示例:

    // This class is supposed to be used to keep a track of received message per contacts.
    // You have only four methods:
    
    // 1 - Tells you if you can use this library or not...
    function isLocalStorageSupported(){
        if(typeof(Storage) !== "undefined" && window['localStorage'] != null ) {
             return true;
         } else {
             return false;
         }
     }
    
    // 2 - Give the list of contacts, a contact is created when you store the first message
     function getContacts(){
        var result = new Array();
        for ( var i = 0, len = localStorage.length; i < len; ++i ) {
            result.push(localStorage.key(i));
        }
        return result;
     }
    
     // 3 - store a message for a contact
     function storeMessage(contact, message){
        var allMessages;
        var currentMessages = localStorage.getItem(contact);
        if(currentMessages == null){
            var newList = new Array();
            newList.push(message);
            currentMessages = JSON.stringify(newList);
        }
        else
        {
            var currentList =JSON.parse(currentMessages);
            currentList.push(message);
            currentMessages = JSON.stringify(currentList);
        }
        localStorage.setItem(contact, currentMessages);
     }
    
     // 4 - read the messages of a contact
     function readMessages(contact){
    
        var result = new Array();
        var currentMessages = localStorage.getItem(contact);
    
        if(currentMessages != null){
            result =JSON.parse(currentMessages);
        }
        return result;
     }
    

相关问题