基于 CocoaPods 的组件二进制化实践

// TDFMacro.h
@interface TDFMacro : NSObject
+ (BOOL)enterprise;
+ (BOOL)debug;

+ (void)debugExecute:(void(^)(void))debugExecute elseExecute:(void(^)(void))elseExecute;
+ (void)enterpriseExecute:(void(^)(void))enterpriseExecute elseExecute:(void(^)(void))elseExecute;
@end

// TDFMacro.m
@implementation TDFMacro
+ (BOOL)enterprise {
#if ENTERPRISE
    return YES;
#else
    return NO;
#endif
}

+ (BOOL)debug {
#if DEBUG
    return YES;
#else
    return NO;
#endif
}

+ (void)debugExecute:(void (^)(void))debugExecute elseExecute:(void (^)(void))elseExecute {
    if ([self debug]) {
        !debugExecute ?: debugExecute();
    } else {
        !elseExecute ?: elseExecute();
    }
}

+ (void)enterpriseExecute:(void (^)(void))enterpriseExecute elseExecute:(void (^)(void))elseExecute {
    if ([self enterprise]) {
        !enterpriseExecute ?: enterpriseExecute();
    } else {
        !elseExecute ?: elseExecute();
    }
}
@end

// 前
#if DEBUG 
NSString * kTDFRootAPI = @"xxx";
#else
NSString * const kTDFRootAPI = @"xxx";
#end
// 后
NSString * kTDFRootAPI = @"xxx";

// A
#define TDF_THEME_BACKGROUNDCOLOR [[UIColor whiteColor] colorWithAlphaComponent:0.7]

// B
// .m 使用了 TDF_THEME_BACKGROUNDCOLOR

// A
#define TDF_THEME_BACKGROUNDCOLOR [[UIColor whiteColor] colorWithAlphaComponent:0.4]

pod package TDFNavigationBarKit.podspec --exclude-deps --force --no-mangle --spec-sources=http://git.xxxxx.net/ios/cocoapods-spec.git

pod package-pro TDFNavigationBarKit.podspec --exclude-deps --force --no-mangle --spec-sources=http://git.xxxxx.net/ios/cocoapods-spec.git

zip --symlinks -r TDFNavigationBarKit.framework.zip TDFNavigationBarKit.framework

TDFNavigationBarKit.framework/
├── Headers -> Versions/Current/Headers
├── Modules
│   └── module.modulemap
├── Resources -> Versions/Current/Resources
├── TDFNavigationBarKit -> Versions/Current/TDFNavigationBarKit
└── Versions
    ├── A
    │   ├── Headers
    │   │   ├── TDFNavigationBarKit.h
    │   │   ├── UIViewController+BackgroundConfigure.h
    │   │   └── UIViewController+NavigationBarConfigure.h
    │   ├── Resources
    │   │   └── Media.xcassets
    │   │       ├── Contents.json
    │   │       ├── common_nbc_back.imageset
    │   │       │   ├── Contents.json
    │   │       │   └── common_nbc_back.png
    │   │       ├── common_nbc_cancel.imageset
    │   │       │   ├── Contents.json
    │   │       │   └── common_nbc_cancel.png
    │   │       ├── common_nbc_ok.imageset
    │   │       │   ├── Contents.json
    │   │       │   └── common_nbc_ok.png
    │   └── TDFNavigationBarKit
    └── Current -> A

