如何在HTML5本地存储中存储对象和数组?[副本]

看看 Apple , Mozilla 和 Microsoft 文档,功能似乎仅限于处理字符串键/值对。

解决方法可以是 stringify 在存储对象之前对其进行分析,然后在检索对象时对其进行分析:

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

A的微小改进 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 , getObject() 将 立即 返回 null 如果 key 不在存储中。它也不会抛出 SyntaxError 例外情况,如果 value 是 "" (空字符串; JSON.parse() 无法处理)。

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

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,我已经为本地存储创建了一个外观,然后在设置和获取时检查它是否是一个对象。

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

串化并不能解决所有问题

这里的答案似乎并没有涵盖在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代码中使用。

私人成员

使用的问题 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 (convert to JSON) a JavaScript object with circular reference

有一个很棒的库,它包含了许多解决方案,因此它甚至支持称为 jStorage

可以设置对象

$.jStorage.set(key, value)

很容易找到它

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

将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"];

理论上,可以使用以下函数存储对象:

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

但是,函数序列化/反序列化不可靠,因为 it is implementation-dependent .

您还可以覆盖默认存储 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);
  }
}

我是在点击了另一个已经被关闭的帖子之后到达这篇帖子的——标题是“如何在本地存储中存储数组?”.

因此,如果其他人希望能够在数组中推/弹出/移动项,并且他们希望该数组存储在本地存储中,或者实际上是会话存储中,那么您可以这样做:

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.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

建议对这里讨论的许多特性以及更好的兼容性使用抽象库。有很多选择:

• jStorage 或 simpleStorage &我的偏好
• localForage
• alekseykulikov/storage
• Lawnchair
• Store.js &另一个好选择
• OMG

更好的方法是使函数作为setter和getter 本地存储 通过这种方式,您将拥有更好的控制,并且不必重复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'} */

我稍微修改了一个最受欢迎的答案。如果不需要的话,我喜欢用单一功能代替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 . 假 有某种意义, 无效的 没有。

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

你可以用 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

如您所见,基本值是受尊重的。

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

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

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

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

EJSON是JSON的一个扩展,用于支持更多类型。它支持所有JSON安全类型,以及:

• 日期(javascript Date )
• 二进制(javascript Uint8Array 或结果 EJSON.newBinary )
• 用户定义的类型(请参见 EJSON.addType . 例如, Mongo.ObjectID 以这种方式实现。)

所有ejson序列化也是有效的json。例如,具有日期和二进制缓冲区的对象将在ejson中序列化为:

{
  "d": {"$date": 1358205756553},
  "b": {"$binary": "c3VyZS4="}
}

这是我使用ejson的本地存储包装

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

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

http://rhaboo.org 是一个本地存储糖层,允许您编写如下内容:

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

阿德里安。

我用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

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

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

它还将实现 删除 本地存储的值 并演示如何添加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; 不工作

我做了一件事情,它不会破坏现有的存储对象,而是创建一个包装器,这样您就可以做您想做的事情。结果是一个普通的对象,没有方法,像任何对象一样具有访问权限。

The thing I made.

如果你想要1 localStorage 魔法属性:

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

如果您需要几个:

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

你所做的一切 prop 或对象 里面 storage 将自动保存到 本地存储 . 你总是在玩一个真实的物体,所以你可以这样做:

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

每一个新的目标 里面 跟踪的对象将被自动跟踪。

最大的缺点是: 这取决于 Object.observe() 所以它的浏览器支持非常有限。而且它看起来不会很快出现在Firefox或Edge上。

Look this

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

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

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

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

请注意,我的数据存储在一个名为quentinarantino的键下。

正在检索数据

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

要从字符串转换回对象,请使用json parse函数:

var movies2 = JSON.parse(retrievedData);

可以调用电影中的所有数组方法2

要存储一个对象,您可以制作一个字母,用于将对象从字符串获取到对象(可能没有意义)。例如

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

如果你使用你用来分割物体的字母,这项技术会导致一些小故障,而且它也是非常实验性的。

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

通过本地存储循环

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

retrievedData.forEach(function (item) {
   console.log(item.itemid);
});