Flutter云服务集成插件flutter_cloud_kit的使用

flutter_cloud_kit 是一个简单的Flutter插件，用于在iOS设备上与Apple Cloud Kit API进行交互。以下是该插件的功能和支持的操作。

功能支持

• getAccountStatus - 获取用户账户状态；
• saveRecord - 保存记录；
• getRecord - 通过键获取记录；
• getRecordsByType - 通过类型获取记录；
• deleteRecord - 通过键删除记录。

使用方法

创建 FlutterCloudKit 实例

FlutterCloudKit cloudKit = FlutterCloudKit(containerId: exampleContainerId);

containerId 参数是可选的。如果不提供，则会使用默认容器。

获取账户状态

CloudKitAccountStatus accountStatus = await cloudKit.getAccountStatus();

保存记录

await cloudKit.saveRecord(
    scope: CloudKitDatabaseScope.private, 
    recordType: exampleRecordType, 
    record: {'fieldName': 'fieldValue'}, 
    recordName: 'RecordName'
);

获取记录

CloudKitRecord record = await cloudKit.getRecord(
    scope: CloudKitDatabaseScope.private, 
    recordName: 'RecordName'
);

通过类型获取记录

List<CloudKitRecord> records = await cloudKit.getRecordsByType(
    scope: CloudKitDatabaseScope.private, 
    recordType: exampleRecordType
);

删除记录

await cloudKit.deleteRecord(
    scope: CloudKitDatabaseScope.private, 
    recordName: 'RecordName'
);

设置

在开始使用插件之前，需要执行以下步骤：

1. 在Xcode项目中添加iCloud功能。
2. 在Xcode中创建将要使用的容器。
3. 选择CloudKit复选框。
4. 检查容器名称旁边的复选框。

此外，为了能够按类型检索记录，您需要在CloudKit数据库中添加一些索引。

示例代码

下面是一个完整的示例应用程序，展示了如何使用flutter_cloud_kit插件：

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter_cloud_kit/flutter_cloud_kit.dart';
import 'package:flutter_cloud_kit/types/cloud_ket_record.dart';
import 'package:flutter_cloud_kit/types/database_scope.dart';

const exampleContainerId = "iCloud.flutter_cloud_kit_example";
const exampleRecordType = "ExampleRecordType";
const databaseScope = CloudKitDatabaseScope.private;

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

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

  @override
  State<FlutterCloudKitExample> createState() => _FlutterCloudKitExampleState();
}

class _FlutterCloudKitExampleState extends State<FlutterCloudKitExample> {
  TextEditingController recordName = TextEditingController();
  TextEditingController key = TextEditingController();
  TextEditingController value = TextEditingController();
  FlutterCloudKit cloudKit = FlutterCloudKit(containerId: exampleContainerId);
  List<String> fetchedRecordsText = [];

  final _scaffoldKey = GlobalKey<ScaffoldState>();

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        key: _scaffoldKey,
        appBar: AppBar(
          title: const Text('Flutter cloud kit example'),
        ),
        body: Column(
          children: [
            TextFormField(controller: recordName, decoration: const InputDecoration(hintText: 'Record name')),
            TextFormField(controller: key, decoration: const InputDecoration(hintText: 'Key')),
            TextFormField(controller: value, decoration: const InputDecoration(hintText: 'Value')),
            ElevatedButton(
              onPressed: () async {
                var record = {key.text: value.text};
                try {
                  await cloudKit.saveRecord(scope: databaseScope, recordType: exampleRecordType, record: record, recordName: recordName.text);
                  _debugMessage('Successfully saved the record $record');
                } catch (e) {
                  _debugMessage('Failed to save the record: $e');
                }
              },
              child: const Text('Save'),
            ),
            ElevatedButton(
              onPressed: () async {
                var name = recordName.text;
                try {
                  var fetchedRecord = await cloudKit.getRecord(scope: databaseScope, recordName: name);
                  fetchedRecordsText = ['Fetched record:', _recordToString(fetchedRecord)];
                  _debugMessage('Successfully got the record by name $name');
                  setState(() {});
                } catch (e) {
                  _debugMessage('Error getting record by name $name: $e');
                }
              },
              child: const Text('Get'),
            ),
            ElevatedButton(
              onPressed: () async {
                try {
                  var fetchedRecordsByType = await cloudKit.getRecordsByType(scope: databaseScope, recordType: exampleRecordType);
                  fetchedRecordsText = ['Fetched records:'];
                  fetchedRecordsText.addAll(fetchedRecordsByType.map((e) => _recordToString(e)));
                  _debugMessage('Successfully got ${fetchedRecordsByType.length} records by type');
                  setState(() {});
                } catch (e) {
                  _debugMessage("Error getting records by type: $e");
                }
              },
              child: const Text('Get all records by type'),
            ),
            ElevatedButton(
              onPressed: () async {
                var name = recordName.text;
                try {
                  await cloudKit.deleteRecord(scope: databaseScope, recordName: name);
                  _debugMessage('Successfully deleted record by name $name');
                } catch (e) {
                  _debugMessage('Error deleting the record $name: $e');
                }
              },
              child: const Text('Delete'),
            ),
            ElevatedButton(
              onPressed: () async {
                var accountStatus = await cloudKit.getAccountStatus();
                _debugMessage('Current account status: $accountStatus');
              },
              child: const Text('Get account status'),
            ),
            Column(children: fetchedRecordsText.map((e) => Text(e, textAlign: TextAlign.center)).toList()),
          ],
        ),
      ),
    );
  }

  void _debugMessage(String message) {
    debugPrint(message);
    ScaffoldMessenger.of(_scaffoldKey.currentContext!).showSnackBar(SnackBar(content: Text(message)));
  }
}

String _recordToString(CloudKitRecord record) {
  var obj = {'recordType': record.recordType, 'recordName': record.recordName, 'values': record.values};
  return jsonEncode(obj);
}

以上示例展示了一个基本的Flutter应用，演示了如何使用flutter_cloud_kit插件来保存、获取、删除记录以及获取账户状态。请根据您的具体需求进行修改和扩展。