编译优化-二进制化实现原理

old_resolver_specs_by_target = instance_method(:resolver_specs_by_target)
define_method(:resolver_specs_by_target) do
  specs_by_target = old_resolver_specs_by_target.bind(self).call

  sources_manager = Config.instance.sources_manager
  use_source_pods = podfile.use_source_pods
  missing_binary_specs = []

  specs_by_target.each do |target, rspecs|
    use_binary_rspecs = if podfile.use_binaries? || podfile.use_binaries_selector
      rspecs.select do |rspec|
        ([rspec.name, rspec.root.name] & use_source_pods).empty? &&
          (podfile.use_binaries_selector.nil? || podfile.use_binaries_selector.call(rspec.spec))
      end
    else
      []
    end

    specs_by_target[target] = rspecs.map do |rspec|
      next rspec unless rspec.spec.respond_to?(:spec_source) && rspec.spec.spec_source

      use_binary = use_binary_rspecs.include?(rspec)
      source = use_binary ? sources_manager.binary_source : sources_manager.code_source

      begin
        specification = source.specification(rspec.root.name, rspec.spec.version)
        specification = specification.subspec_by_name(rspec.name, false, true) if rspec.spec.subspec?
        ResolverSpecification.new(specification, rspec.used_by_non_library_targets_only, source)
      rescue Pod::StandardError
        missing_binary_specs << rspec.spec if use_binary
        rspec
      end
    end.compact
  end

  specs_by_target
end

plugin 'cocoapods-bin'

use_binaries!                              # 全局默认二进制
# 或按需选择
use_binaries_with_spec_selector! { |spec| spec.name != 'FeatureA' }

module Pod
  class Specification
    class Set
      class LazySpecification
        alias old_initialize_for_binary_source initialize
        def initialize(name, version, spec_source)
          old_initialize_for_binary_source(name, version, spec_source)
          hook_binary_source
        end

        private

        def hook_binary_source
          return unless integrator.should_replace_binary_source
          return if integrator.use_source_for_pod?(name)

          binary_source = search_in_binary_sources
          @spec_source = if binary_source
                           binary_source
                         else
                           integrator.add_missing_binary_spec(name) unless integrator.missing_binary_specs.include?(name)
                           UI.warn "在二进制源中没有找到`#{name} #{version}`, 将使用源码的源`#{spec_source}`"
                           spec_source
                         end
        end

        def search_in_binary_sources
          binary_sources.map(&:pod_source).find do |binary_source|
            SourceHelper.include_pod_in_source?(name, version, binary_source)
          end
        end
      end
    end
  end
end

alias old_analyze_for_binary_source analyze
def analyze(analyzer = create_analyzer)
  old_analyze_for_binary_source(analyzer)      # 第一遍：纯源码解析，生成完整 lockfile
  @source_pod_lockfile = generate_lockfile     # 保存源码 lockfile，后面用来还原

  BinaryIntegrator.instance.should_replace_binary_source = true
  analyzer.result = nil
  old_analyze_for_binary_source(analyzer)      # 第二遍：LazySpecification Hook 生效，替换为二进制
end

alias old_write_lockfiles_for_binary_source write_lockfiles
def write_lockfiles
  old_write_lockfiles_for_binary_source
  return if @source_pod_lockfile.nil?

  # Podfile.lock / Manifest.lock 还原为纯源码版本
  @source_pod_lockfile.write_to_disk(config.lockfile_path)
  @source_pod_lockfile.write_to_disk(config.sandbox.source_manifest_path)

  # 真实沙盒快照单独保存
  lockfile.write_to_disk(integrator.binary_lockfile_path)        # Podfile.binary.lock
  lockfile.write_to_disk(integrator.sandbox.manifest_path)       # Manifest.binary.lock
end

module Pod
  class Sandbox
    alias old_manifest_path manifest_path
    def manifest_path
      BinaryIntegrator.instance.sandbox.manifest_path   # Manifest.binary.lock
    end
  end
end

APP = 'App'.freeze
APP_XCPROJ = "#{APP}.xcodeproj".freeze
APP_XCWORKSPACE = "#{APP}.xcworkspace".freeze
DEFAULT_ANALYZE_OUTPUT_PATH = '/usr/local/opt/binary_builder'.freeze   # 打包目录

class ProjectGenerator
  XCODEPROJ_PATH = Pathname.new(__FILE__).join('../../../xcodeproj')

  def generate
    prepare_sandbox          # 清理上次产物
    prepare_shell_xcproj     # 拷贝 App.xcodeproj 模板到当前目录
    prepare_podfile          # 写入 Podfile
  end
end

