OCRunner 开源项目教程

1、项目介绍

OCRunner 是一个用于 iOS 平台的热修复框架，允许开发者在不重新发布应用的情况下，动态修复应用中的 Bug。OCRunner 通过解释执行 Objective-C 代码的抽象语法树（AST）来实现热修复功能。它支持完整的 Objective-C 语法，包括结构体、枚举、系统 C 函数调用等，并且可以通过生成二进制补丁文件来提高安全性和减少补丁大小。

2、项目快速启动

2.1 环境准备

确保你已经安装了 Xcode 和 CocoaPods。

2.2 安装 OCRunner

在你的项目根目录下，打开终端并运行以下命令来安装 OCRunner：

pod 'OCRunner'

2.3 生成补丁文件

首先，你需要下载并安装 PatchGenerator 工具。你可以通过以下命令下载：

git clone --recursive https://github.com/SilverFruity/OCRunner.git

解压后，将 PatchGenerator 保存到 /usr/local/bin/ 或项目目录下。

2.4 添加 Run Script

在 Xcode 中，打开你的项目设置，进入 Build Phases，点击左上角的 + 按钮，选择 New Run Script Phase。在脚本区域添加以下内容：

$SRCROOT/OCRunnerDemo/PatchGenerator -files $SRCROOT/OCRunnerDemo/ViewController1 -refs $SRCROOT/OCRunnerDemo/Scripts.bundle -output $SRCROOT/OCRunnerDemo/binarypatch

2.5 运行补丁

在 AppDelegate.m 文件中，添加以下代码以在开发环境下运行补丁：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    #if DEBUG
    NSString *patchFilePath = [[NSBundle mainBundle] pathForResource:@"PatchFileName" ofType:nil];
    #else
    // 从服务器下载补丁文件
    #endif
    [ORInterpreter excuteBinaryPatchFile:patchFilePath];
    return YES;
}

3、应用案例和最佳实践

3.1 修复 Objective-C 对象方法

假设你有一个类 ORTestClassProperty，你可以在补丁文件中修复或添加方法：

@interface ORTestClassProperty:NSObject
@property (nonatomic, copy) NSString *strTypeProperty;
@end

@implementation ORTestClassProperty
- (void)otherMethod {
    self.strTypeProperty = @"Mango";
}
- (NSString *)testObjectPropertyTest {
    [self ORGtestObjectPropertyTest]; // 调用原方法
    [self otherMethod];
    return self.strTypeProperty;
}
@end

3.2 使用 Block 和 GCD

你可以在补丁文件中使用 Block 和 GCD：

__weak id object = [NSObject new];
void (^a)(void) = ^ {
    int b = 0;
};
a();

dispatch_queue_t queue = dispatch_queue_create("com.plliang19.mango", DISPATCH_QUEUE_SERIAL);
dispatch_async(queue, ^{
    completion(@"success");
});

4、典型生态项目

4.1 oc2mangoLib

oc2mangoLib 是一个简单的编译器，负责生成 Objective-C 代码的抽象语法树。它是 OCRunner 的核心组件之一。

4.2 ORPatchFile

ORPatchFile 负责将抽象语法树序列化、反序列化和版本判断，确保补丁文件的正确性和兼容性。

4.3 PatchGenerator

PatchGenerator 是 oc2mangoLib 和 ORPatchFile 的整合工具，用于生成二进制补丁文件。

通过以上步骤，你可以快速上手 OCRunner，并在实际项目中实现热修复功能。