iOS二进制调试方案

前言

前段时间我们项目也完全实现了组件化，在组件化过程中，为了能够提高项目的编译速度，我们将组件全部打成二进制，但其实也暴露出另外一个问题：那些使用二进制的组件无法像源码调试那样看到调试信息，当然我们也可以通过iBiu来切换源码，但每次切换都需要执行pod install，而且每切换一次都要重新编译一次，在追查偶现问题时，开发体验很不友好，因此cocoapod-otssource这个插件就诞生了。

效果演示

图一为二进制组件断点效果：只能看到该组件的堆栈信息和一些汇编代码

图1

图二为二进制组件切换成源码后的断点效果：可以定位到具体断点代码

图2

分析

Build Settings有个设置Generate debug Symbols,如果设置成Yes的话，二进制文件中就会包含一个_debug_str的字段，这个字段就是源码文件的存放地址，我们可以验证一下：

dwarfdump ./OTSBaseKitModule | grep 'OTSProtocolAnalysis'

控制台打印出：

DW_AT_decl_file ("/var/tmp/iBiu_release/OTSBaseKitModule/App-Lint/OTSBaseKitModule/Classes/Router/OTSProtocolAnalysis.h")

OTSProtocolAnalysis源文件就放在这个地址下面

/var/tmp/iBiu_release/OTSBaseKitModule/App-Lint/OTSBaseKitModule/Classes/Router/OTSProtocolAnalysis.h

Debug调试的时候，编译器会先从这里拿对应地址去加载源码，如果对应地址存在源码文件时，就能进入源码调试，否则就不行

我们还可以通过MachOview这个工具来查看二进制文件中_debug_str是否包含这个地址，如图所示：

图3

注意：当我们将组件内的Generate debug Symbols设置为No的话，即使是源码，也无法进行源码调试

cocoapod-otssource原理

通过上面的分析我们知道，只要_debug_str里面对应地址存在源码文件，就可以进行调试。接下来要做的事就很简单了：

1.我们发现二进制编译目录都是相同的，即都在/var/tmp/iBiu_release下面，这样就很方便在该目录下统一管理下载的源码文件

2.通过dwarfdump命令来获取源码文件所在目录，然后通过Cocoapods Plugins 给Cocoapods增加下载命令，将源码文件下载并放在对应路径中

cocoapod-otssource下载源码插件

安装Cocoapods Plugins

要开始开发一个新的插件，你还需要安装cocoapods-plugins :

gem install cocoapods-plugins

创建Cocoapods Plugins

运行下面的命令就可以生成一个插件模板工程

pod plugins create otssource

工程目录是这样的：

工程目录

.gemspec文件是插件的主要配置文件，我们需要配置一下：

Gem::Specification.new do |spec|
  spec.name          = 'cocoapods-otssource'
  spec.version       = '0.0.2'
  spec.authors       = ['nickwang1202']
  spec.email         = ['wdc1906231682@163.com']
  spec.description   = %q{二进制源码切换插件}
  spec.summary       = %q{指定源码podname，tag拉取源文件}
  spec.homepage      = 'https://rubygems.org/gems/cocoapods-otssource'
  spec.license       = 'MIT'

  spec.files = Dir['lib/**/*']
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ['lib']

  spec.add_development_dependency 'bundler', '~> 1.3'
  spec.add_development_dependency 'rake'
end

构建Cocoapods Plugins

使用以下命令会对插件进行编译，同时会生成一个产物Cocoapods-otssource-0.0.1.gem

gem build cocoapods-otssource.gemspec

执行这个命令之后，你将看到'Successfully built RubyGem'的成功消息

实现下载插件

添加新命令非常简单。您只需要创建command类的子类。打开lib/cocoapods-githooks/command/otssource.rb，在这里面添加下载源码代码:

def run
      add
end

def add
        if @pod_name == nil or @tag == nil
          help! 'A pod name and tag is required.'
          return
        end

        UI.puts "开始下载源码#{@pod_name}-#{@tag}"

        target_path = "/var/tmp/iBiu_release/#{@pod_name}/App-Lint"
        FileUtils.rm_rf(target_path)
        options = {:git => "https://git.jd.com/onethestore/#{@pod_name}.git",:tag => @tag}
        options = Pod::Downloader.preprocess_options(options)
        downloader = Pod::Downloader.for_target(target_path,options)
        downloader.download
        downloader.checkout_options

        UI.puts "源码下载成功"
      end

先构建这个gem：

gem build cocoapods-otssource.gemspec

安装并运行：

sudo install cocoapods-otssource.-0.0.1.gem

执行下面这条命令来确保插件安装成功：

pod plugins installed

测试插件

打开Podfile，在开头添加:

plugin 'cocoapods-otssource'

然后pod install，接下来我们就可以在工程中测试了，执行以下命令就可以将OTSBaseKitModule这个源码下载下来了：

pod otssource OTSBaseKitModule 1.0.4-beta1

控制台输出以下信息代表下载成功:

结果

发布插件

首先，需要到rubyGem官网注册一个账号，然后执行以下命令：

curl -u ***** https://rubygems.org/api/v1/api_key.yaml  # ***** 为你的用户名

紧接着输入密码，回车之后便会得到一个api_key。
接着在gem文件夹中输入下面的指令：

gem push cocoapods-otssource-0.0.2.gem   

push成功之后终端显示：

Pushing gem to https://rubygems.org...
Successfully registered gem: cocoapods-otssource (0.0.2)

此时说明已经发布到rubygems成功，其他人直接使用:

gem install cocoapods-otssource