def podfile_content
  <<-PODFILE
source '#{COMPANY_CODE_SOURCE_URL}'
source '#{COCOAPODS_SOURCE_URL}'

target 'App' do
  #{library_type}         # xcframework: use_frameworks! :linkage => :static
                          # fat_library: use_modular_headers!
  pod '#{pod.name}', '#{pod.version}'
end

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # 区分源码 / 二进制模式下 OC 引用 Swift 头文件的方式
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'BINARY_FRAMEWORK=1']
      if target.name != 'App'
        config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
        config.build_settings['EXCLUDED_ARCHS'] = 'i386'
      end
    end
  end
end
  PODFILE
end

def xcodebuild_with_sdk(sdk, arch = nil)
  cmd = "xcodebuild -workspace #{workspace}" \
        " -scheme #{scheme} -configuration Debug" \
        " -sdk #{sdk}"
  cmd += " -arch #{arch}" if arch
  cmd += " -derivedDataPath #{DERIVED_DATA_PATH}"
  cmd += ' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED="NO" CODE_SIGN_ENTITLEMENTS="" CODE_SIGNING_ALLOWED="NO"'
  system(cmd) or raise '编译失败'
end

xcodebuild_with_sdk(SDK::IPHONEOS)
xcodebuild_with_sdk(SDK::IPHONESIMULATOR, simulator_arch)

def generate
  framework_name = @pod.module_name || @pod.name   # module_name 可能被 spec 指定
  framework_path = "#{@pod.name}/#{framework_name}.framework"

  cmd = 'xcodebuild -create-xcframework' \
        " -framework #{iphoneos_product_path}/#{framework_path}" \
        " -framework #{simulator_product_path}/#{framework_path}" \
        " -output #{@pod.name}.xcframework"
  system(cmd) or raise '生成 XCFramework 失败'
end

class FatLibraryObjc
  def pack_binary_files
    copy_static_library
    copy_headers
    copy_resource
    create_dummy_source_file          # 关键：解决 -ObjC 分类不加载问题
  end

  def copy_static_library
    # 合并真机和模拟器架构
    cmd = "lipo -create #{iphoneos_lib_path} #{iphonesimulator_lib_path} -output #{static_lib_path}"
    system(cmd) or raise 'lipo 失败'

    # 删除 CocoaPods 自动生成的 <Pod>-dummy.o，避免二进制里有两个 dummy
    system("sh fat_delete_object.sh #{static_lib_path} #{@pod.module_name}-dummy.o")
  end

  def create_dummy_source_file
    File.open("#{@binary_path}/#{@pod.module_name}-BinaryPodDummy.m", 'w') do |f|
      f.write("// I'm dummy!")
    end
  end
end

def append_bin_info(podspec)
  podspec['vendored_libraries'] = lib_name
  podspec['source_files'] = cocoapods_array_append(
    podspec['source_files'],
    ["#{@pod.module_name}-BinaryPodDummy.m"]
  )
end

class FatLibrarySwift
  def pack_binary_files
    copy_static_library       # lipo 合并成 framework 里的 Mach-O
    copy_headers              # Public + Private headers
    copy_modules              # module.modulemap + .swiftmodule
    copy_resource
  end
end

os_context = File.read(os_swift_header_path)
simulator_context = File.read(simulator_swift_header_path)
File.open(swift_header_path, 'w') do |f|
  f.write(os_context)
  f.write("\n#if defined(__x86_64__) && __x86_64__\n")
  f.write(simulator_context)
  f.write("#endif\n")
end

framework module YourModule {
  umbrella header "YourPod-umbrella.h"
  export *
  module * { export * }
}

module YourModule.Swift {
  header "YourModule-Swift.h"
  requires objc
}

def copy_swiftmodule
  os_path = "#{iphoneos_product_path}/#{pod.name}/#{pod.module_name}.swiftmodule"
  sim_path = "#{simulator_product_path}/#{pod.name}/#{pod.module_name}.swiftmodule"
  target = "#{modules_path}/#{pod.module_name}.swiftmodule"
  FileUtils.copy_entry(os_path, target) if Dir.exist?(os_path)
  FileUtils.copy_entry(sim_path, target) if Dir.exist?(sim_path)
end

