iActiveRecord 技术文档

本文档将详细介绍如何安装、使用以及项目API的调用方法，帮助您更好地理解并利用 iActiveRecord 进行开发。

1. 安装指南

iActiveRecord 支持使用 CocoaPods 进行安装。

使用 CocoaPods 安装

1. 在您的项目根目录中创建一个 Podfile 文件（如果尚未创建）。

2. 在 Podfile 文件中添加以下内容：

   source 'https://github.com/CocoaPods/Specs.git'
   platform :ios, '9.0'
   
   target 'YourProjectName' do
     pod 'iActiveRecord'
   end
   

3. 运行以下命令安装依赖：

   pod install
   

4. 使用 iActiveRecord.xcworkspace 打开您的项目。

2. 项目的使用说明

iActiveRecord 是一个轻量级的 ORM 框架，用于简化 iOS 数据库操作。以下是基本的使用步骤：

定义模型

创建一个继承自 ActiveRecord 的类，定义属性。

@interface User : ActiveRecord

@property (nonatomic, retain) NSString *name;

@end

数据库迁移

iActiveRecord 支持数据库迁移，您可以创建迁移文件来修改数据库结构。

+ (void)migrate
{
    AR::Migration.create_table("users") do |t|
        t.string :name
    end
}

数据验证

iActiveRecord 支持数据验证，您可以自定义验证器。

@interface User : ActiveRecord

@property (nonatomic, retain) NSString *name;

+ (BOOL)validate:(NSMutableDictionary *)record;
@end

@implementation User

+ (BOOL)validate:(NSMutableDictionary *)record
{
    if (![record[@"name"] length]) {
        [record addErrorForKey:@"name" message:@"Name cannot be empty"];
        return NO;
    }
    
    return YES;
}

数据操作

iActiveRecord 提供了丰富的数据操作方法，例如创建、读取、更新和删除。

// 创建
User *user = [User create];
user.name = @"John Doe";
[user save];

// 读取
User *user = [User findFirst];

// 更新
user.name = @"Jane Doe";
[user save];

// 删除
[user delete];

3. 项目API使用文档

iActiveRecord 提供了以下 API：

• create: 创建一个新的记录。
• findFirst: 查找第一个匹配的记录。
• findAll: 查找所有匹配的记录。
• save: 保存记录。
• delete: 删除记录。
• validate: 验证记录。
• migrate: 执行数据库迁移。

更多 API 信息，请参考官方文档。

4. 项目安装方式

如前所述，iActiveRecord 支持使用 CocoaPods 进行安装。以下是安装步骤：

1. 在项目根目录创建一个 Podfile 文件。
2. 在 Podfile 中添加 pod 'iActiveRecord'。
3. 运行 pod install 命令。
4. 使用 iActiveRecord.xcworkspace 打开项目。

以上就是 iActiveRecord 的技术文档，希望对您的开发有所帮助。