Хранение объектов в HTML5 localStorage - PullRequest
2303 голосов
/ 06 января 2010

Я хотел бы сохранить объект 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 * Web5 Storage , а не ошибка браузера или ограничение.

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

Есть ли простой обходной путь?


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

Ответы [ 27 ]

2923 голосов
/ 06 января 2010

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

Обходной путь может быть 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));
598 голосов
/ 30 июня 2010

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

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() не может обработать это).

208 голосов
/ 06 января 2010

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

69 голосов
/ 21 января 2011

Расширение объекта 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;
  }
}
61 голосов
/ 19 ноября 2014

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 решает эту проблему: Stringify (преобразовать в JSON) объект JavaScript с циклической ссылкой

52 голосов
/ 23 августа 2011

Существует отличная библиотека, которая объединяет многие решения, поэтому она даже поддерживает старые браузеры, называемые jStorage

Вы можете установить объект

$.jStorage.set(key, value)

И получить его легко

value = $.jStorage.get(key)
value = $.jStorage.get(key, "default value")
34 голосов
/ 20 ноября 2014

Использование объектов JSON для локального хранилища:

// SET

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

// GET

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"];
28 голосов
/ 06 апреля 2011

Теоретически можно хранить объекты с функциями:

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

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

23 голосов
/ 26 апреля 2011

Вы также можете переопределить стандартные методы 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);
  }
}
21 голосов
/ 07 мая 2014

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