def generate_podspec(oss_path)
  podspec = @pod.code_source_spec_json
  # 删除所有源码相关字段
  %w(source source_files module_map header_dir vendored_frameworks ...).each { |k| podspec.delete(k) }

  subspecs = podspec['subspecs']
  if subspecs.nil?
    append_binary_info(podspec)               # 无 subspec 直接挂到 root
  else
    whole_binary = { 'name' => 'WholeBinary' }
    whole_binary['dependencies'] = whole_binary_external_dependencies(podspec)
    append_binary_info(whole_binary)          # vendored_frameworks = X.xcframework

    subspecs.each do |subspec|
      subspec['dependencies']["#{@pod.name}/WholeBinary"] = []  # 每个 subspec 依赖 WholeBinary
      %w(source_files public_header_files ...).each { |k| subspec.delete(k) }
    end
    subspecs.push(whole_binary)
  end
  podspec
end

ignore_keys = [
  'source', 'source_files', 'module_name', 'module_map',
  'header_dir', 'header_mappings_dir',
  'public_header_files', 'project_header_files', 'private_header_files',
  'exclude_files', 'preserve_paths',
  'static_framework', 'frameworks', 'weak_frameworks',
  'vendored_frameworks', 'vendored_libraries',
  'prepare_command', 'script_phases',
  'testspecs'
]

podspec['pod_target_xcconfig'] ||= {}
podspec['pod_target_xcconfig']['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
podspec['user_target_xcconfig'] ||= {}
podspec['user_target_xcconfig']['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'

# publisher.rb
def publish(&create_podspec_block)
  case @pod.binary_type
  when :xcframework
    oss_folder = "#{@pod.name}/xcframework/#{@pod.version}"
  when :fat_library
    oss_folder = "#{@pod.name}/fat_library/#{@pod.version}"
  end
  uploader = OSSUploader.new(@zip_path, oss_folder)
  oss_path = uploader.upload                                # 返回 http URL
  podspec_path = create_podspec_block.call(oss_path)        # 用这个 URL 生成 binary podspec
  PodRepo.push(podspec_path, @source_name)                  # pod repo push 到二进制 spec 仓
end

class PodRepo
  def self.push(spec_path, source_name)
    system("pod repo push #{source_name} #{spec_path} --allow-warnings --skip-import-validation --skip-tests")
  end
end

$ dwarfdump --debug-info libYourPod.a | grep DW_AT_comp_dir | head -1
    DW_AT_comp_dir ("/usr/local/opt/binary_builder/YourPod/1.0.0")

def link(target_path, pod_name)
  dwarf_debug_dir = `dwarfdump --debug-info "#{@framework_path}" | grep "DW_AT_comp_dir" | head -1 | cut -d \\" -f2 | tr -d '\n'`
  raise Error, '找不到二进制包中的 DW_AT_comp_dir' if dwarf_debug_dir.empty?

  dir = "#{dwarf_debug_dir}/#{pod_name}"
  FileUtils.rm_rf(dir)
  FileUtils.mkdir_p(dir)
  `ln -s #{target_path}/* #{dir}`
end

BLACK_LIST_URL = 'https://...builder_black_list.yml/raw?ref=master'

def filter_blacklist_pods
  black_list = YAML.load(download_black_list)
  @pods.reject { |p| black_list.any? { |b| b['name'] == p.name } }
end

class Checker
  def filter_original_binary_pods     # pod 本身已经是二进制（只有 vendored_frameworks 的那种）
  def filter_blacklist_pods           # 黑名单
  def filter_binarized_pods           # 二进制仓已有同版本
end

def fix_podfile
  podfile = Pod::Podfile.from_file(Pathname.new('Podfile'))
  sandbox = Pod::Config.instance.sandbox
  analyzer = Pod::Installer::Analyzer.new(sandbox, podfile, nil, nil, true, false)
  @analyze_specs = analyzer.analyze.specifications
  # 根据 lockfile 的完整依赖图，生成覆盖所有依赖的 Podfile
  setup_podfile_content
end

def multiple_specs_pods
  # 这些 pod 被内部 fork 魔改过，不能改名字和版本号，所以源码仓里多个 spec 同名
  @multiple_specs_pods ||= ['Protobuf', 'SSZipArchive']
end

module FatLibraryFix
  def self.fix_podspec!(podspec)
    prepare_command = podspec['prepare_command']
    # 去掉打包时无意义的 mock 生成脚本
    podspec.delete('prepare_command') if prepare_command =~ /touch .+generated\.swift/
  end

  def self.fix_podfile_dependencies!(pod, file)
    case pod.name
    when 'YFDCommonLog' then file.write "  pod 'Mantle', '~> 1.5'\n"
    when 'ClippingBezier' then file.write "  pod 'PerformanceBezier', '1.0.9'\n"
    end
  end
end

spec.add_dependency 'cocoapods', '= 1.10.0'   # 锁死 pod 版本

# 摘自 cocoapods-bin/helpers/framework_builder.rb
# copy from https://github.com/CocoaPods/cocoapods-packager