podspec书写规范

Posted 想名真难

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了podspec书写规范相关的知识,希望对你有一定的参考价值。

简单的参数:

s.name         = "BaseFramework" #工程的名字
s.version      = "0.0.1"  #工程的版本
s.summary      = "Gray's BaseFramework."  #工程的摘要
s.description  = "Gray's BaseFramework demo"  #工程的描述,描述的文本长度一定要比摘要长度
s.homepage     = "http://graydeng.BaseFramework"  #工程的首页
s.license      = "MIT"  #工程的证书
s.author       =  "Gray" => "denggray@163.com"  #工程的作者
s.ios.deployment_target = "8.0"  #工程的编译版本
s.source       =  :git => "http://graydeng/BaseFramework.git", :tag => "#s.version"   #工程的git地址
s.source_files  = "Classes", "Classes/**/*.h,m"  #工程需要引入的文件
s.exclude_files = "Classes/Exclude"  #工程不需要引入的文件
s.public_header_files = "Classes/**/*.h"  #工程需要暴露出来的头文件
s.resources = "Resources/*"  #工程需要引入的资源文件(图片,xib等)
s.resource_bundles = 'Resources' => 'XXX.framework/Resources/XXX.bundle' #工程需要引入的bundle
s.frameworks = "ImageIO"  #工程依赖的framework
s.vendored_frameworks = [] #工程依赖的第三方framework
s.libraries = "iconv", "xml2"  #工程依赖的library
s.vendored_libraries = []  #工程依赖第三方的library
s.requires_arc = true  #工程是否用arc规则
s.dependency "AFNetworking", "~> 3.0"  #工程依赖的第三方库

封装一个库最重要的还是source_files,把必须用到的文件导入到主工程。其次就是资源文件resources、frameworks、libraries。

source_files表示在导入的时候会在Classes文件夹下找到所有的.h和.m文件并导入。

s.source_files  = "Classes/**/*.h,m"

s.public_header_files = "Classes/**/*.h"

public_header_files配置只在打包framework的时候起作用,选择暴露出来的头文件。


s.resources = "Resources/*"
//  mj导入资源
s.resource = 'MJRefresh/MJRefresh.bundle'

resources配置工程的资源文件,包括图片、json文件、bundle文件等


s.frameworks = 'UIKit','Foundation'

frameworks配置用到了哪些系统的framework,比如UIKit,Foundation


s.ios.vendored_frameworks = "xxx/**/*.framework"
s.ios.vendored_libraries = "xxx/**/*.a”

 vendored_frameworks, 引用自己或第三方的framework时

vendored_libraries, 引用自己或第三方的.a文件时


s.libraries = 'z','resolv'
----
s.library = 'sqlite3'

这个库依赖于系统Library iconv和xml2,在pod入这个库的时候会带入这个系统Library。注意这里Library的名字只取lib后面的字符。


s.dependency "AFNetworking", "~> 3.0"
----
s.dependency 'sqlite3'

dependency工程依赖的第三方库, 导入你的pod时,也会导入对应的依赖库。


  s.subspec 'standard' do |ss|
    ss.library = 'sqlite3'
    ss.source_files = 'src/fmdb/FM*.h,m'
    ss.exclude_files = 'src/fmdb.m'
    ss.header_dir = 'fmdb'
  end

  # use the built-in library version of sqlite3 with custom FTS tokenizer source files
  s.subspec 'FTS' do |ss|
    ss.source_files = 'src/extra/fts3/*.h,m'
    ss.dependency 'FMDB/standard'
  end

  # build the latest stable version of sqlite3
  s.subspec 'standalone' do |ss|
    ss.xcconfig =  'OTHER_CFLAGS' => '$(inherited) -DFMDB_SQLITE_STANDALONE' 
    ss.dependency 'sqlite3'
    ss.source_files = 'src/fmdb/FM*.h,m'
    ss.exclude_files = 'src/fmdb.m'
    ss.header_dir = 'fmdb'
  end

为了让自己的Pod被导入时显示出良好的文件层划分,subspec是必须的。这个FMDB的写法
若subspec要依赖其它的subspec,则subspec的dependency后面接的不是目录路径,而是specA/specB这种spec关系

其他常见的几个坑, 组件化的坑:在私有Pod中使用主工程的framework

最后放几个Github上常用的三方库,可以参考他们的写法

AFNetworking/AFNetworking.podspec

SDWebImage/SDWebImage.podspec

 MJRefresh/MJRefresh.podspec

jpush-react-native/JPush.podspec

fmdb/FMDB.podspec

以上是关于podspec书写规范的主要内容,如果未能解决你的问题,请参考以下文章

Podspec 验证但未安装文件

使用 cocoapods 的子规范构建 ios 框架的问题

Cocoapod podspec 验证 - 发生未知 DSL 错误

具有每个架构标志的 CocoaPods podspec

无法找到由 [PRIVATE POD] 依赖的 [PUBLIC POD] 的规范

bug标准及书写规范