Drafter 项目使用教程

Drafter 项目使用教程

Drafter 在iOS项目中自动生成类图和方法调用图 - Generate call graph in iOS project 项目地址: https://gitcode.com/gh_mirrors/dr/Drafter

1. 项目介绍

Drafter 是一个命令行工具，用于分析 iOS 工程的代码，支持 Objective-C 和 Swift。它能够自动解析代码并生成方法调用关系图和类继承关系图。Drafter 的主要功能包括：

• 自动生成方法调用关系图：帮助开发者快速理解代码中的方法调用流程。
• 自动生成类继承关系图：展示类之间的继承关系，帮助开发者理解类的层次结构。

2. 项目快速启动

安装 Drafter

执行以下指令，Drafter 会自动安装到 /usr/local/bin 目录中：

curl "https://raw.githubusercontent.com/L-Zephyr/Drafter/master/install.sh" | /bin/sh

或者直接下载并编译源码。

基本使用

指定一个文件或文件夹，Drafter 会自动解析所有的 OC 和 Swift 代码文件，解析各个类型中方法的调用流程以及类型之间的继承关系，并以图表的形式展现出来。

导出 HTML 在浏览器中查看

以 AFNetworking 的源码为例，在命令行中执行如下命令，在参数 -f 后输入文件或目录：

drafter -f /path/to/AFNetworking

解析结果会输出到当前路径下的 DrafterStage 文件夹中，用浏览器打开 /DrafterStage/index.html 文件即可浏览。建议使用 Chrome 浏览器。

导出为 PNG

如果要导出为 PNG 图片，首先确保电脑中安装了 Graphviz，可以直接通过 Homebrew 来安装：

brew install graphviz

生成方法调用关系图，以 AFNetworking 为例，在命令后面使用 -t 参数指定输出类型为 png，如：

drafter -f /path/to/AFHTTPSessionManager.m -t png

在当前位置会自动生成一张以 "文件名+.png" 格式来命名的图片。

3. 应用案例和最佳实践

案例一：分析大型项目的代码结构

在大型 iOS 项目中，代码结构复杂，方法调用关系错综复杂。使用 Drafter 可以快速生成方法调用关系图和类继承关系图，帮助开发者理清代码逻辑，提高代码的可维护性。

案例二：代码重构前的分析

在进行代码重构之前，使用 Drafter 生成当前代码的方法调用关系图和类继承关系图，可以帮助开发者更好地理解代码结构，制定更合理的重构方案。

4. 典型生态项目

1. AFNetworking

AFNetworking 是一个广泛使用的 iOS 网络库。使用 Drafter 可以生成 AFNetworking 的方法调用关系图和类继承关系图，帮助开发者更好地理解其内部实现。

2. Alamofire

Alamofire 是 Swift 语言下的一个网络库，与 AFNetworking 类似。使用 Drafter 可以生成 Alamofire 的方法调用关系图和类继承关系图，帮助 Swift 开发者更好地理解其内部实现。

通过以上步骤，您可以快速上手使用 Drafter 工具，并利用其强大的功能来分析和理解 iOS 项目的代码结构。

Drafter 在iOS项目中自动生成类图和方法调用图 - Generate call graph in iOS project 项目地址: https://gitcode.com/gh_mirrors/dr/Drafter