s.source_files = TDFNavigationBarKit.framework/Versions/A/Headers/*.h
s.public_header_files = TDFNavigationBarKit.framework/Versions/A/Headers/*.h

# 或者更全面一点
s.source_files = TDFNavigationBarKit.framework/Versions/A/Headers/*.h, TDFNavigationBarKit.framework/Headers/*.h
s.public_header_files = TDFNavigationBarKit.framework/Versions/A/Headers/*.h, TDFNavigationBarKit.framework/Headers/*.h

# 将源码打包成二进制，并压缩成 zip 包
pod binary package

# 查看所有二进制版本信息
pod binary list 
# 查找组件二进制版本信息
pod binary search NAME
# 下载二进制 zip 包
pod binary pull NAME VERSION
# 推送二进制 zip 包 
pod binary push [PATH] [-name=组件名] [--version=版本号] [--commit=版本日志]

def cache_descriptors
  @cache_descriptors ||= begin
    cache = Downloader::Cache.new(Config.instance.cache_root + 'Pods')
    cache_descriptors = cache.cache_descriptors_per_pod
  end
end

def clean_local_cache(spec)
  pod_dir = Config.instance.sandbox.pod_dir(spec.root.name)
  framework_file = pod_dir + "#{spec.root.name}.framework"
  if pod_dir.exist? && !framework_file.exist?
    # 设置沙盒变动标记，去 cache 中拿
    # 只有 :changed 、:added 两种状态才会重新去 cache 中拿
    @analysis_result.sandbox_state.add_name(spec.name, :changed)
    begin
      FileUtils.rm_rf(pod_dir)
    rescue => err
      puts err
    end
  end
end

def clean_pod_cache(spec)
  descriptors = cache_descriptors[spec.root.name]
  return if descriptors.nil?
  descriptors = descriptors.select { |d| d[:version] == spec.version}
  descriptors.each do |d|
    # pod cache 文件名由文件内容的 sha1 组成，由于生成时使用的是 podspec，获取时使用的是 podspec.json 导致生成的目录名不一致
    # Downloader::Request slug
    # cache_descriptors_per_pod 表明，specs_dir 中都是以 .json 形式保存 spec
    slug = d[:slug].dirname + "#{spec.version}-#{spec.checksum[0, 5]}"
    framework_file = slug + "#{spec.root.name}.framework"
    unless (framework_file.exist?)
      begin
        FileUtils.rm(d[:spec_file])
        FileUtils.rm_rf(slug)
      rescue => err
        puts err
      end
    end
  end
end

....
tdfire_source_configurator = lambda do |s|
  # 源码依赖配置
  s.source_files = '${POD_NAME}/Classes/**/*'
  s.public_header_files = '${POD_NAME}/Classes/**/*.{h}'
end
unless %w[tdfire_set_binary_download_configurations tdfire_source tdfire_binary].reduce(true) { |r, m| s.respond_to?(m) & r }
  tdfire_source_configurator.call s
else
  # 内部生成源码依赖配置
  s.tdfire_source tdfire_source_configurator
  # 内部生成二进制依赖配置
  s.tdfire_binary tdfire_source_configurator
  # 设置下载脚本，preseve_paths
  s.tdfire_set_binary_download_configurations
end

...
plugin 'cocoapods-tdfire-binary'

tdfire_use_binary!

# tdfire_third_party_use_binary!
tdfire_use_source_pods ['AFNetworking']
...

# A
Pod::Spec.new do |s|
  s.name             = 'A'
  ...
  s.subspec 'Core' do |ss|
    ss.source_files = 'A/Classes/A.{h,m}'
  end
  s.subspec 'Model' do |ss|
    ss.dependency 'A/Core'
    ss.dependency 'YYModel'
    ss.source_files = 'A/Classes/Next.{h,m}'
  end
  s.subspec 'Image' do |ss|
    ss.dependency 'A/Core'
    ss.dependency 'SDWebImage'
    ss.source_files = 'A/Classes/Prev.{h,m}'
  end
  ...
end

# B
Pod::Spec.new do |s|
  s.name             = 'B'
  ...
  s.dependency 'A/Model'
  ...
end

# A
Pod::Spec.new do |s|
  s.name             = 'A'
  ...
  s.subspec 'TdfireBinary' do |ss|
	ss.vendored_frameworks = "A.framework"
    ss.source_files = "A.framework/Headers/*", "A.framework/Versions/A/Headers/*"
    ss.public_header_files = "A.framework/Headers/*", "A.framework/Versions/A/Headers/*"
    ss.dependency 'YYModel'    
    ss.dependency 'SDWebImage'
  end
  s.subspec 'Core' do |ss|
    ss.dependency 'A/TdfireBinary'
  end
  s.subspec 'Model' do |ss|
    ss.dependency 'A/TdfireBinary'
  end
  s.subspec 'Image' do |ss|
	ss.dependency 'A/TdfireBinary'
  end
  ...
end

