iOS 创建CocoaPods公有库

大部分同学可能已经掌握了如何正确创建CocoaPods公有库了,网上也有很多详细的文章,笔者之所以写这篇文章是因为自己记性不好,方便自己和像我一样的人查阅,顺便把自己项目里用到的东西分享给大家,而且这些东西真的没必要一定记住,就像其它不常用的API一样,能记住更好,忘记了再查阅一下。

本文以 钥匙串工具类:YXYKeyChainManager 制作过程为例。

pod 'YXYKeyChainManager', '~> 0.0.1'

CocoaPods使用框架的过程图 引用他人

iOS 创建CocoaPods公有库_第1张图片
image.png

一、创建公有Pod库

1、注册CocoaPods账户信息(已注册过请略过)
创建一个开源pod库, 首先我们需要注册CocoaPods账户, 使用trunk方式在终端执行:

pod trunk register '邮箱地址' '用户名'  --description=‘描述内容’ --verbose

可以使用GitHub邮箱和用户名, 然后在你的邮箱中会收到确认邮件, 在浏览器中点击链接确认即注册成功, 成功之后可以终端执行:

pod trunk me
iOS 创建CocoaPods公有库_第2张图片
image.png

2、创建共享库文件并上传到公有仓库
共享库三要素:

2.1、 共享文件夹(文件夹存放着你要共享的内容, 也就是其他人pod得到的文件, .podspec文件中的source_files需要指定此文件路径及文件类型);
2.2、LICENSE文件(默认一般选择MIT);
2.3、库描述文件.podspec(本库的各项信息描述, 需要提交给CocoaPods, pod通过这个文件查找到你共享的库)。

这一步分两种情况:
A、使用现有的想要共享的文件,不提供示例,只需满足上面三个部分,即可上传到公有仓库继续其他的步骤(本文使用的情况);
B、创建一个全新带有示例工程的项目做共享, 可以使用终端命令:

pod lib create '库名'

注:两种情况实际没什么区别,主要区别就是 A:无示例,B:创建带有模板示例。
3、创建仓库

3.1、在GitHub创建一个仓库,建议仓库与项目同名'YXYKeyChainManager':


iOS 创建CocoaPods公有库_第3张图片
1.jpg

3.2、仓库克隆到本地(笔者使用的sourceTree)


iOS 创建CocoaPods公有库_第4张图片
2.jpg
iOS 创建CocoaPods公有库_第5张图片
3.jpg

3.3、创建.podspec文件(路径及项目名根据实际情况替换)

cd /Users/yxy/YXYKeyChainManager
pod spec create YXYKeyChainManager.podspec
iOS 创建CocoaPods公有库_第6张图片
4.jpg

3.4、创建Classes文件夹并拖入源代码文件


5.jpg

4、编辑.podspec文件

Pod::Spec.new do |spec|

  spec.name         = "YXYKeyChainManager"
  spec.version      = "0.0.1"
  spec.summary      = "钥匙串工具类"
  spec.description  = <<-DESC
                      钥匙串工具类:用于方便向钥匙串中存取数据而实现的类。
                      类中包含常用的增、删、改、查方法。
                   DESC

  spec.homepage     = "https://github.com/FreeYXY/YXYKeyChainManager"
  spec.license      = "MIT"
  spec.author             = { "YXY" => "[email protected]" }
  spec.source       = { :git => "https://github.com/FreeYXY/YXYKeyChainManager.git", :tag => "#{spec.version}" }
  spec.source_files  = "Classes", "YXYKeyChainManager/Classes/**/*.{h,m}"
  # spec.platform     = :ios
  # spec.platform     = :ios, "5.0"
  #  When using multiple platforms
  # spec.ios.deployment_target = "5.0"
  # spec.osx.deployment_target = "10.7"
  # spec.watchos.deployment_target = "2.0"
  # spec.tvos.deployment_target = "9.0"
  # spec.exclude_files = "Classes/Exclude"
  # spec.public_header_files = "Classes/**/*.h"
  # spec.resource  = "icon.png"
  # spec.resources = "Resources/*.png"
  # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"
  # spec.framework  = "SomeFramework"
  # spec.frameworks = "SomeFramework", "AnotherFramework"
  # spec.library   = "iconv"
  # spec.libraries = "iconv", "xml2"
  # spec.requires_arc = true
  # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  # spec.dependency "JSONKit", "~> 1.4"

end

这是一个最简单的.podspec文件样式, 各项属性的意思一目了然。

编写完成后需要验证.podspec文件的合法性, 终端执行:

// 若已在此工程目录忽略cd命令
cd /Users/yxy/YXYKeyChainManager
pod lib lint YXYKeyChainManager.podspec

相关命令(可选择使用):

//本地验证
pod lib lint      
//本地和远程验证   
pod spec lint    
// 显示详细的检测过程,出错时会显示详细的错误信息
pod lib lint --verbose
//允许警告,用来解决存在警告导致不能通过校验的
pod lib lint --allow-warnings  

7.jpg

验证成功:
6.jpg

5、打tag、 发布一个release版本(笔者使用sourceTree,可使用命令行)终端命令:

git tag -m '0.0.1'
git push --tag #推送tag到远端仓库

打完tag,将代码推送至git远程仓库,tag版本号必须与.podspec文件中version一致,

spec.version      = "0.0.1"

成功之后即可在你的GitHub-releases里面看到这个tag的版本.


iOS 创建CocoaPods公有库_第7张图片
image.png

6、发布自己的库描述文件.podspec至cocoapods同样在这个文件夹下, 终端执行(--allow-warnings忽略警告):

pod trunk push YXYKeyChainManager.podspec --allow-warnings

将你的库文件.podspec文件提交到公有的specs上面,此命令包含验证.podspec文件是否合法+提交到specs中)+将上传的podspec文件转成json格式文件)。
成功后显示:


iOS 创建CocoaPods公有库_第8张图片
image.png

7、关于查找和使用新创建的库
成功直接pod search YXYKeyChainManager 查看是找不到的,解决办法终端输入:

//pod setup成功后生成的~/Library/Caches/CocoaPods/search_index.json文件, 是用来查找的索引文件
rm ~/Library/Caches/CocoaPods/search_index.json

删除~/Library/Caches/CocoaPods目录下的search_index.json文件, 删除成功后再执行:pod search '库名', 等待输出:Creating search index for spec repo 'master'.. Done! 稍等片刻就会出现你想要的结果~


image.png

iOS 创建CocoaPods公有库_第9张图片
image.png

8、更新维护podspec
后续需要版本迭代,修改工程文件后推送到远端仓库后, 需要修改podspec中的版本号, 并重新打tag上传, 再进行新一轮的验证和发布。

你可能感兴趣的:(iOS 创建CocoaPods公有库)