OCRunner 项目教程

1. 项目目录结构及介绍

OCRunner 项目的目录结构如下：

OCRunner/
├── OCRunner.xcodeproj
├── OCRunner
│   ├── Classes
│   ├── Resources
│   └── ...
├── OCRunnerDemo
│   ├── ViewController1
│   ├── Scripts
│   └── ...
├── OCRunnerTests
│   └── ...
├── oc2mango
│   └── ...
├── README-CN.md
├── README.md
├── LICENSE
└── ...

目录结构介绍

• OCRunner.xcodeproj: Xcode 项目文件，包含 OCRunner 的核心代码和测试代码。
• OCRunner: 核心代码目录，包含 OCRunner 的主要功能实现。
  • Classes: 核心类文件，包含解释器和补丁生成器的实现。
  • Resources: 资源文件，可能包含一些配置文件或静态资源。
• OCRunnerDemo: 示例项目目录，包含如何使用 OCRunner 的示例代码。
  • ViewController1: 示例代码文件，展示了如何使用 OCRunner 进行热修复。
  • Scripts: 脚本文件，可能包含一些用于生成补丁的脚本。
• OCRunnerTests: 测试代码目录，包含 OCRunner 的单元测试代码。
• oc2mango: 子模块目录，包含 oc2mango 编译器的实现。
• README-CN.md: 中文项目介绍文档。
• README.md: 英文项目介绍文档。
• LICENSE: 项目许可证文件。

2. 项目启动文件介绍

OCRunner 项目的启动文件主要位于 OCRunnerDemo 目录下。以下是主要的启动文件介绍：

AppDelegate.m

AppDelegate.m 是 iOS 应用程序的入口文件，负责应用程序的生命周期管理。在 OCRunnerDemo 中，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;
}

ViewController1.m

ViewController1.m 是 OCRunnerDemo 中的一个示例视图控制器，展示了如何使用 OCRunner 进行热修复。该文件中包含以下关键代码：

@implementation ViewController1

- (void)viewDidLoad {
    [super viewDidLoad];
    // 使用 OCRunner 执行补丁
    NSString *patchFilePath = [[NSBundle mainBundle] pathForResource:@"PatchFileName" ofType:nil];
    [ORInterpreter excuteBinaryPatchFile:patchFilePath];
}

@end

3. 项目的配置文件介绍

OCRunner 项目的配置文件主要位于 OCRunner.xcodeproj 和 OCRunnerDemo 目录下。以下是主要的配置文件介绍：

Podfile

Podfile 是 CocoaPods 的配置文件，用于管理项目的依赖库。OCRunner 的 Podfile 可能包含以下内容：

platform :ios, '9.0'
use_frameworks!

target 'OCRunnerDemo' do
  pod 'OCRunner'
end

PatchGenerator

PatchGenerator 是一个用于生成补丁文件的脚本。在 OCRunnerDemo 项目中，可以通过以下方式配置 PatchGenerator：

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

Run Script

在 Xcode 项目中，可以通过 Run Script 阶段来配置 PatchGenerator。在 Build Phases 中添加一个新的 Run Script 阶段，并添加以下内容：

[Path to PatchGenerator file] -files [Objective-C source files or directory] -refs [Objective-C header files or directory] -output [Path to save the patch]

例如：

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

通过以上配置，可以在开发环境中自动生成补丁文件，并在应用程序启动时加载补丁文件。