Flutter iCloud键值存储插件icloud_kv_storage的使用

icloud_kv_storage 是一个基于iCloud的轻量级键值存储Flutter插件，支持在多个iOS和Mac设备之间同步数据。当前版本仅支持字符串类型的数据同步。

开始使用

安装插件

首先，在你的 pubspec.yaml 文件中添加 icloud_kv_storage 依赖：

dependencies:
  flutter:
    sdk: flutter
  icloud_kv_storage: ^0.0.1

然后运行以下命令安装依赖：

flutter pub get

初始化与配置

确保你的项目已经为iOS平台进行了设置，并且已在Apple开发者平台上启用了iCloud功能。

示例代码

以下是一个完整的示例应用，展示了如何使用 icloud_kv_storage 插件进行计数器同步。

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

var iCloudStorage = CKKVStorage();

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  var key = 'k_storage_count';
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
      iCloudStorage.writeString(key: key, value: _counter.toString());
    });
  }

  void _clearCounter() {
    setState(() {
      _counter = 0;
      iCloudStorage.delete(key);
    });
  }

  @override
  void initState() {
    super.initState();
    
    // 监听iCloud数据更新
    iCloudStorage.onCloudKitKVUpdateCallBack(
      onCallBack: (kvMap) {
        print('receive icloud_key_update');
        if (kvMap[iCloudStorage.getRealKey('k_storage_count')] != null) {
          setState(() {
            _counter = int.parse(kvMap[iCloudStorage.getRealKey('k_storage_count')]);
          });
        } else {
          setState(() {
            _counter = 0;
          });
        }
      },
    );

    // 初始化时从iCloud读取计数值
    iCloudStorage.getString('k_storage_count').then((value) {
      if (value != null) {
        setState(() {
          _counter = int.parse(value);
        });
      }
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'iCloud Sync Count:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButtonLocation: FloatingActionButtonLocation.centerFloat,
      floatingActionButton: Row(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          FloatingActionButton(
            onPressed: _incrementCounter,
            tooltip: 'Increment',
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: const [
                Icon(Icons.add),
                Text('add'),
              ],
            ),
          ),
          const SizedBox(width: 15),
          FloatingActionButton(
            onPressed: _clearCounter,
            tooltip: 'Clear',
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: const [
                Icon(Icons.cleaning_services),
                Text('clear'),
              ],
            ),
          ),
        ],
      ),
    );
  }
}

关键点说明

• 初始化：通过 CKKVStorage() 创建一个存储实例。
• 写入数据：使用 writeString 方法将数据写入iCloud。
• 监听更新：使用 onCloudKitKVUpdateCallBack 方法监听iCloud中的数据更新。
• 读取数据：使用 getString 方法从iCloud读取数据。

以上示例展示了一个简单的计数器应用，该应用能够在不同设备之间同步计数器的值。希望这个示例能帮助你快速上手 icloud_kv_storage 插件的使用。