前言：在構建自己的組件庫中，我們會經常編輯.podspec文件，進行一些配置項，但是有一些確實還是不太清楚，這里統(tǒng)一學習一下，內容翻譯自官方文檔：https://guides.cocoapods.org/syntax/podspec.html。

1. Specification （規(guī)范）

Specification描述了關于Pod庫所有配置。包括從何處獲取源代碼、使用哪些文件、應用構建設置以及其他一般元數據(如名稱、版本和描述)的詳細信息。

可以直接使用pod spec create命令來為已有組件項目生成一個.podspec文件。但是一般我們創(chuàng)建組件時都會使用pod lib init命令，會同時生成.podspec文件。

來看一個比較簡單的.podspec文件，內容如下：

Pod::Spec.new do |spec|
  spec.name         = 'JJKit'
  spec.version      = '0.1.0'
  spec.license      = { :type => 'BSD' }
  spec.homepage     = 'https://gitee.com/nick5683/JJKit'
  spec.authors      = { 'Nick5683' => 'nick5683@qq.com' }
  spec.summary      = 'JJkit contains class extension and other custom functions.'
  spec.source       = { :git => 'https://gitee.com/nick5683/JJKit.git', :tag => '0.1.0' }
  spec.source_files = 'Classes/*/*'
  spec.framework    = 'SystemConfiguration'
end

再看一個比較詳細的，內容如下：

Pod::Spec.new do |spec|
  spec.name         = 'JJKit'
  spec.version      = '0.1.0'
  spec.license      = { :type => 'BSD' }
  spec.homepage     = 'https://gitee.com/nick5683/JJKit'
  spec.authors      = { 'Nick5683' => 'nick5683@qq.com' }
  spec.summary      = 'JJkit contains class extension and other custom functions.'
  spec.source       = { :git => 'https://gitee.com/nick5683/JJKit.git', :tag => '0.1.0' }

  spec.module_name   = 'Rich'
  spec.swift_version = '5.2'

  spec.ios.deployment_target  = '9.0'
  spec.osx.deployment_target  = '10.10'

  spec.source_files = 'Classes/*/*'
  spec.ios.source_files   = 'Classes/ios/*.swift', 'Classes/extensions/*.swift'
  spec.osx.source_files   = 'Classes/osx/*.swift'

  spec.framework      = 'SystemConfiguration'
  spec.ios.framework  = 'UIKit'
  spec.osx.framework  = 'AppKit'

  spec.dependency 'SomeOtherPod'
end

有一些是我們常見的，有的是還沒有見過的，這次都來了解并學習一下。

2. Root specification （根規(guī)范）

Root specification應用于整個pod庫，包含分為必填和選填項。

2.1 name （必填）

pod庫的名字，我們搜索和導入的時候都會用到名字。

spec.name = 'AFNetworking'

2.2 version（必填）

pod庫的版本號，一般都會和打的標簽保持一致。

spec.version = '0.0.1'

2.3 swift_versions（選填）

規(guī)范支持的Swift版本。CocoaPods會將“4”視為“4.0”，而不是“4.1”或“4.2”。

注意:Swift編譯器主要接受主版本，有時也會支持小版本。雖然CocoaPods允許指定小版本或補丁版本，但Swift編譯器可能不會完全遵守。

# 支持多種寫法
spec.swift_versions = ['3.0']
spec.swift_versions = ['3.0', '4.0', '4.2']
spec.swift_version = '3.0'
spec.swift_version = '3.0', '4.0'

2.4 cocoapods_version（選填）

規(guī)范支持的CocoaPods版本。

spec.cocoapods_version = '>= 0.36'

2.5 authors（必填）

作者。

spec.author = 'Darth Vader'
spec.authors = 'Darth Vader', 'Wookiee'
spec.authors = { 'Darth Vader' => 'darthvader@darkside.com',
                 'Wookiee'     => 'wookiee@aggrrttaaggrrt.com' }

2.6 social_media_url（必填）

Pod的社交媒體聯系人的URL， CocoaPods網絡服務可以使用這個。

