可能是Flutter上最简单的本地数据保存方案

时间：2024-03-17 22:37:35

简介

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

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

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

 

例子

使用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

初始化设置路径

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\'];

广州包装设计公司http://www.maiqicn.com 电脑刺绣绣花厂 ttp://www.szhdn.com

管理一组数据缓存

如果你需要管理一系列值，请使用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设计的工作范围。

 

仓库与Pub地址

如果有问题，可以在github上issue或者pr。

PUB地址（可以赞一下）
Github仓库