SDCloudUserDefaults 技术文档

1. 安装指南

1.1 使用 CocoaPods 安装

在您的 Podfile 文件中添加以下内容：

pod 'SDCloudUserDefaults'

保存并运行 pod install 命令即可完成安装。

1.2 使用 Carthage 安装

在您的 Cartfile 文件中添加以下内容：

github "sdarlington/SDCloudUserDefaults"

然后按照 Carthage 的官方文档进行操作，将编译好的框架添加到您的项目中。

1.3 作为依赖库添加

如果您使用的是 iOS 5 及以上版本，并且支持 ARC，可以按照以下步骤操作：

1. 将 SDCloudUserDefaults.xcodeproj 文件拖到您的项目中。
2. 切换到项目的 "Build Phases" 部分。
3. 将 SDCloudUserDefaults 添加到 "Target Dependencies"。
4. 将 libSDCloudUserDefaults.a 添加到 "Link Binary With Libraries"。

1.4 手动添加文件

将 SDCloudUserDefaults.h 和 SDCloudUserDefaults.m 文件复制到您的项目中。

2. 项目的使用说明

SDCloudUserDefaults 是一个用于同时存储 NSUserDefaults 和 iCloud 数据的库。它遵循 NSUbiquitousKeyValueStore 的建议，将本地存储的配置值与 iCloud 同步。

2.1 基本使用

与 NSUserDefaults 不同，SDCloudUserDefaults 的所有方法都是类方法，因此不需要获取 standardUserDefaults。以下是一些基本的使用示例：

// 获取字符串
NSString *value = [SDCloudUserDefaults stringForKey:@"myKey"];

// 设置字符串
[SDCloudUserDefaults setString:@"myValue" forKey:@"myKey"];

// 删除对象
[SDCloudUserDefaults removeObjectForKey:@"myKey"];

// 同步数据
[SDCloudUserDefaults synchronize];

2.2 注册通知

为了确保从 iCloud 获取更新，您需要在应用启动时注册通知：

[SDCloudUserDefaults registerForNotifications];

3. 项目API使用文档

3.1 常用方法

• + (NSString *)stringForKey:(NSString *)aKey;

  • 获取指定键的字符串值。

• + (void)setString:(NSString *)aString forKey:(NSString *)aKey;

  • 设置指定键的字符串值。

• + (void)removeObjectForKey:(NSString *)aKey;

  • 删除指定键的对象。

• + (void)synchronize;

  • 同步本地数据。

• + (void)registerForNotifications;

  • 注册通知以接收 iCloud 更新。

3.2 其他数据类型

除了字符串，SDCloudUserDefaults 还支持以下数据类型的操作：

• bool
• object
• integer

4. 项目安装方式

项目支持以下四种安装方式：

1. CocoaPods：通过 Podfile 文件安装。
2. Carthage：通过 Cartfile 文件安装。
3. 作为依赖库添加：将项目文件拖入 Xcode 并配置依赖。
4. 手动添加文件：将源文件直接复制到项目中。

通过以上步骤，您可以轻松地将 SDCloudUserDefaults 集成到您的项目中，并实现 NSUserDefaults 和 iCloud 数据的同步存储。