spec.social_media_url = 'https://twitter.com/cocoapods'
spec.social_media_url = 'https://groups.google.com/forum/#!forum/cocoapods'

2.7 license （必填）

Pod許可證。

spec.license = 'MIT'
spec.license = { :type => 'MIT', :file => 'MIT-LICENSE.txt' }
spec.license = { :type => 'MIT', :text => <<-LICENSE
                   Copyright 2012
                   Permission is granted to...
                 LICENSE
               }

2.8 homepage （必填）

Pod主頁的URL。

spec.homepage = 'http://www.example.com'

2.9 readme（選填）

此pod版本的README markdown文件的URL。

spec.readme = 'https://www.example.com/Pod-1.5-README.md'

2.10 changelog（選填）

此pod版本的CHANGELOG markdown文件的URL。

spec.changelog = 'https://www.example.com/Pod-1.5-CHANGELOG.md'

2.11 source（選填）

應該從何處檢索庫的位置。

• 使用tag指定一個Git源文件，比較常用：

spec.source = { :git => 'https://github.com/AFNetworking/AFNetworking.git',
                :tag => spec.version.to_s }

• 使用以'v'和子模塊為前綴的標簽

spec.source = { :git => 'https://github.com/typhoon-framework/Typhoon.git',
                :tag => "v#{spec.version}", :submodules => true }

還有一些不常用的，比如支持下載zip文件，可以從官網上看到。

支持的keys：

:git => :tag, :branch, :commit, :submodules

:svn => :folder, :tag, :revision

:hg => :revision

:http => :flatten, :type, :sha256, :sha1, :headers

2.12 summary（選填）

對Pod的簡短描述(最多140個字符)。

spec.summary = 'Computes the meaning of life.'

2.13 description（選填）

對Pod的描述比summary更詳細。

spec.description = <<-DESC
                     Computes the meaning of life.
                     Features:
                     1. Is self aware
                     ...
                     42. Likes candies.
                   DESC

2.14 screenshots（選填）

展示Pod截圖的url列表。CocoaPods推薦使用gif格式。

spec.screenshot  = 'http://dl.dropbox.com/u/378729/MBProgressHUD/1.png'
spec.screenshots = [ 'http://dl.dropbox.com/u/378729/MBProgressHUD/1.png',
                     'http://dl.dropbox.com/u/378729/MBProgressHUD/2.png' ]

2.15 documentation_url（選填）

一個可選的Pod文檔URL，默認為CocoaDocs生成的庫URL。

spec.documentation_url = 'http://www.example.com/docs.html'

2.16 prepare_command（選填）

下載Pod后執(zhí)行的bash腳本。該命令可用于創(chuàng)建、刪除和修改下載的任何文件，并且將在該規(guī)范的其他文件屬性的任何路徑被收集之前運行該命令。

此命令在清理Pod和創(chuàng)建Pod project項目之前執(zhí)行。工作目錄為Pod的根目錄。

如果pod導入時使用了:path選項，則不會執(zhí)行此命令。

spec.prepare_command = 'ruby build_files.rb'
spec.prepare_command = <<-CMD
                        sed -i 's/MyNameSpacedHeader/Header/g' ./**/*.h
                        sed -i 's/MyNameOtherSpacedHeader/OtherHeader/g' ./**/*.h
                   CMD

2.17 static_framework（選填）

如果use_frameworks!指定時，pod應該包含一個靜態(tài)庫framework。

spec.static_framework = true

2.18 deprecated（選填）

標記庫是否已經廢棄不用。

spec.deprecated = true

2.19 deprecated_in_favor_of（選填）

這個Pod庫的名字已經被棄用了。

spec.deprecated_in_favor_of = 'NewMoreAwesomePod'

3. Platform

規(guī)范應該指明支持庫的平臺和相應的部署目標。

3.1 platform

支持當前Pod庫的平臺。不填則表示所有平臺都支持該Pod庫。當支持多個平臺時，你應該使用下面的deployment_target。

