CocoaPods 创建自己的公开库

年底了可支配的时间逐渐变多了...不爱写文章的我...也出来遛遛...

在这里用一个自己在项目中编写的小工具来演示向CocoaPods发布自己的库,假设您已对【git】和【cocoapods】略知一二
操作环境:Macbook OSX Catalina 10.15.2 (19C57)

一个用于发送POST、GET请求的简单网络代理协议:RC_NetworkProxy

一、注册CocoaPods认证信息

要公开发布Pod库需要向CocoaPods trunk注册身份(设备)认证信息
pod trunk register your-email@xx.com 'username' --description='some description'

  • 邮箱:要替换成自己的邮箱
  • 用户名:可以写github的用户名或其它
  • 填写无误注册后邮箱会收到一个验证链接,点击链接进行确认:
    https://trunk.cocoapods.org/sessions/verify/xxxxx
  • 注册成功后,终端输入命令即可查看自己的注册信息:pod trunk me

注册信息
- Name: 注册用户
- Email: 注册邮箱
- Since: 注册时间
- Pods:
- RC_NetworkProxy ... 你的提交过的pods
- Sessions:
- 有效日期,注册ip地址,注册时输入的‘description’

二、创建自己的Pod库

  • 先在Github上创建一个仓库然后克隆到本地,也可以在本地添加远程仓库然后推送到Github
  • LICENSE文件是必须的
  • README文件也是必不可少,你应该知道它的作用是什么

2.1 新建仓库

  1. 在Github上新建一个仓库:RC_NetworkProxy
  2. 克隆仓库到本地:git clone https://github.com/Hymn-RoyCHANG/RC_NetworkProxy.git 这里使用的是Https的方式克隆,你也可以使用SSH方式

2.2 创建Pod

克隆下来后进入'RC_NetworkProxy'目录,然后执行:
pod spec create RC_NetworkProxy
目录下会生成 RC_NetworkProxy.podspec文件,然后编辑该文件,我用的Sublime Text编辑的。
(如果使用pod lib create RC_NetworkProxy会根据pod模板生成一个目录结构包括、源码、示例、测试等目录,这里不做介绍)

2.2.1. 添加源码文件

源码工程在其它project编写,所有这里直接把源码目录粘贴过来,后续可以集成到仓库里这样更方便。

当前目录结构如下:

RC_NetworkProxy
├── LICENSE
├── RC_NetworkProxy
│   ├── RC_NetworkProtocol_Help
│   │   ├── RC_HTTPRequest.h
│   │   ├── RC_HTTPRequest.m
│   │   ├── RC_HTTPResponse.h
│   │   ├── RC_HTTPResponse.m
│   │   ├── RC_JSON.h
│   │   ├── RC_JSON.m
│   │   ├── RC_NetworkProtocol.h
│   │   ├── RC_NetworkProtocol.m
│   │   ├── RC_NetworkProtocol_Help.h
│   │   ├── RC_NetworkProxyDefines.h
│   │   └── RC_NetworkProxyDefines.m
│   ├── RC_NetworkProtocol_Imp
│   │   ├── RC_NetworkProtocol_Imp.h
│   │   └── RC_NetworkProtocol_Imp.m
│   ├── RC_NetworkProxy.h
│   └── RC_NetworkProxy.m
├── RC_NetworkProxy.podspec
└── README.md

隐藏的目录还有.git、.gitignore

2.2.2 编辑podspec文件

'podspec'文件包含了Pod库的名字、版本、作者、描述、资源文件、支持平台版本、依赖库、许可文件等属性信息。
其中下面的属性是必须的:
name:库名称
version:版本,必须与仓库的tag对应
author:作者,名字,邮箱等
license:许可文件
homepage:库的主页,如果Github上的主页
source:仓库的远程地址,install是这里下载,包括,标签,分支等
summary:对库的简短的描述,最大140个字符

查看podspec文件更多属性、更多写法

来个示例:

Pod::Spec.new do |spec|
  spec.name = 'RC_NetworkProxy'
  spec.version = '0.1.5'
  spec.ios.deployment_target = '8.0'
  # 仓库主页
  spec.homepage = 'https://github.com/Hymn-RoyCHANG/RC_NetworkProxy'
  spec.license = 'MIT'
  # 作者,可以多个
  spec.authors = { 'your name' => 'email@xxx.com' }
  # install时会根据git地址和指定的tag去下载代码
  spec.source = { 
                  :git => 'https://github.com/Hymn-RoyCHANG/RC_NetworkProxy.git', 
                  :tag => spec.version
                }
  spec.summary = 'RC_NetworkProxy is a simple network proxy protocol for sending POST and GET etc.'
  # 源文件,把所有要依赖的文件导入进来,这个是物理路径也就是podspec文件的同级目录开始查找,可以使用通配符来检索
  spec.source_files  = 'RC_NetworkProxy/*.{h,m}'
  # 只支持 ARC
  spec.requires_arc = true
  # 依赖的系统框架
  spec.frameworks  = 'Foundation'
  
  # 常用的 AFNetworking install下来你会发现有子目录,就是通过‘subspec’来实现的
  spec.subspec 'RC_NetworkProtocol_Help' do |shelp|
    # 源文件
    shelp.source_files = 'RC_NetworkProxy/RC_NetworkProtocol_Help/*.{h,m}'
  end
  
  spec.subspec 'RC_NetworkProtocol_Imp' do |simp|
    # 这个是外部资源依赖,有多个依赖就要写多个‘dependency’
    simp.ios.dependency 'AFNetworking', '~> 3.2.1'
    # 这个是依赖的Spec内部的子Spec,这个不是物理路径,相当于内部的引用,‘RC_NetworkProxy’ 下的 ‘RC_NetworkProtocol_Help’
    simp.ios.dependency 'RC_NetworkProxy/RC_NetworkProtocol_Help'

    simp.source_files = 'RC_NetworkProxy/RC_NetworkProtocol_Imp/*.{h,m}'
  end
