Хранение объектов в HTML5 localStorage

Я хотел бы сохранить объект JavaScript в HTML5 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 , а не ошибка или ограничение для конкретного браузера.

Я попытался разобраться в алгоритме структурированного клонирования , описанном в http://www.w3.org/TR/html5/infrastructure.html . Я не до конца понимаю, что он говорит, но, возможно, моя проблема связана с тем, что свойства моего объекта не перечисляются (???)

Есть ли легкий обходной путь?


Обновление: W3C в конечном итоге изменил свое мнение о спецификации структурированных клонов и решил изменить спецификацию в соответствии с реализациями. См. Https://www.w3.org/Bugs/Public/show_bug.cgi?id=12111 . Таким образом, этот вопрос больше не является действительным на 100%, но ответы все еще могут представлять интерес.

Всего 20 ответов


Глядя на документацию Apple , Mozilla и Microsoft , кажется, что функциональность ограничена, чтобы обрабатывать только пары ключ / значение строки.

Обходной путь может заключаться в том, чтобы структурировать ваш объект перед его сохранением, а затем проанализировать его при извлечении:

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

Незначительное улучшение

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() немедленно вернет getObject() если key не находится в Storage. Он также не будет генерировать исключение SyntaxError если value равно "" (пустая строка; JSON.parse() не может обработать это).


Возможно, вам будет полезно расширить объект 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 поддерживаются только строки.


Расширение объекта 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;
  }
}

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() (который вызывается неявно при хранении данных в веб-хранилище):

//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 уже есть вопрос, касающийся этой проблемы:


Существует отличная библиотека, которая объединяет многие решения, поэтому она поддерживает даже старые браузеры, называемые 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;
}

Однако сериализация / десериализация функций ненадежна, поскольку .



Я пришел к этому сообщению после того, как нажал на другое сообщение, которое было закрыто как дубликат этого - под названием «Как сохранить массив в localalstorage?». Это нормально, за исключением того, что ни один из потоков на самом деле не дает полного ответа о том, как вы можете поддерживать массив в 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


Лучше вы будете делать функции как 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'} */

Я немного изменил один из самых популярных ответов. Я фанат одной функции вместо 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 - нет.


Улучшение ответа @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, "
 error was: ", err);
        return null;
    }
};

Вы можете использовать localDataStorage для прозрачного хранения типов данных javascript (Array, Boolean, Date, Float, Integer, String и Object). Он также обеспечивает упрощенную обфускацию данных, автоматически сжимает строки, облегчает запрос по ключу (имени), а также по запросу (ключу) и помогает обеспечить сегментированное общее хранилище в том же домене с помощью префикса ключей.

[ОТКАЗ ОТ ОТВЕТСТВЕННОСТИ] Я являюсь автором утилиты [/ ОТКАЗ ОТ ОТВЕТСТВЕННОСТИ]

Примеры:

localDataStorage.set( 'key1', 'Belgian' )
localDataStorage.set( 'key2', 1200.0047 )
localDataStorage.set( 'key3', true )
localDataStorage.set( 'key4', { 'RSK' : [1,Ɖ',5,ƍ',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 - это проект с открытым исходным кодом, который предоставляет простой интерфейс для localStorage / sessionStorage и автоматизирует сохранение для полей формы (ввод, переключатели и флажки).

постоянные особенности

(Отказ от ответственности: я автор.)


Вы можете использовать ejson для хранения объектов в виде строк.

EJSON является расширением JSON для поддержки большего количества типов. Он поддерживает все JSON-безопасные типы, а также:

  • Дата (JavaScript Date )
  • Двоичный (JavaScript Uint8Array или результат EJSON.newBinary )
  • Пользовательские типы (см. EJSON.addType . Например, Mongo.ObjectID реализован таким образом.)

Все сериализации EJSON также действительны в формате JSON. Например, объект с датой и двоичным буфером будет сериализован в EJSON как:

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

Вот моя оболочка localStorage, использующая ejson

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

Я добавил несколько типов в свою оболочку, включая регулярные выражения и функции


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

Адриан.


Я сделал еще одну минималистичную оболочку, содержащую всего 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);
    }
}

Пример использования :

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

Есть идеи?

10000