异步存储

异步存储是一个简单的、异步的、持久的、全局的、键-值存储系统。它应该会代替本地存储被使用。

由于异步存储是全局性的,建议您在异步存储之上使用抽象体,而不是对任何轻微用法直接使用异步存储。

在本地 iOS 实现上 JS 代码是一个简单的外观模式,用来提供一个清晰的 JS API,真正的错误对象,和简单的非多元化功能。每个方法返回一个 Promise 对象。

方法

  1. static **getItem**(key: string, callback: (error: ?Error, result: ?string) => void)

如果有任何一个错误,获取 key 并传递 callback 的结果,返回一个 Promise 对象。

  1. static **setItem**(key: string, value: string, callback: ?(error: ?Error) => void)

如果有任何一个错误,获取 key 并在结束时调用 callback 函数,返回一个 Promise 对象。

  1. static **removeItem**(key: string, callback: ?(error: ?Error) => void)

返回一个 Promise 对象。

  1. static **mergeItem**(key: string, value: string, callback: ?(error: ?Error) => void)

将现有值与输入值进行合并,假设它们是 stringified json,返回一个 Promise 对象。

所有本地实现不支持。

  1. static **clear**(callback: ?(error: ?Error) => void)

为所有客户、函数库等清除所有的异步存储。你可能不想调用这个-使用 removeItem 或者 multiRemove 来清除只属于你的键值。返回一个 Promise 对象。

  1. static **getAllKeys**(callback: (error: ?Error) => void)

为调用者、函数库等获取系统已知的所有键值。返回一个 Promise 对象。

  1. static **multiGet**(keys: Array<string>, callback: (errors: ?Array<Error>, result: ?Array<Array<string>>) => void)
  2. multiGet利用一个键值对的数组调用回调函数来获取multiSet的输入格式。返回一个 `Promise` 对象。
  3. multiGet(['k1', 'k2'], cb) -> cb([['k1', 'val1'], ['k2', 'val2']])
  4. static **multiSet**(keyValuePairs: Array<Array<string>>, callback: ?(errors: ?Array<Error>) => void)

multiSet 和 multiMerge 利用键值对的数组匹配multiGet的输出。返回一个 Promise 对象。例如,

  1. multiSet([['k1', 'val1'], ['k2', 'val2']], cb);
  2. static **multiRemove**(keys: Array<string>, callback: ?(errors: ?Array<Error>) => void)

删除键值数组中所有的键值。返回一个 Promise 对象。

  1. static **multiMerge**(keyValuePairs: Array<Array<string>>, callback: ?(errors: ?Array<Error>) => void)

将现有值与输入值进行合并,假设它们是 stringified json,返回一个 Promise 对象。

所有本地实现不支持。

例子

dit on GitHub

  1. 'use strict';
  2. var React = require('react-native');
  3. var {
  4. AsyncStorage,
  5. PickerIOS,
  6. Text,
  7. View
  8. } = React;
  9. var PickerItemIOS = PickerIOS.Item;
  10. var STORAGE_KEY = '@AsyncStorageExample:key';
  11. var COLORS = ['red', 'orange', 'yellow', 'green', 'blue'];
  12. var BasicStorageExample = React.createClass({
  13. componentDidMount() {
  14. AsyncStorage.getItem(STORAGE_KEY)
  15. .then((value) => {
  16. if (value !== null){
  17. this.setState({selectedValue: value});
  18. this._appendMessage('Recovered selection from disk: ' + value);
  19. } else {
  20. this._appendMessage('Initialized with no selection on disk.');
  21. }
  22. })
  23. .catch((error) => this._appendMessage('AsyncStorage error: ' + error.message))
  24. .done();
  25. },
  26. getInitialState() {
  27. return {
  28. selectedValue: COLORS[0],
  29. messages: [],
  30. };
  31. },
  32. render() {
  33. var color = this.state.selectedValue;
  34. return (
  35. <View>
  36. <PickerIOS
  37. selectedValue={color}
  38. onValueChange={this._onValueChange}>
  39. {COLORS.map((value) => (
  40. <PickerItemIOS
  41. key={value}
  42. value={value}
  43. label={value}
  44. />
  45. ))}
  46. </PickerIOS>
  47. <Text>
  48. {'Selected: '}
  49. <Text style={{color}}>
  50. {this.state.selectedValue}
  51. </Text>
  52. </Text>
  53. <Text>{' '}</Text>
  54. <Text onPress={this._removeStorage}>
  55. Press here to remove from storage.
  56. </Text>
  57. <Text>{' '}</Text>
  58. <Text>Messages:</Text>
  59. {this.state.messages.map((m) => <Text>{m}</Text>)}
  60. </View>
  61. );
  62. },
  63. _onValueChange(selectedValue) {
  64. this.setState({selectedValue});
  65. AsyncStorage.setItem(STORAGE_KEY, selectedValue)
  66. .then(() => this._appendMessage('Saved selection to disk: ' + selectedValue))
  67. .catch((error) => this._appendMessage('AsyncStorage error: ' + error.message))
  68. .done();
  69. },
  70. _removeStorage() {
  71. AsyncStorage.removeItem(STORAGE_KEY)
  72. .then(() => this._appendMessage('Selection removed from disk.'))
  73. .catch((error) => { this._appendMessage('AsyncStorage error: ' + error.message) })
  74. .done();
  75. },
  76. _appendMessage(message) {
  77. this.setState({messages: this.state.messages.concat(message)});
  78. },
  79. });
  80. exports.title = 'AsyncStorage';
  81. exports.description = 'Asynchronous local disk storage.';
  82. exports.examples = [
  83. {
  84. title: 'Basics - getItem, setItem, removeItem',
  85. render(): ReactElement { return <BasicStorageExample />; }
  86. },
  87. ];