简介

local_cache_sync是一个非常简单易用的Flutter本地储存库，适用于在本地储存一列轻量数据（例如用户保存在本地的一系列蓝牙设备的配置，或者缓存一系列用户信息）

local_cache_sync的所有方法，包括保存与读取，都是同步的，而不是异步的。

同步存取意味着你不需要使用await就可以获取和保存数据。在flutter中，这可以显著减少StatefulWidget的数量，大量减少代码的复杂度。

推荐个我的iOS交流群：642363427有一个共同的圈子很重要，结识人脉！里面都是iOS开发，全栈发展，欢迎入驻，共同进步！（群内会免费提供一些群主收藏的免费学习书籍资料以及整理好的几百道面试题和答案文档！）

例子

使用local_cache_sync保存与读取参数都是同步的，这意味着赋值即是保存，而且在StatelessWidget中，可以立即使用数据，而不是异步请求数据再刷新。

下面这个Switch组件的值会被缓存到本地，即使重新启动App也会保留：

Switch(
  value: LocalCacheSync.userDefault.getWithKey<bool>('switch-A'),
  onChanged: (v) {
    setState(() {
      LocalCacheSync.userDefault.setWithKey<bool>('switch-A', v);
    });
  },
),

安装

添加你的pubspec.yaml

  path_provider: ^1.4.5
  local_cache_sync: ^1.1.0

然后设置路径：

1.2.0之后，我加上了一个可选全局的标志符号可以用来帮助你进行切换

注意！升级到1.2.0会导致同样的代码无法读取之前的数据。

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  LocalCacheSync.instance.setCachePath(
    await getTemporaryDirectory(),
    'my_example_app/',
  );
  runApp(MyApp());
}

更早版本的用法(less than or equal to 1.1.1):

getTemporaryDirectory().then((uri) {
      LocalCacheSync.instance.setCachePath(uri.path);
});

用户偏好设置缓存

使用local_cache_sync实现保存用户自定义设置非常简单，只需要赋值与取值，无需异步等待，即可保存参数到本地。
读取参数也是同步的，这意味着你可以在StatelessWidget中立即使用数据。

使用函数调用：

保存数据

LocalCacheSync.userDefault.setWithKey<bool>('isDarkMode',true);
LocalCacheSync.userDefault.setWithKey<String>('token','aabbccdd');
LocalCacheSync.userDefault.setWithKey<Map>('x-config',{'id':1243});

读取数据

var res = LocalCacheSync.userDefault.getWithKey<bool>('isDarkMode');
var res = LocalCacheSync.userDefault.getWithKey<String>('token');
var res = LocalCacheSync.userDefault.getWithKey<Map>('x-config');

使用操作符:

保存数据

LocalCacheSync.userDefault['isDarkMode'] = true;
LocalCacheSync.userDefault['token'] = 'aabbccdd';
LocalCacheSync.userDefault['x-config'] = {'id':1243};

读取数据

bool res = LocalCacheSync.userDefault['isDarkMode'];
String res = LocalCacheSync.userDefault['token'];
Map res = LocalCacheSync.userDefault['x-config'];

DefaultValueCache：更方便的本地储存写法

很多时候我们的用户设置是聚合在一起的，所以我添加了DefaultValueCache类，可以很方便的管理用户设置情况。

先写一个自定一个类，我们的用户偏好设置就通过这个类操作，这次我们存一个bool类型的autoLogin参数，默认是false。

class ProjectCustomUserDefault {
  static var autoLogin = const DefaultValueCache<bool>('autoLogin', false);
}

然后这样使用：

// save
ProjectCustomUserDefault.autoLogin.value = true;
// read
bool isAutoLogin = ProjectCustomUserDefault.autoLogin.value

这样就也不需要考虑默认值的问题了，只需要把需要存取操作的数据当作一个普通变量，然后正常使用即可。

管理一组数据缓存

如果你需要管理一系列值，请使用LocalCacheLoader，只需要一个channel标志，你就可以管理一系列值。

懒加载

LocalCacheLoader在内部实现了懒加载的效果：只有取value属性时数据才真正被加载。

在应用中，加入你有1-100号设备显示在Listview.builder中，只有100号设备即将进入屏幕中时，100号设备的缓存参数才会被真正加载。也就是说LocalCacheLoader不会导致长列表卡顿。

Model例子

我推荐你这样创建你的model:

class Device {
  final String uuid;
  final String name;
  final int type;

  Device({
    this.uuid,
    this.name,
    this.type,
  });

  Device.formJson(Map<String, dynamic> map)
      : this(
          uuid: map['uuid'],
          name: map['name'],
          type: map['type'],
        );

  static LocalCacheLoader get _loader => LocalCacheLoader('device');

  static List<Device> all() {
    return _loader.all
        .map<Device>(
          (cache) => Device.fromJson(cache),
        )
        .toList();
  }

  LocalCacheObject save() {
    return Device._loader.saveById(uuid, jsonMap);
  }

  Map<String, dynamic> get jsonMap => {
        'uuid': uuid,
        'name': name,
        'type': type,
      };
}

你也可以另外封装loader来读写其他信息，对于轻量级的储存，以上是非常简单易用的。

警告

不要在io密集型场景使用local_cache_sync，例如即时储存每秒10次的扫描结果。
虽然flutter中阻塞主线程不会导致UI卡顿，但是你仍不应当在io密集型场景使用，这超出了local_cache_sync设计的工作范围。