end
  • 如果不引入‘subspec’,那么所有‘ spec.source_files’引入的文件在pod install后将全部放入同一个文件夹‘RC_NetworkProxy’下,对于有洁癖的人来说是无法接受的
  • 如果使用了‘subspec’就要保证所有‘subspec’不能互相依赖否则无法通过验证也无法提交的,在设计编写代码时要注意。比如:
    shelp.dependency 'RC_NetworkProxy/RC_NetworkProtocol_Imp'
    simp.dependency 'RC_NetworkProxy/RC_NetworkProtocol_Help'
    --------
    这种互相依赖的情况就会报错:
    - ERROR | [iOS] unknown: Encountered an unknown error (There is a circular dependency between RC_NetworkProxy/RC_NetworkProtocol_Imp and RC_NetworkProxy/RC_NetworkProtocol_Help) during validation.
  • 针对‘podspec’的编写可以参考其它仓库的编写,比如'AFNetworking'、'SDWebImage'等
  • 官方建议把没用的注释都去掉

2.3 提交到远程仓库

到这里准备的差不多了,将本地仓库目录下的所有文件推送的远程:

  1. 在提交前git需要知道提交人的信息:nameemail
    如果没有设置的话需要设置一下:
  • git config --local user.name 'xxxx'
  • git config --local user.email 'xxx@xxx.com'
    这是针对当前git仓库的设置,如果是全局设置则 将 '--local' 换成 '--global'
  1. 提交文件、打版本:
  • pod add .
  • pod commit -m "your description"
  • git push -u origin master (本地只有master也可以直接推送:git push
  • git tag 0.1.0,一定要打个tag且要和'podspec'文件中的'version'对应
  • git push origin 0.1.0,将tag推送到远程(推送所有tag:git push --tags

如果不是克隆仓库到本地则在'push'到远程仓库之前需要把本地和远程关联在一起:git remote add origin https://github.com/Hymn-RoyCHANG/RC_NetworkProxy.git
然后再'push'和打标签

2.4 验证podspec文件

验证有两种方式:

  • pod lib lint 本地验证不会联网
  • pod spec lint 本地和远程验证,会联网

我们是发布自己的库到CocoaPods所以使用第二种方式:
pod spec lint RC_NetworkProxy.podspec --allow-warnings --verbose

如果出现podspec的警告或者错误则无法通过验证

  • --allow-warnings:忽略所有警告
  • --verbose:验证时的详细信息,如果有错误或者警告会更方便查明原因

如果验证通过则打印如下:

RC_NetworkProxy.podspec passed validation.

三、发布Pod库到CocoaPods

提交所有文件到远程仓库、打好tag和验证无误后将我们的库提交给'CocoaPods'
pod trunk push RC_NetworkProxy.podspec
等待一段时间...

Updating spec repo `trunk`

--------------------------------------------------------------------------------
 ??  Congrats

 ??  RC_NetworkProxy (0.1.5) successfully published
 ??  January 9th, 20:43
 ??  https://cocoapods.org/pods/RC_NetworkProxy
 ??  Tell your friends!
--------------------------------------------------------------------------------

看到这段文字就说明成功了~~~

如果验证通过,提交报错则要看当前的'podspec'文件设置的版本是不是和之前提交的版本有冲突,如果不是版本问题可以在提交时加上参数选项查看细节:
pod trunk push RC_NetworkProxy.podspec --allow-warnings --verbose

四、Pod搜索不到

  • 提交成功后如果搜索不到,需要执行:
    git repo update
  • 如果缓存索引的问题需要删除该索引:
    rm -f ~/Library/Caches/CocoaPods/search_index.json

搜索:
pod search RC_NetworkProxy

-> RC_NetworkProxy (0.1.5)
   RC_NetworkProxy is a simple network proxy protocol for sending POST and GET etc.
   pod 'RC_NetworkProxy', '~> 0.1.5'
   - Homepage: https://github.com/Hymn-RoyCHANG/RC_NetworkProxy
   - Source:   https://github.com/Hymn-RoyCHANG/RC_NetworkProxy.git
   - Versions: 0.1.5, 0.1.4, 0.1.3, 0.1.2, 0.1.1, 0.1.0 [trunk repo]
   - Subspecs:
     - RC_NetworkProxy/RC_NetworkProtocol_Help (0.1.5)
     - RC_NetworkProxy/RC_NetworkProtocol_Imp (0.1.5)

五、到这里就完了吗?

......???

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,029评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,238评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,576评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,214评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,324评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,392评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,416评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,196评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,631评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,919评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,090评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,767评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,410评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,090评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,328评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,952评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,979评论 2 351