如何编写一个CocoaPods的spec文件

转载 2014年09月25日 17:59:25

CocoaPods命令介绍

上一篇文章中,已经介绍过CocoaPods的几条基本命令。pod setup用于初始化本地第三方库的Spec描述文件,所有的spec文件存都存放在~/.cocoapods目录中。pod install用来安装或删除Podfile文件声明中的第三方依赖库。下面继续介绍其它一些命令。

$ pod list
# 列出所有可用的第三方库

$ pod search query

搜索名称包含query的类库,query可以替换为你想搜索的名字(如json),不区分大小写。也可以使用pod search --full query命令作更仔细的搜索,该命令不但搜索类库的名称,同时还搜索类库的描述文本,所以搜索速度也相对慢一些。

pod listpod search命令只搜索存在于本地~/.cocoapods文件夹的所有第三方库,并不会连接到远程服务器。如果你要从服务器更新本地第三方库的描述文件,可以:

$ pod repo update master

创建自己项目的Podspec描述文件

CocoaPods还是一个相对年轻的项目,所有的项目的Podspec文件都托管在https://github.com/CocoaPods/Specs。可能有一些库并未收录其中。下面我们通过为微博sso认证登录库编写Podspec文件来学习相关的概念。

初始化一个Podspec文件

$ pod spec create weibo_ios_sdk_sso-oauth

该命令将在本目录产生一个名为weibo_ios_sdk_sso-oauth.podspec的文件。用编辑器打开该文件,里面已经有非常丰富的说明文档。下面我们介绍如何声明第三方库的代码目录资源目录,还有该第三方库所依赖ios核心框架和第三方库。

去除所有的注释,podspec文件如下所示:

Pod::Spec.new do |s|
  s.name     = 'ADVProgressBar'
  s.version  = '0.0.1'
  s.license  = 'MIT'
  s.summary  = 'Progress Bar Design with Percentage values.'
  s.homepage = 'https://github.com/appdesignvault'
  s.author   = { 'appdesignvault' => 'appdesignvault' }
  s.source   = { :git => 'https://github.com/appdesignvault/ADVProgressBar.git', :commit => 'f17b15c15574d6d101cd5fcfd58239e16e806647' }
  s.platform = :ios  
  s.source_files = 'ADVProgressBar/Classes/*.{h,m}'
  s.resources = "ADVProgressBar/Resources/*.png"
  s.framework = 'UIKit'

  s.requires_arc = true  
end

其中s.names.summary用来声明库的名称和一个简短的说明文档。pod search命令就是根据这两项内容作为搜索文本的。s.homepage声明库的主页,s.version库原代码的版本,s.license所采用的授权版本,s.author库的作者。

s.source 声明原代码的地址,以微博sso认证登录库为例,它托管在https://github.com/mobileresearch/weibo_ios_sdk_sso-oauth中,在其未尾加上.git扩展名就是库的原代码地址了,所以该行应声明为:

s.source = { :git => 'https://github.com/mobileresearch/weibo_ios_sdk_sso-oauth.git'}

对于很多第三方库而言,在发布的时候都会打上一个tag,如版本0.0.1就会打上一个名为v0.0.1tag,但是weibo_ios_sdk_sso-oauth库还未打上所何tag,我们可以选择一个最新的commit来作为该库0.0.1版的代码。s.source最终如下:

s.source = { :git => 'https://github.com/mobileresearch/weibo_ios_sdk_sso-oauth.git', :commit => '68defea78942ecc782ffde8f8ffa747872af226d'}

以后我们可以根据该库不同的版本创建相应的podspec文件,例如0.0.20.1.0等。

让我们在浏览器中看一下weibo_ios_sdk_sso-oauth的目录结构:

--
|
+-- demo
|
+-- src
|
+-- .gitignore
|
+-- README.md

demo目录保存一个示例项目,src才是库的原代码目录。src的目录结构如下:

-- src
    |
    +-- JSONKit
    |
    +-- SinaWeibo
    |
    +-- sinaweibo_ios_sdk.xcodeproj
    |
    +-- SinaWeibo-Prefix.pch

JSONKit目录说明这个库本身依赖于JSONKit第三方库。我们可以在podspec文件中的s.dependency声明段中声明。SinaWeibo目录才是包含所有原代码的目录,我们需要在s.source_files中声明

s.source_files = 'src/SinaWeibo/*.{h,m}'

前一部分src/SinaWeibo/是一个相对目录,目录的层级关系一定要跟代码库的保持一致。最后一部分*.{h,m}是一个类似正则表达式的字符串,表示匹配所有以.h.m为扩展名的文件。

src/SinaWeibo/目录下还有一个SinaWeibo.bundle目录,该目录存放一些资源文件(如图片等),这些文件并不需要进行编译。可以使用s.resourcs声明

s.resources = "src/SinaWeibo/SinaWeibo.bundle/**/*.png"

前一部分跟上面相同,**表示匹配所有子目录,*.png表示所有以.png为扩展名的图片文件。

通过查看代码我们知道,weibo_ios_sdk_sso-oauth还依赖一个ios的核心库QuartzCore

s.framework = 'QuartzCore'

在前面我们已经说过,weibo_ios_sdk_sso-oauth库自身也依赖于另外一个第三方库JSONKit,声明如下:

s.dependency 'JSONKit', '~> 1.4'

这行声明与Podfile文件中的声明类似。

