Flutter云端存储插件jingluo_icloud_storage的使用

Flutter云端存储插件jingluo_icloud_storage的使用

flutter 云端存储

效果图

开始使用

1. 项目配置

2. 使用

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  jingluo_icloud_storage: <latest_version>

导入插件：

import 'package:jingluo_icloud_storage/jingluo_icloud_storage.dart';

使用方式如下：

检查是否支持iCloud

var res = await JingluoIcloudStorage().isICloudEnabled();

返回结果如下：

// 成功
{msg: Success, code: 0}

// 失败
{msg: error, code: -1}

获取值

获取值时，如果拿不到key对应的value，则返回null。可以选择获取指定类型的value，获取不到则为null。

var res = await JingluoIcloudStorage().getValue(key: "localValue");

返回结果如下：

// 成功
{msg: 138, code: 0}

// 失败
{msg: error, code: -1}

可选值类型定义如下：

enum JingluoIcloudStorageType {
  string,
  array,
  dictionary,
  data,
  long,
  double,
  bool,
  none,
}

设置值

var res = await JingluoIcloudStorage().setValue(key: "count", value: 138);

返回结果如下：

// 成功
{msg: Success, code: 0}

// 失败
{msg: error, code: -1}

删除值

var res = await JingluoIcloudStorage().deleteValue(key: "localValue");

返回结果如下：

// 成功
{msg: Success, code: 0}

// 失败
{msg: error, code: -1}

监听值变化

JingluoIcloudStorage().registerEventListener(onEvent: (event) {
  if (event["key"] == JingluoIcloudStorageEventType.updateICloudStorage) {
    Map? map = event["payload"]["value"];
    if (map != null && map["count"] != null) {
      idx = map["count"];
    }
    setState(() {});
  }
});

返回结果如下：

// 成功
{payload: {code: 0, value: {count: 138}}, key: UPDATE_ICLOUD_STORAGE}

3. 常量

完整示例代码

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:jingluo_icloud_storage/jingluo_icloud_storage.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _jingluoIcloudStoragePlugin = JingluoIcloudStorage();

  final _key = "count";

  var idx = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    startNotification();
    initPlatformState();
  }

  void startNotification() {
    _jingluoIcloudStoragePlugin.registerEventListener(onEvent: (event) {
      if (event["key"] == JingluoIcloudStorageEventType.updateICloudStorage) {
        Map? map = event["payload"]["value"];
        if (map != null && map[_key] != null) {
          idx = map[_key];
        }
        setState(() {});
      }
    });
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    // We also handle the message potentially returning null.

    var res = await _jingluoIcloudStoragePlugin.isICloudEnabled();
    if (res?['code'] != 0) {
      return;
    }
    try {
      platformVersion =
          await _jingluoIcloudStoragePlugin.getPlatformVersion() ??
              'Unknown platform version';

      var res = await _jingluoIcloudStoragePlugin.getValue(key: _key);
      setState(() {
        if (res != null && res['code'] == 0) {
          idx = int.parse((res["msg"] ?? 0).toString());
        }
      });
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: [
              Text('Running on: $_platformVersion\n'),
              GestureDetector(
                onTap: () async {
                  var res = await _jingluoIcloudStoragePlugin.setValue(
                      key: "count", value: idx + 1);
                  if (res?['code'] == 0) {
                    setState(() {
                      idx++;
                    });
                  }
                },
                child: const Text("累加"),
              ),
              Text("当前的值：$idx")
            ],
          ),
        ),
      ),
    );
  }
}