spec.platform = :osx, '10.8'
spec.platform = :ios
spec.platform = :osx

3.2 deployment_target

支持platform的最小部署目標。

與platform屬性相反，deployment_target屬性允許指定支持此pod的多個平臺，就是為每個platform指定不同的部署目標。

spec.ios.deployment_target = '6.0'
spec.osx.deployment_target = '10.8'

4. Build settings

在該組中列出了與應用構建環(huán)境配置相關的屬性。

4.1 dependency

標明對其他pod庫或者子庫的依賴。

如果這里指定版本過于嚴格，會限制它們與其他pod的兼容性。

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'

4.2 info_plist (multi-platform)

要添加到生成的Info.plist中的鍵值對。

對于library specs，這些值將合并到生成的framework的Info.plist中，它對靜態(tài)庫沒有影響，不支持subspecs。對于app specs，這些值將合并到主應用的Info.plist中。

spec.info_plist = {
  'CFBundleIdentifier' => 'com.myorg.MyLib',
  'MY_VAR' => 'SOME_VALUE'
}

4.3 requires_arc （默認為true）

requires_arc允許指定哪些source_files使用ARC。可以設置為true表示所有source_files使用ARC。不使用ARC的文件會有-fno-objc-arc編譯標志。

spec.requires_arc = true
spec.requires_arc = 'Classes/Arc'
spec.requires_arc = ['Classes/*ARC.m', 'Classes/ARC.mm']

4.4 frameworks (multi-platform)

用戶的target需要鏈接的系統(tǒng)framework列表。

spec.ios.framework = 'CFNetwork'
spec.frameworks = 'QuartzCore', 'CoreData'

4.5 weak_frameworks (multi-platform)

用戶的目標需要弱鏈接的框架列表。

spec.weak_framework = 'Twitter'
spec.weak_frameworks = 'Twitter', 'SafariServices'

4.6 libraries (multi-platform)

用戶的目標(應用程序)需要鏈接的系統(tǒng)庫的列表。

spec.ios.library = 'xml2'
spec.libraries = 'xml2', 'z'

4.7 compiler_flags (multi-platform)

應該傳遞給編譯器的標志列表。

spec.compiler_flags = '-DOS_OBJECT_USE_OBJC=0', '-Wno-format'

4.8 pod_target_xcconfig (multi-platform)

要添加到最終私有pod target 的 xcconfig文件中的任何標志。

spec.pod_target_xcconfig = { 'OTHER_LDFLAGS' => '-lObjC' }

4.9 user_target_xcconfig (multi-platform)

指定要添加到最終聚合target（項目工程target）的xcconfig文件的標志。

不建議使用此屬性，因為Pods不應該污染用戶項目的構建設置，這可能會導致沖突。建議使用pod_target_xcconfig。

spec.user_target_xcconfig = { 'MY_SUBSPEC' => 'YES' }

4.10 prefix_header_contents (multi-platform)

要注入到pod項目前綴頭中的任何內容。

不建議使用此屬性，因為Pods不應該污染其他庫或用戶項目的前綴頭。

spec.prefix_header_contents = '#import <UIKit/UIKit.h>'
spec.prefix_header_contents = '#import <UIKit/UIKit.h>', '#import <Foundation/Foundation.h>'

4.11 prefix_header_file (multi-platform)

要注入到pod項目的前綴頭文件中的前綴頭文件的路徑。

不建議使用文件路徑選項，因為Pods不應該污染其他庫或用戶項目的前綴頭。

spec.prefix_header_file = 'iphone/include/prefix.pch'
spec.prefix_header_file = false

4.12 module_name

該規(guī)范生成的用于framework / clang module 的名稱，而不是默認名稱(如果設置header_dir，否則為規(guī)范名稱)。

spec.module_name = 'Three20'

4.13 header_dir (multi-platform)

存放頭文件的目錄，這樣它們就不會破壞include。

spec.header_dir = 'Three20Core'

4.14 header_dir (multi-platform)

