SAMKeychain 使用教程

2026-01-16 09:56:19作者：卓艾滢Kingsley

1、项目介绍

SAMKeychain 是一个简单的 Objective-C 包装器，用于在 Mac 和 iOS 上使用系统 Keychain 访问账户、获取密码、设置密码和删除密码。它简化了 Keychain 的复杂 C API，使得在应用程序中使用 Keychain 变得更加容易。

2、项目快速启动

安装 SAMKeychain

使用 CocoaPods

在你的 Podfile 中添加以下内容：

pod 'SAMKeychain'

然后运行 pod install。

使用 Carthage

在你的 Cartfile 中添加以下内容：

github "soffes/SAMKeychain"

然后运行 carthage update。

手动添加

将 Security 框架添加到你的目标中。
将 SAMKeychain.h、SAMKeychain.m、SAMKeychainQuery.h 和 SAMKeychainQuery.m 添加到你的项目中。

基本使用

以下是一些基本的 Keychain 操作示例：

获取所有账户

NSArray *accounts = [SAMKeychain allAccounts];

获取特定服务的账户

NSArray *accounts = [SAMKeychain accountsForService:@"MyService"];

获取密码

NSString *password = [SAMKeychain passwordForService:@"MyService" account:@"user@example.com"];

设置密码

[SAMKeychain setPassword:@"secret" forService:@"MyService" account:@"user@example.com"];

删除密码

[SAMKeychain deletePasswordForService:@"MyService" account:@"user@example.com"];

3、应用案例和最佳实践

生成唯一设备号

在某些情况下，你可能需要生成一个唯一的设备标识符。SAMKeychain 可以帮助你实现这一点，因为它可以在应用卸载后仍然保留数据。

+ (NSString *)getUniqueDeviceIdentifier {
    NSString *service = @"com.example.app";
    NSString *account = @"deviceIdentifier";
    NSString *uuid = [SAMKeychain passwordForService:service account:account];
    if (!uuid) {
        uuid = [[NSUUID UUID] UUIDString];
        [SAMKeychain setPassword:uuid forService:service account:account];
    }
    return uuid;
}

错误处理

在使用 Keychain 时，错误处理非常重要。以下是一个错误处理的示例：

NSError *error = nil;
SAMKeychainQuery *query = [[SAMKeychainQuery alloc] init];
query.service = @"MyService";
query.account = @"user@example.com";
[query fetch:&error];
if (error) {
    NSLog(@"Error: %@", [error localizedDescription]);
}