react-native-storage(数据持久化存储)文档介绍

中文doc:仅供参考 import Storage from 'react-native-storage'; import {AsyncStorage} from 'react-native';

var storage = new Storage({
    // 最大容量，默认值1000条数据循环存储
    size: 1000,

    // 存储引擎：对于RN使用AsyncStorage，对于web使用window.localStorage
    // 若是不指定则数据只会保存在内存中，重启后即丢失
    storageBackend: AsyncStorage,

    // 数据过时时间，默认一成天（1000 * 3600 * 24 毫秒），设为null则永不过时
    defaultExpires: 1000 * 3600 * 24,

    // 读写时在内存中缓存数据。默认启用。
    enableCache: true,

    // 若是storage中没有相应数据，或数据已过时，
    // 则会调用相应的sync方法，无缝返回最新数据。
    // sync方法的具体说明会在后文提到
    // 你能够在构造函数这里就写好sync的方法
    // 或是在任什么时候候，直接对storage.sync进行赋值修改
    // 或是写到另外一个文件里，这里require引入
    // sync: require('你能够另外写一个文件专门处理sync')

})

// 最好在全局范围内建立一个（且只有一个）storage实例，方便直接调用

// 对于web
// window.storage = storage;

// 对于react native
// global.storage = storage;

// 这样，在此**以后**的任意位置便可以直接调用storage
// 注意：全局变量必定是先声明，后使用
// 若是你在某处调用storage报错未定义
// 请检查global.storage = storage语句是否确实已经执行过了

// 使用key来保存数据。这些数据通常是全局独有的，经常须要调用的。
// 除非你手动移除，这些数据会被永久保存，并且默认不会过时。
storage.save({
    key: 'loginState',  // 注意:请不要在key中使用_下划线符号!
    data: {
        from: 'some other site',
        userid: 'some userid',
        token: 'some token'
    },

    // 若是不指定过时时间，则会使用defaultExpires参数
    // 若是设为null，则永不过时
    expires: 1000 * 3600
});

// 读取
storage.load({
    key: 'loginState',

    // autoSync(默认为true)意味着在没有找到数据或数据过时时自动调用相应的sync方法
    autoSync: true,

    // syncInBackground(默认为true)意味着若是数据过时，
    // 在调用sync方法的同时先返回已通过期的数据。
    // 设置为false的话，则等待sync方法提供的最新数据(固然会须要更多时间)。
    syncInBackground: true,

    // 你还能够给sync方法传递额外的参数
    syncParams: {
        extraFetchOptions: {
            // 各类参数
        },
        someFlag: true,
    },
}).then(ret => {
    // 若是找到数据，则在then方法中返回
    // 注意：这是异步返回的结果（不了解异步请自行搜索学习）
    // 你只能在then这个方法内继续处理ret数据
    // 而不能在then之外处理
    // 也没有办法“变成”同步返回
    // 你也可使用“看似”同步的async/await语法

    console.log(ret.userid);
    this.setState({user: ret});
}).catch(err => {
    //若是没有找到数据且没有sync方法，
    //或者有其余异常，则在catch中返回
    console.warn(err.message);
    switch (err.name) {
        case 'NotFoundError':
            // TODO;
            break;
        case 'ExpiredError':
            // TODO
            break;
    }
})


// 使用key和id来保存数据，通常是保存同类别（key）的大量数据。
// 全部这些"key-id"数据共有一个保存上限（不管是否相同key）
// 即在初始化storage时传入的size参数。
// 在默认上限参数下，第1001个数据会覆盖第1个数据。
// 覆盖以后，再读取第1个数据，会返回catch或是相应的sync方法。
var userA = {
    name: 'A',
    age: 20,
    tags: [
        'geek',
        'nerd',
        'otaku'
    ]
};

storage.save({
    key: 'user',  // 注意:请不要在key中使用_下划线符号!
    id: '1001',   // 注意:请不要在id中使用_下划线符号!
    data: userA,
    expires: 1000 * 60
});

//load 读取
storage.load({
    key: 'user',
    id: '1001'
}).then(ret => {
    // 若是找到数据，则在then方法中返回
    console.log(ret.userid);
}).catch(err => {
    // 若是没有找到数据且没有sync方法，
    // 或者有其余异常，则在catch中返回
    console.warn(err.message);
    switch (err.name) {
        case 'NotFoundError':
            // TODO;
            break;
        case 'ExpiredError':
            // TODO
            break;
    }
})

// --------------------------------------------------

// 获取某个key下的全部id
storage.getIdsForKey('user').then(ids => {
    console.log(ids);
});

// 获取某个key下的全部数据
storage.getAllDataForKey('user').then(users => {
    console.log(users);
});

// !! 清除某个key下的全部数据
storage.clearMapForKey('user');

// --------------------------------------------------

// 删除单个数据
storage.remove({
    key: 'lastPage'
});
storage.remove({
    key: 'user',
    id: '1001'
});

// !! 清空map，移除全部"key-id"数据（但会保留只有key的数据）
storage.clearMap();


//同步远程数据（刷新）
storage.sync = {
    // sync方法的名字必须和所存数据的key彻底相同
    // 方法接受的参数为一整个object，全部参数从object中解构取出
    // 这里可使用promise。或是使用普通回调函数，但须要调用resolve或reject。
    user(params){
        let {id, resolve, reject, syncParams: {extraFetchOptions, someFlag}} = params;
        fetch('user/', {
            method: 'GET',
            body: 'id=' + id,
            ...extraFetchOptions,
        }).then(response => {
            return response.json();
        }).then(json => {
            //console.log(json);
            if (json && json.user) {
                storage.save({
                    key: 'user',
                    id,
                    data: json.user
                });

                if (someFlag) {
                    // 根据syncParams中的额外参数作对应处理
                }

                // 成功则调用resolve
                resolve && resolve(json.user);
            }
            else {
                // 失败则调用reject
                reject && reject(new Error('data parse error'));
            }
        }).catch(err => {
            console.warn(err);
            reject && reject(err);
        });
    }


}


//有了上面这个sync方法，之后再调用storage.load时，若是本地并无存储相应的user，那么会自动触发storage.sync.user去远程取回数据并没有缝返回。

storage.load({
    key: 'user',
    id: '1002'
}).then()

//读取批量数据

// 使用和load方法同样的参数读取批量数据，可是参数是以数组的方式提供。
// 会在须要时分别调用相应的sync方法，最后统一返回一个有序数组。
storage.getBatchData([
    {key: 'loginState'},
    {key: 'checkPoint', syncInBackground: false},
    {key: 'balance'},
    {key: 'user', id: '1009'}
])
    .then(results => {
        results.forEach(result => {
            console.log(result);
        })
    })

//根据key和一个id数组来读取批量数据
storage.getBatchDataWithIds({
    key: 'user',
    ids: ['1001', '1002', '1003']
})
    .then()


/*
 这两个方法除了参数形式不一样，还有个值得注意的差别。getBatchData会在数据缺失时挨个调用不一样的sync方法(由于key不一样)。
 可是getBatchDataWithIds却会把缺失的数据统计起来，将它们的id收集到一个数组中，而后一次传递给对应的sync方法(避免挨个查询致使同时发起大量请求)，
 因此你须要在服务端实现经过数组来查询返回，还要注意对应的sync方法的参数处理（由于id参数多是一个字符串，也多是一个数组的字符串）。
 */
复制代码