保存頭文件的文件夾結構的目錄。如果沒有提供，頭文件將被flattened。

spec.header_dir = 'Three20Core'

4.15 script_phases (multi-platform)

此屬性允許定義腳本階段，以作為Pod編譯的一部分執(zhí)行。與prepare command不同，腳本階段作為xcodebuild的一部分執(zhí)行，它們還可以使用編譯期間設置的所有環(huán)境變量。

Pod可以提供多個腳本階段來執(zhí)行，它們將按照聲明的順序添加。

注意:為了提供所有腳本階段的內容的可見性，如果pod包含任何腳本，安裝時將向用戶顯示一個警告。

spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"' }
spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"', :execution_position => :before_compile }
spec.script_phase = { :name => 'Hello World', :script => 'puts "Hello World"', :shell_path => '/usr/bin/ruby' }
spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"',
  :input_files => ['/path/to/input_file.txt'], :output_files => ['/path/to/output_file.txt']
}
spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"',
  :input_file_lists => ['/path/to/input_files.xcfilelist'], :output_file_lists => ['/path/to/output_files.xcfilelist']
}
spec.script_phases = [
    { :name => 'Hello World', :script => 'echo "Hello World"' },
    { :name => 'Hello Ruby World', :script => 'puts "Hello World"', :shell_path => '/usr/bin/ruby' },
  ]

5. File patterns（文件模式）

5.1 File patterns

Podspecs應該位于庫文件夾的根目錄，并且文件的路徑也應該相對于存儲庫的目錄指定。文件模式不支持遍歷父目錄(…)． 文件模式可能包含以下通配符模式:

5.1.1 Pattern: *

匹配任何文件，可以被glob中的其他值限制：

* 匹配所有文件
c* 匹配以c開頭的文件
*c 匹配以c結尾的文件
*c*匹配包含c的文件

5.1.2 Pattern: **

目錄遞歸地匹配。

5.1.3 Pattern: ?

匹配任意一個字符。相當于 正則表達式中的/.{1}/。

5.1.4 Pattern: [set]

匹配集合中的任意一個字符。
行為與正則表達式中的字符集完全一樣，包括反集([^a-z])。

5.1.4 Pattern: {p,q}

匹配字面值p或字面值q。等價于正則表達式中的模式變換。

5.1.5 Pattern: \

轉義下一個元字符。

示例：

"JSONKit.?"    #=> ["JSONKit.h", "JSONKit.m"]
"*.[a-z][a-z]" #=> ["CHANGELOG.md", "README.md"]
"*.[^m]*"      #=> ["JSONKit.h"]
"*.{h,m}"      #=> ["JSONKit.h", "JSONKit.m"]
"*"            #=> ["CHANGELOG.md", "JSONKit.h", "JSONKit.m", "README.md"]

5.2 source_files (multi-platform)

pod庫中包含的源文件。

spec.source_files = 'Classes/**/*.{h,m}'
spec.source_files = 'Classes/**/*.{h,m}', 'More_Classes/**/*.{h,m}'

5.3 public_header_files (multi-platform)

作為公共頭的文件模式列表。

這些文件模式將與源文件進行匹配，以包含將向主項目公開的頭文件，并從中生成文檔。當構建庫時，這些頭文件將出現在構建目錄中。如果沒有指定公共頭文件，那么source_files中的所有頭文件都被認為是公共的。

spec.public_header_files = 'Headers/Public/*.h'

5.4 project_header_files (multi-platform)

作為項目頭的文件模式列表。

這些文件模式將與public headers進行匹配，以排除那些不應公開給用戶項目和不應用于生成文檔的headers。當構建庫時，這些頭文件將不會出現在構建目錄中。

spec.project_header_files = 'Headers/Project/*.h'

5.5 private_header_files (multi-platform)

作為私有頭的文件模式列表。

這些模式將與public headers進行匹配，以排除那些不應公開給用戶項目和不應用于生成文檔的標頭。當構建庫時，這些頭文件將出現在構建目錄中。

