Cocoapods 源码浅析 - 一些 Tips

在整个源码阅读中,发现很多值得学习的地方,放在某一篇中又不合适,全都汇总在这里吧。

环境信息
Cocoapods 1.9.0.beta.2 (f1293b7)
Core 1.9.0.beta.2 (95e133d)


Podfile 解析

最开始在 Podfile 解析最佳实践 中,通过自定义的 pod 等方法,解析 Podfile,从而获取 Podfile 中,每个 pod 的信息。当时有一点没做好:关于解析方法的注入。

起初的做法是这样的:将文件分为了三段,分别是 header.rbPodfilefooter.rb。定义如下:

# header.rb
$map = {}

def target(target_name = nil, &block = nil)
yield if block_given?
end

def pod(pod_name, version = nil, **args)
git = args[:git]
end

def method_missing(m, *args); end

# -----------------------------------------------

#footer.rb
File.open($result_path, "w") do |f|
f.write(JSON.pretty_generate($map))
end

不难看出,为了职责清晰,整个解析分为了三个文件,而且最终执行的时候,需要将三个文件按顺序拼接,然后 eval。除此之外,还有一个弊端:本来解析 Podfile 的脚本就是用 Ruby 写的,最好的通信方式当然是解析完以后,返回一个 map 对象就好。但是在 footer.rb 中可以看到,最后是通过导出文件的形式处理的。

在看 Cocoapods 源码时,发现当初遗漏了一个很重要的点(源码位于 Core/lib/cocoapods-core/podfile.rb 中):include。源码中,Cocoapods 解析 Podfile 是这样的:

Podfile DSL

首先,将 Podfile 中的方法定义在了 Pod::Podfile::DSL 中(Core/lib/cocoapods-core/podfile/dsl.rb),比如上文提到的 podtarget 这些方法。

Podfile eval

podfile.rb 中,读取 Podfile 并执行:

include Pod::Podfile::DSL

contents = File.open(path, 'r:utf-8', &:read)
eval(contents, nil, path.to_s)

一气呵成,完全不用像之前一样拆成多个文件拼拼拼,也不用生成中间文件来存储和通信。那么 include 是什么呢?可以简单的理解为 Objective-C 中的 Category,但实际 Ruby 除了 include,还有 prependextend。这里不详谈,三者的区别可以看 Ruby modules: Include vs Prepend vs Extend,在《Ruby 元编程》中也有运用与介绍。

自定义 Podfile 解析

所以,最后解析方式优化为:

module PodfileParser
module DSL
def target(target_name = nil, &block)
yield if block_given?
end

def pod(pod_name, version = nil, **args)
git = args[:git]
@map[pod_name] = git
end

def method_missing(m, *args); end
end
end

module PodfileParser
class Runner
include PodfileParser::DSL

attr_reader :map

def parse!(file_path)
@map = {}
content = File.read(file_path)
eval(content)
@map
end
end
end

最后的 Q&A:

  1. 不拆分为 DSL 和 Runner 两个 module/文件 行不行?行,但拆分出来更清晰,一个用于方法定义,一个用于文件解析;
  2. 不用 include 行不行?行,如果全都在一个 module 里面,也就不存在 include