def search_for(dependency)
  @search ||= {}
  @search[dependency] ||= begin
    locked_requirement = requirement_for_locked_pod_named(dependency.name)
    additional_requirements = Array(locked_requirement)
    specifications_for_dependency(dependency, additional_requirements)
  end
  @search[dependency].dup
end
def specifications_for_dependency(dependency, additional_requirements = [])
  requirement = Requirement.new(dependency.requirement.as_list + additional_requirements.flat_map(&:as_list))
  find_cached_set(dependency).
    all_specifications(installation_options.warn_for_multiple_pod_sources).
    select { |s| requirement.satisfied_by? s.version }.
    map { |s| s.subspec_by_name(dependency.name, false, true) }.
    compact
end

Due to the previous naïve CocoaPods resolver, you were using a pre-release version of `YYModel`, 
without explicitly asking for a pre-release version, which now leads to a conflict. 
Please decide to either use that pre-release version by
adding the version requirement to your Podfile (e.g. `pod 'YYModel', '= 1.0.1-binary, ~> 1.0'`) or
revert to a stable version by running `pod update YYModel`

def resolve
  dependencies = @podfile_dependency_cache.target_definition_list.flat_map do |target|
    @podfile_dependency_cache.target_definition_dependencies(target).each do |dep|
      next unless target.platform
      @platforms_by_dependency[dep].push(target.platform)
    end
  end
  @platforms_by_dependency.each_value(&:uniq!)
  @activated = Molinillo::Resolver.new(self, self).resolve(dependencies, locked_dependencies)
  resolver_specs_by_target
rescue Molinillo::ResolverError => e
  handle_resolver_error(e)
end

def resolver_specs_by_target
  @resolver_specs_by_target ||= {}.tap do |resolver_specs_by_target|
    dependencies = {}
    @podfile_dependency_cache.target_definition_list.each do |target|
      specs = @podfile_dependency_cache.target_definition_dependencies(target).flat_map do |dep|
        name = dep.name
        node = @activated.vertex_named(name)
        (valid_dependencies_for_target_from_node(target, dependencies, node) << node).map { |s| [s, node.payload.test_specification?] }
      end

      resolver_specs_by_target[target] = specs.
        group_by(&:first).
        map do |vertex, spec_test_only_tuples|
          test_only = spec_test_only_tuples.all? { |tuple| tuple[1] }
          payload = vertex.payload
          spec_source = payload.respond_to?(:spec_source) && payload.spec_source
          ResolverSpecification.new(payload, test_only, spec_source)
        end.
        sort_by(&:name)
    end
  end
end

# cocoapods-spec 
{
  "name": "YYModel",
  "summary": "High performance model framework for iOS/OSX.",
  "version": "1.0.4.2",
  "license": {
    "type": "MIT",
    "file": "LICENSE"
  },
  "authors": {
    "ibireme": "ibireme@gmail.com"
  },
  "social_media_url": "http://blog.ibireme.com",
  "homepage": "https://github.com/ibireme/YYModel",
  "platforms": {
    "ios": "6.0",
    "osx": "10.7",
    "watchos": "2.0",
    "tvos": "9.0"
  },
  "source": {
    "git": "git@git.xxxxx.net:cocoapods-repos/YYModel.git",
    "tag": "1.0.4.2"
  },
  "frameworks": [
    "Foundation",
    "CoreFoundation"
  ],
  "requires_arc": true,
  "source_files": "YYModel/*.{h,m}",
  "public_header_files": "YYModel/*.{h}"
}

# cocoapods-spec-binary 
{
  "name": "YYModel",
  "summary": "High performance model framework for iOS/OSX.",
  "version": "1.0.4.2",
  "authors": {
    "ibireme": "ibireme@gmail.com"
  },
  "social_media_url": "http://blog.ibireme.com",
  "homepage": "https://github.com/ibireme/YYModel",
  "platforms": {
    "ios": "6.0"
  },
  "source": {
    "http": "http://iosframeworkserver-shopkeeperclient.app.2dfire.com/download/YYModel/1.0.4.2.zip"
  },
  "frameworks": [
    "Foundation",
    "CoreFoundation"
  ],
  "requires_arc": true,
  "source_files": [
    "YYModel.framework/Headers/*",
    "YYModel.framework/Versions/A/Headers/*"
  ],
  "public_header_files": [
    "YYModel.framework/Headers/*",
    "YYModel.framework/Versions/A/Headers/*"
  ],
  "vendored_frameworks": "YYModel.framework"
}