未被列為公共、項目或私有文件的頭文件會出現在構建目錄中。

spec.private_header_files = 'Headers/Private/*.h'

5.6 vendored_frameworks (multi-platform)

Pod所依賴的的framework的路徑，同時支持.framework和.xcframework包。這些框架將提供給Pod和Pod的消費者。

spec.ios.vendored_frameworks = 'Frameworks/MyFramework.framework'
spec.vendored_frameworks = 'MyFramework.framework', 'TheirFramework.xcframework'

5.7 vendored_libraries (multi-platform)

Pod所依賴的庫(.a文件)的路徑。

spec.ios.vendored_library = 'Libraries/libProj4.a'
spec.vendored_libraries = 'libProj4.a', 'libJavaScriptCore.a'

5.8 on_demand_resources (multi-platform)

應復制到目標target中的隨需應變資源的哈希值。這里指定的資源將自動成為集成此pod的target的資源構建階段的一部分。

由pods指定的tag是由CocoaPods管理的。如果一個標簽被重命名、更改或刪除，那么CocoaPods也會在工程target中進行更新。

s.on_demand_resources = {
  'Tag1' => 'file1.png'
}
s.on_demand_resources = {
  'Tag1' => ['file1.png', 'file2.png']
}
s.on_demand_resources = {
  'Tag1' => { :paths => ['file1.png', 'file2.png'], :category => :download_on_demand }
}
s.on_demand_resources = {
  'Tag1' => { :paths => ['file1.png', 'file2.png'], :category => :initial_install }
}

5.9 resource_bundles (multi-platform)

這個屬性允許為pod構建使用的資源包定義name。就是一個鍵值對，其中key表示包的名稱，value表示它們應該包含的文件模式的值。

為了將Pod構建為一個靜態(tài)庫，推薦采用resource_bundles，因為使用resources屬性可能會產生名稱沖突。
使用resource_bundles會在主bundle中生成一個自定義的bundle，bundle中存放著資源。讀取資源時需要到對應bundle下讀取。這種方式可以避免命名沖突。

包的名稱至少應該包含Pod的名稱，以盡量減少名稱沖突的機會。

spec.resources = ['Resources/Assets/*.xcassets']
spec.ios.resource_bundle = { 'MapBox' => 'Resources/*.png' }
spec.resource_bundles = {
    'MapBox' => ['Resources/*.png'],
    'MapBoxOtherResources' => ['OtherResources/*.png']
  }

5.10 resources (multi-platform)

應該復制到目標target bundle中的資源列表。

使用resources會在主bundle中導入。這種方式讀取圖片不需要修改讀取方式。
為了將Pod構建為一個靜態(tài)庫，強烈建議采用resource_bundles，因為使用resources屬性可能會產生名稱沖突。此外，用這個屬性指定的資源會直接復制到客戶端目標中，因此它們不會被Xcode優(yōu)化。

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

5.11 exclude_files (multi-platform)

應該從其他文件模式中排除的文件模式列表。

spec.ios.exclude_files = 'Classes/osx'
spec.exclude_files = 'Classes/**/unused.{h,m}'

5.12 preserve_paths (multi-platform)

下載后不應刪除的任何文件。

默認情況下，CocoaPods刪除所有與任何其他文件模式不匹配的文件。

spec.preserve_path = 'IMPORTANT.txt'
spec.preserve_paths = 'Frameworks/*.framework'

5.13 module_map (multi-platform)

當此pod集成為framework時應該使用的模塊映射文件。

false表示不應該生成默認的CocoaPods modulemap文件。
true為默認值，表示應該生成默認的CocoaPods modulemap文件。

默認情況下，CocoaPods根據規(guī)范中的公共頭文件創(chuàng)建模塊映射文件。

spec.module_map = 'source/module.modulemap'
spec.module_map = false

作者：code_ce
鏈接：http://www.lxweimin.com/p/8c6941778f0e
來源：簡書
著作權歸作者所有。商業(yè)轉載請聯系作者獲得授權，非商業(yè)轉載請注明出處。