最终的结果如下:

Pod::Spec.new do |s|
  s.name         = "weibo_ios_sdk_sso-oauth"
  s.version      = "0.0.1"
  s.summary  = 'weibo.com sso oauth, 微博sso认证登录功能'
  s.homepage     = "https://github.com/mobileresearch/weibo_ios_sdk_sso-oauth"
  s.license      = 'MIT'
  s.author       = {'mobileresearch' => 'mobileresearch'}
  s.source       = { :git => 'https://github.com/mobileresearch/weibo_ios_sdk_sso-oauth.git', :commit => '68defea78942ecc782ffde8f8ffa747872af226d' }
  s.platform = :ios
  s.source_files = 'src/SinaWeibo/*.{h,m}'
  s.resources = "src/SinaWeibo/SinaWeibo.bundle/**/*.png"
  s.framework  = 'QuartzCore'
  s.dependency 'JSONKit', '~> 1.4'
end

可以将该spec文件保存到本机的~/.cocoapods/master/目录中仅供自己使用,也可以将其提交到CocoaPods/Specs代码库中。下面我们将其保存到本机中

$ mkdir -p ~/.cocoapods/master/weibo_ios_sdk_sso-oauth/0.0.1
$ cp weibo_ios_sdk_sso-oauth.podspec ~/.cocoapods/master/weibo_ios_sdk_sso-oauth/0.0.1

是否可以通过搜索找到该库:

$ pod search weibo

同样在需要依赖于weibo_ios_sdk_sso-oauth这个库的项目,可以将下列添加到项目的Podfile文件中

pod 'weibo_ios_sdk_sso_oauth', '0.0.1'

保存文件,并用pod install安装weibo_ios_sdk_sso-oauth库。

转载请注明原作者

Oct 16th, 2012

podspec文件的写法详解

创建pod库的时候会用到podspec文件将lib中用到的包括资源、源码、需要引用的framework,以及第三库等等组织起来。这篇文章会详细的解释一下podspec的写法。...
  • u010990519
  • u010990519
  • 2017年02月19日 15:21
  • 2865

.podspec文件

前言本篇主要讲解组件化架构思想,从零教你如何组件化一个项目,当然组件化也遇上许多坑,这里非常感谢小码哥王顺子老师的帮助。如果喜欢我的文章,可以关注我微博:袁峥Seemygo,也可以来小码哥,了解下我们...
  • alinagebaba
  • alinagebaba
  • 2017年04月24日 13:24
  • 465

CocoaPods详解之----制作篇

CocoaPods详解之----制作篇 作者:wangzz 原文地址:http://blog.csdn.net/wzzvictory/article/details/19178709 转载请注...
  • wzzvictory_tjsd
  • wzzvictory_tjsd
  • 2014年03月04日 16:05
  • 28749

cocoapods_从安装使用到创建自己的podspec

Cocoapods 从安装使用到创建自己的podspec Cocoapods简介当你开发iOS应用时,会经常使用到很多第三方开源类库,比如JSONKit,AFNetWorking等等。如果使 用他们,...
  • hytzxd
  • hytzxd
  • 2015年06月26日 17:16
  • 4380

[CocoaPod]基于私有仓库的pod创建问题

问题列表 pod spec lint命令,校验pod的代码和配置时是从git上拉取的代码进行编译;所以如果未创建git,会报以下错误:...
  • jhq1990
  • jhq1990
  • 2016年09月21日 22:22
  • 5620

通过CocoaPods 将storyboards、xibs和资源文件打包到iOS framework

原文:点击打开链接 (本文可与上文一起观看) For the last month we have been working on creating Tapglue Elements, a fra...
  • Enter_
  • Enter_
  • 2016年11月16日 19:23
  • 2730

CocoaPods私有库创建遇到的问题

一、前言在iOS开发中,为了满足企业内部的一些组件化需求,往往需要创建一些公用的代码,这些公用代码往往是不希望被公开的,此时一般可以选择submodule或者CocoaPods库的形式。如果选用sub...
  • andanlan
  • andanlan
  • 2016年01月14日 10:23
  • 7020

CocoaPod代码库创建,配置Spec踩过的坑

1、代码中包含静态库 s.vendored_libraries = '/Pod/Classes/*.a' 2、ARC工程中部分文件为 MRC non_arc_files = 'Pod/Class...
  • xiaofei125145
  • xiaofei125145
  • 2016年02月16日 11:00
  • 5663

如何编写一个CocoaPods的spec文件

CocoaPods命令介绍 在上一篇文章中,已经介绍过CocoaPods的几条基本命令。pod setup用于初始化本地第三方库的Spec描述文件,所有的spec文件存都存放在~/.cocoapod...
  • zaitianaoxiang
  • zaitianaoxiang
  • 2014年09月25日 17:59
  • 4041

iOS 开发 - 亲身经历告诉你如何把自己的库通过pod导入(详细步骤)

记得一次面试有人问我有没有自己开源一些库,有是有的,但是确没有制作成可以通过pods导入的库,此乃一大憾事,后来跟着网上很多教程在那里捣鼓了半天,真的是半天时间,压根没用,今天无意间看到一篇博客,ht...
  • CodingFire
  • CodingFire
  • 2016年09月08日 13:55
  • 7200
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:如何编写一个CocoaPods的spec文件
举报原因:
原因补充:

(最多只允许输入30个字)