module Pod
  class Resolver
    # >= 1.4.0 才有 resolver_specs_by_target 以及 ResolverSpecification
    # >= 1.5.0 ResolverSpecification 才有 source，供 install 或者其他操作时，输入 source 变更
    # 
    if Pod.match_version?('~> 1.4') 
      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_binaries 并且 use_source_pods 不包含
          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|
            # developments 组件采用默认输入的 spec (development pods 的 source 为 nil)
            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 

            spec_version = rspec.spec.version
            begin
              # 从新 source 中获取 spec
              specification = source.specification(rspec.root.name, spec_version)   

              # 组件是 subspec
              specification = specification.subspec_by_name(rspec.name, false, true) if rspec.spec.subspec?
              # 这里可能出现分析依赖的 source 和切换后的 source 对应 specification 的 subspec 对应不上
              # 造成 subspec_by_name 返回 nil，这个是正常现象
              next unless specification

              # 组装新的 rspec ，替换原 rspec
              rspec = if Pod.match_version?('~> 1.4.0')
                        ResolverSpecification.new(specification, rspec.used_by_tests_only)
                      else
                        ResolverSpecification.new(specification, rspec.used_by_tests_only, source)
                      end
              rspec
            rescue Pod::StandardError => error  
              # 没有从新的 source 找到对应版本组件，直接返回原 rspec
              missing_binary_specs << rspec.spec if use_binary
              rspec
            end

            rspec 
          end.compact
        end

        missing_binary_specs.uniq.each do |spec| 
          UI.message "【#{spec.name} | #{spec.version}】组件无对应二进制版本 , 将采用源码依赖." 
        end if missing_binary_specs.any?

        specs_by_target
      end
    end
  end

  if Pod.match_version?('~> 1.4.0')
    # 1.4.0 没有 spec_source
    class Specification
      class Set
        class LazySpecification < BasicObject
          attr_reader :spec_source

          old_initialize = instance_method(:initialize)
          define_method(:initialize) do |name, version, source|
            old_initialize.bind(self).call(name, version, source)

            @spec_source = source 
          end

          def respond_to?(method, include_all = false) 
            return super unless method == :spec_source
            true
          end
        end
      end
    end
  end
end

variables:
  # 二进制优先
  BINARY_FIRST: 1 
  # 不允许通知 
  DISABLE_NOTIFY: 0

before_script:
  # https://gitlab.com/gitlab-org/gitlab-ce/issues/14983
  # shared runner 会出现，special runner只会报warning
  - export LANG=en_US.UTF-8
  - export LANGUAGE=en_US:en
  - export LC_ALL=en_US.UTF-8
  
  - pwd
  - git clone git@git.xxxxx.net:ios/ci-yaml-shell.git 
  - ci-yaml-shell/before_shell_executor.sh

after_script:
  - rm -fr ci-yaml-shell

stages:
  - check
  - lint
  - test
  - package
  - publish
  - report
  - cleanup

component_check:
  stage: check
  script: 
    - ci-yaml-shell/component_check_executor.rb
  only:
    - master
    - /^release.*$/
    - /^hotfix.*$/
    - tags
    - CI
  tags:
    - iOSCI
  environment:
    name: qa
...

package_framework:
  stage: package 
  only:
    - tags
  script:
    - ci-yaml-shell/framework_pack_executor.sh
  tags:
    - iOSCD
  environment:
    name: production

publish_code_pod:
  stage: publish
  only:
    - tags
  retry: 0
  script:
    - ci-yaml-shell/publish_code_pod.sh
  tags:
    - iOSCD
  environment:
    name: production

publish_binary_pod:
  stage: publish
  only:
    - tags
  retry: 0
  script:
    - ci-yaml-shell/publish_binary_pod.sh
  tags:
    - iOSCD
  environment:
    name: production

report_to_director:
  stage: report
  script:
    - ci-yaml-shell/report_executor.sh
  only:
    - master
    - tags
  when: on_failure
  tags:
    - iOSCD