README-zh_CN.md

pstorage

English | 简体中文

pstorage 是什么 ?

这是一个通用的缓存管理方案. 可以适配多种缓存器, 并且能够合理的管理需要存储的数据.

pstorage 的特点

• 支持多端缓存器适配
• 统一的存储数据管理
• 运行时缓存，减小对 Storage 的读取压力
• 掌握被存储数据的信息
• 同时支持同步、异步写法
• 兼容缓存器其他没有使用到的 api

使用方法

在使用之前，我们需要在入口文件注册 storage，并且将其设置为一个全局变量:

const Storage = require('pstorage');
const storage = new Storage({
  target: localStorage,
  keys: ['userInfo']
});
// 设置为全局变量
// 浏览器
window.storage = storage;
// 微信小程序的 app.js
App({
  ...storage
});

存储初始 storage item:

const storage = window.storage;
const userInfo = {
  name: 'Jack'
};
/**
 * 用户信息在运行时的存储格式为：
 * {
 *   value: {
 *     name: 'Jack'
 *   }
 * }
 * 持久性缓存的格式为：
 * '{"value": "{"name":"Jack"}"}'
 */
// 同步存储, 返回 undefined
try {
  storage.setItemSync('userInfo', userInfo);
} catch (err) {
  console.log(err);
}
// 异步存储，返回一个 promise
storage
  .setItem('userInfo', userInfo)
  .then(() => {})
  .catch(err => {});

获取 storage item:

const storage = window.storage;
// 同步方法
try {
  const userInfo = storage.getItemSync('userInfo');
} catch (err) {
  console.log(err);
}
// 异步方法
storage.getItem('userInfo').then(userInfo => {});

移除 storage item:

const storage = window.storage;
// 同步方法
try {
  storage.removeSync('userInfo');
} catch (err) {
  console.log(err);
}
// 异步方法
storage.remove('userInfo').then(() => {});

清除所有存储的数据

const storage = window.storage;
// 同步方法
try {
  storage.clearSync('userInfo');
} catch (err) {
  console.log(err);
}
// 异步方法
storage.clear('userInfo').then(() => {});

获取当前的缓存信息

const storage = window.storage;
// 同步方法
try {
  const result = storage.getInfoSync();
} catch (err) {
  console.log(err);
}
// 异步方法
storage.getInfo().then(result => {});

属性	类型	说明
keys	Array.	当前 storage 中所有的 key
currentSize	number	当前占用的空间大小, 单位 KB
limitSize	number	限制的空间大小，单位 KB

注意：

由于容器之间的差别，只有小程序平台才会返回有效的 limitSize。

使用 storage 适配器

storage 适配器是用来选择性重写缓存器的原生方法，具体使用方法如下：

const Storage = require('pstorage');

const getItemAsync = function(getItem) {
  return function(key, callback, fallback) {
    try {
      const value = getItem(key);
      callback(value);
    } catch (err) {
      fallback(err);
    }
  };
};
const setItemAsync = function(setItem) {
  return function(key, data, callback, fallback) {
    setItem(key, data);
    callback();
  };
};

const storage = new Storage({
  target: localStorage,
  keys: ['userInfo'],
  adapters: {
    getItem: getItemAsync(localStorage.getItem),
    setItem: setItemAsync(localStorage.setItem),
    getItemSync: localStorage.getItem,
    setItemSync: localStorage.setItem
  }
});

官方在 Web 容器内已经支持的缓存器有：localStorage, sessionStorage； 在小程序容器下已经支持：微信小程序、阿里小程序、头条小程序； 在 ReactNative 的容器下支持：AsyncStorage

兼容缓存器其他没有使用到的 api

以 React-Native 为例，AsyncStorage 支持如下写法：

import { AsyncStorage } from 'react-native';
import Storage from 'pstorage';

const storage = new Storage({
  target: AsyncStorage,
  keys: ['userInfo']
});

storage.getAllKeys(keys => {
  if (!err) {
    console.log(keys);
  }
});