iOS美团同款"ZSource"二进制调试实现

一、前言

前段时间我们项目也实现了组件的二进制化，在之前的技术周会中我们有提到跟美团同款ZSource的二进制调试能力，我们也在自己的Cocoapods-imy-bin插件上实现了相同的功能pod bin code，借助这个周会我们就再来一探究竟二进制是怎么实现调试的和插件pod bin code实现细节。

二、效果演示

image.png

三、原理

用 MachOViewer 来查看二进制文件，以获取到更友好的二进制信息。利用 MachOViewer，我们可以看到 “__debug_str” Section 这些信息都存在了二进制的中。__debug_str在编译的时候内部会记录源码地址

image.png

使用命令在终端输入：

代码语言：javascript复制

dwarfdump ./libIMYNews.a | grep 'IMYNewsRootViewController'
复制代码

一个DW_AT_name属性，其值是一个以空字符结尾的字符串，其中包含从其派生编译单元的主源文件的完整或相对路径名。

一个DW_AT_comp_dir属性，其值是一个以空值结尾的字符串，其中包含编译命令的当前工作目录，该编译命令以某种形式将Forelax视为主机系统，从而生成此编译单元。

换个通俗易懂的话说，二进制文件中记录了改源码文件对应的存放地址，IMYButton.m源文件存在在这个地址下

代码语言：javascript复制

/Users/ci/.jenkins/workspace/Meetyou_Dev-build-temp/bin-archive/Seeyou/IMYNews/IMYNews/Source/IMYNewsRootView/Controller/IMYNewsRootViewController.h

而这个地址是什么呢？其实就是我们制作二进制包时，该工程所属的文件地址。

image.png

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

如果不想暴露这个调试信息呢？在build Settings 里面搜索 Generate Debug Symbols设置为No，可以将 __debug_str 字段都给去掉。

image.png

四、实验

这里可能有的同学就会疑惑，你这样的调试信息跟我们平时的Debug调试会不会有区别，不够准确？

实验一、Xcode源码运行的调试

现在我们就来做个实验，看看平时Debug调试是怎么样的。

先正常使用源码运行，在某一行下个断点，看看正常的调试情况
把当前断点的所在文件目录重命名为其他路径
再运行到断点的地方试试，是否还能像步骤1一样进入源码调试断点？（显然不行）
再把步骤2重命名的目录改回去，再Control F7运行，这回又正常了。

在程序运行起来后，我们修改Pods库下的目录，等再次进入断点调试的时候，原理Xcode的源码调试突然变成了让人看不懂的汇编了，完全看不懂，看不懂。等你再次把目录修改回来后，又是你熟悉的那个Xcode。

即使是源码运行，调试的时候xcode也是根据我们的那套原理来的。

实验二、 Generate Debug Symbols设置为No

在源码运行的情况下，我把 IMYNews这个模块Generate Debug Symbols设置为No，后面不管再怎么使劲，断点也进不去

五、源码调试Cocoapods插件的实现

通过上面的原理分析我们知道，只要存在二进制静态库记录源码对应的文件就可以进入断点调试，但是Pods仓库是源码在远程怎么调试呢？如何知道我当前运行的静态库对应哪个版本的源码呢？

image.png

熟悉了Cocoapods一些原理后，找出依赖库代码就这几行。

代码语言：javascript复制

#找出依赖
def find_dependency (name)
    find_dependency = nil
    @config.podfile.dependencies.each do |dependency|
    if dependency.root_name.downcase == name.downcase
      find_dependency = dependency
          break
      end
     end
     find_dependency
 end

# 获取external_source 下的仓库
# @return spec
def fetch_external_source(dependency ,podfile , lockfile, sandbox,use_lockfile_options)
          source =          ExternalSources.from_dependency(dependency, podfile.defined_in_file, true)
          source.fetch(sandbox)
end

下载对应源码

代码语言：javascript复制

#下载源码到本地
def download_source(name)
  target_path =  File.join(source_root, name)
  UI.puts target_path
  FileUtils.rm_rf(target_path)

  find_dependency = find_dependency(name)
  spec = fetch_external_source(find_dependency, @config.podfile,@config.lockfile, @config.sandbox,true )
  download_request = Pod::Downloader::Request.new(:name => name, :spec => spec)
  Downloader.download(download_request, Pathname.new(target_path), :can_cache => true)

  target_path
end

创建软链接

代码语言：javascript复制

ln -s target_path dir

六、最后：

有些东西就像变魔术一样，台下看得云里雾里的，实际上点破之后，就会有种感觉，原来就这么回事而已~。

七、参考文献

iOS Xcode 的汇编模式切换

美团 iOS 工程 zsource 命令背后的那些事儿

作者：Mr_Coder 链接：https://juejin.im/post/5f066cfa5188252e893a136e 来源：掘金

xcode 打包 cocoa ios

0 人点赞