cocoapods Podspec详细用法

一、简介

CocoaPods Podspec是一个用于描述和配置CocoaPods库的文件，其中包含有关库名称、版本号、依赖项、源文件、资源文件和其他相关信息：

1. 创建一个Podspec文件：可以通过手动创建一个名为{库名称}.podspec的文件或使用pod spec create {库名称}命令自动生成一个Podspec文件。

2. 编辑Podspec文件：在Podspec文件中，您需要设置几个基本属性，如库名称、版本号、作者、简要说明等。您还需要定义依赖项，并指定源文件、资源文件以及其他必要的设置。

3. 校验Podspec文件：可以使用pod spec lint {库名称}.podspec命令来检查Podspec文件是否完整、格式正确，以及是否存在任何错误或警告。

4. 提交Podspec文件：如果您打算将库添加到CocoaPods的官方仓库中，则需要提交Podspec文件。可以使用pod trunk push {库名称}.podspec命令将Podspec文件推送到CocoaPods仓库中。

5. 使用Podspec文件：其他开发人员可以使用pod install {库名称}命令从CocoaPods仓库中安装您的库。他们只需要在他们的项目中添加一个Podfile文件并指定所需库的名称即可。

二、基本语法

Pod::Spec.new do |s|
  s.name         = 'LibraryName'
  s.version      = '0.1.0'
  s.summary      = 'A short description of LibraryName.'
  s.homepage     = 'https://github.com/username/LibraryName'
  s.license      = { :type => 'MIT', :file => 'LICENSE' }
  s.author       = { 'Your Name' => 'your@email.com' }
  s.source       = { :git => 'https://github.com/username/LibraryName.git', :tag => s.version.to_s }
  s.source_files = 'LibraryName/**/*.{h,m,swift}'
  s.dependency   'DependencyName', '~> 1.0.0'
end

三、常用属性解释

• name：库的名称
• version：库的版本号
• summary：库的简要描述
• homepage：库的主页URL
• license：库的许可证信息，包括类型和文件路径
• author：库的作者信息，可以是一个哈希表
• source：库的源代码信息，包括Git仓库URL和标签
• source_files：要包含在库中的源文件的路径
• subspec：允许您将库分成多个子规范，每个子规范可以拥有自己的源文件和依赖关系。
• platform：指定库支持的平台和最低版本。
• libraries: 指定依赖的系统静态库。

  spec.libraries = 'xml2', 'z'

• framework：指定依赖的系统框架 

  # 单个
  spec.framework = 'UIKit'
  
  # 多个
  spec.frameworks = 'CoreGraphics', 'SystemConfiguration'

• vendored_frameworks: 指定依赖的三方框架(framework),可以设置为一个数组类型，每个元素都表示一个需要包含的 framework。这些 framework 可以是相对路径或绝对路径，也可以使用通配符进行匹配。

  # Frameworks目录下的所有framework
  spec.vendored_frameworks = ["Frameworks/**/*.framework"]
  
  
  # 指定库
  spec.vendored_frameworks = 'MyFramework.framework', 'TheirFramework.xcframework'

• vendored_libraries: 指定依赖的三方静态库,只适用于静态库文件，若要引入动态库需要使用 vendored_frameworks。

  spec.vendored_libraries = 'libProj4.a', 'libJavaScriptCore.a'

•    dependency: 指定依赖库，CocoaPods 提供的依赖管理的库

  spec.dependency 'AFNetworking', '~> 1.0'
  
  spec.dependency 'AFNetworking', '~> 1.0', :configurations => ['Debug']
  
  spec.dependency 'AFNetworking', '~> 1.0', :configurations => :debug
  
  spec.dependency 'RestKit/CoreData', '~> 0.20.0'
  
  spec.ios.dependency 'MBProgressHUD', '~> 0.5'

• resource_bundles: 当你创建一个 Pod 并且想要包含一些资源文件时（如图片、xib 文件、音频文件等），可以将这些资源文件打包成 bundle，并在 podspec 文件中通过 resource_bundles 属性指定它们的路径和名称。这样，在使用该 Pod 的项目中就可以方便地访问这些资源文件。

  # 用例1
  spec.resource_bundles = {
    'MyPodName' => ['Resources/*.png', 'Resources/*.xib']
  }
  
  
  # 用例2
  spec.resource_bundles = {
      'MapBox' => ['MapView/Map/Resources/*.png'],
      'MapBoxOtherResources' => ['MapView/Map/OtherResources/*.png']
    }

这个用例1中，MyPodName 是资源文件的 bundle 名称，它包含了所有在 Resources 目录下的 png 和 xib 文件。在使用该 Pod 的项目中，可以通过以下方式访问这些资源文件(其中，Bundle(for:) 方法会返回包含指定类的 bundle，也就是 MyPodName。)：

let image = UIImage(named: "MyImage", in: Bundle(for: MyPodClass.self), compatibleWith: nil)
let nib = UINib(nibName: "MyNib", bundle: Bundle(for: MyPodClass.self))

• resources: 用于标识某个组件所需要的资源文件。可以将 resources 设置为一个数组，其中每个元素都是一个字符串，表示要包含在 pod 中的资源文件的路径。这些资源文件可以是图片、音频、文本等各种类型的文件，在安装 pod 时会被复制到项目中。

  spec.resource = 'Resources/HockeySDK.bundle'
  
  spec.resources = ['Images/*.png', 'Sounds/*']