如何将自己的组件库使用CocoaPods管理

2,135 阅读5分钟

使用CocoaPods的好处

  • 未使用CocoaPods:集成的时候需要将源码拖到⼯程⾥面,⼿动添加组件需要依赖的系统库以及根据需要添加 -ObjC 、 -fno-objc-arc等,升级组件也需要重复之前的步骤
  • 使⽤CocoaPods:修改podfile⽂件后,⼀⾏命令集成,升级或移除组件库,不需要额外操作

使用CocoaPods管理组件化开发

1.注册trunk

  • 不是任何人都能推送,因为cocoapods依赖trunk服务器管理,所以需要通过trunk推送⾃己的podspec
  • 命令: pod trunk register xxxx@qq.com 'name'
  • 收到邮件有点开链接访问⼀下就好了

2.podspec

Cocopods原理:根据Podfile描述,找到对应代码库的podspec⽂件然后根据podspec中的描述,找到代码库,并且找到之后,拷⻉需要的⽂件到⾃己的⼯程中。

  • 创建spec文件命令: pod spec create spec文件名
Pod::Spec.new do |s| #设置组件库的名称
     s.name =
"YuntxIMLib"
#设置组件库的版本号 s.version = "5.4.9"
#组件库的简介
s.summary = "容联云通讯IM SDK(如果看不到最新版本,请使⽤pod repo update 命令更新一下本地pod仓库)"
# 组件库的详情描述,要求⽐简介的字数多些 s.description = <<-DESC
#设置仓库主页 s.homepage
#设置许可 s.license
#设置作者 s.author
容联云通讯SDK YuntxIMLib. (如果看不到最新版本,请使用 pod repo update 命令更新⼀下本地pod仓库) DESC
= "https://www.yuntongxun.com/"
= "MIT"
= { "author" => "xxxx@qq.com" }
#设置支持的最低系统版本 s.ios.deployment_target = "8.0"
#设置仓库源,表示在哪可以找到组件⼯工程
s.source = { :git => "https://gitlab.com/YuntxSDK/YuntxIMLib.git", :tag => "#{s.version}" }
#资源⽂文件
s.resources = "sdk/CCPSDKBundle.bundle"
#设置源⽂件路径,不是整个⼯程的文件,⽽是⾃己封装的需要暴露出来的代码,以后别的⼯程引⼊,就会引⼊这里的代码。 s.source_files = "sdk/*.h"
#设置使用的静态库(非系统) s.vendored_library = 'sdk/*.a'
#设置依赖库(系统),不需要 lib,例如: libicucore写成icucore即可
s.libraries = "resolv.9","icucore","sqlite3","z","xml2","bz2.1.0","c++"
#设置依赖的 framework(系统),写的时候不需要后缀名
s.framework = "CoreTelephony","MediaPlayer","CFNetwork","SystemConfiguration","MobileCoreServices","AudioToolbox","AVFoundation","Vide
oToolbox"
#设置使用的framework(非系统) # vendored_frameworks = ""
#设置⼦目录
s.subspec 'Delegate' do |ss| ss.source_files = "sdk/Delegate/*.h"

  end
s.subspec 'enums' do |ss| ss.source_files = "sdk/enums/*.h" end
s.subspec 'Manager' do |ss| ss.source_files = "sdk/Manager/*.h" end
s.subspec 'private' do |ss| ss.source_files = "sdk/private/*.h" end
s.subspec 'types' do |ss|
ss.source_files = "sdk/types/*.h","sdk/types/LiveChatRoomType/*.h" end
s.subspec 'board' do |ss| ss.source_files = "sdk/board/*.h" end
#设置组件库是否是基于 ARC 内存管理的,默认为 true,如果不是,会自动添加-fno-objc-arc s.requires_arc = true
#如果部分是ARC
#spec.requires_arc = false
#spec.requires_arc = ['Classes/*ARC.m', 'Classes/ARC.mm'] //指定 MRC 的⽂件
#设置依赖的其他 pod 库
# s.dependency "JSONKit", "~> 1.4"
#设置xcconfig s.xcconfig = {
'OTHER_LINKER_FLAGS' => '-ObjC',
'ENABLE_BITCODE' => 'NO' }
end
- 文件名匹配
 - * 匹配所有⽂件
 - c* 匹配以名字C开头的文件
 - *c 匹配以名字c结尾的文件
 - *c* 匹配所有名字包含c的文件
 - ** 文件夹以及递归子文件夹
 - ? 任意⼀个字符(注意是⼀个字符) 
 - [set] 匹配多个字符,⽀持取反
 - {p,q} 匹配名字包括p 或者 q的⽂件
  • 给⾃己仓库绑定Tag,因为cocoapods是根据代码仓库的Tag,去下载对应Tag的远程代码库的。
git tag 0.0.1
git push --tags

3.验证pod 库

  • 命令:pod lib lint
  • 命令后加--verbose 打印详细 log
  • 命令后加 --allow-warnings 当出现警告,但是不影响 pod 库的使⽤的时候会验证通过
  • 命令后加 --use-libraries 使⽤了⾃己的私有库,不加可能会验证不通过,加了就没问题

4.推送⾃己的podspec到cocoapods的索引库

  • 命令:pod trunk push --verbose --allow-warnings --use-libraries ,后⾯的命令作用同上
  • 注意:必须cd 进⼊到podspec⽬录下,才能执⾏行行这个代码
  • 注意:podspec文件中的s.version版本号要跟最新tag一致
  • 注意:podspec文件中的s.source仓库地址也不能写错

5.测试能否索引到

  • 命令: pod search 组件库名称
  • 如果搜索不到⾃己的组件库,但是⼜ pod trunk push 成功了,说明本地pod索引库没有更新
  • 更新本地 pod 索引库
  1. rm ~/Library/Caches/CocoaPods/search_index.json 
  2. pod setup
  3. pod search name

6.其他

  • 给增加其他维护者: pod trunk add-owner YuntxIMLib ronglianssy@163.com
  • 移除其他维护者: pod trunk remove-owner YuntxIMLib ronglianssy@163.com
  • 升级组件库:修改组件代码,打 tag,push 到远程代码库,修改 podspec⽂件中的 s.version重复步骤3,4,5即可
  • 从 pod 索引库移除组件库打开终端,输⼊以下指令:
1. pod trunk delete name tag 
2. rm ~/Library/Caches/CocoaPods/search_index.json 
3. pod setup 
4. pod search name

7.可能遇到的问题

pod lib lint/repo push不支持i386编译&只能真机运⾏行行的库

  • 终端 gem which cocoapods
  • 进⼊ /usr/local/lib/ruby/gems/2.5.0/gems/cocoapods-1.6.0.beta.1/lib
  • 在当前lib⽬目录下有个cocoapods文件夹,找到validator.rb ⽂件
  • 因为不能直接修改 validator.rb ⽂件,所以用命令: sudo vim validator.rb⽂件路径 ,输⼊密码后即可编辑,将上图红框中部分该成下面,这样就能绕过 pod lib lint 检测了
# command += %w(CODE_SIGN_IDENTITY=- -sdk iphonesimulator)
# command += Fourflusher::SimControl.new.destination(:oldest, 'iOS', deployment_target)
command += %w(--help)#为了了绕过模拟器器检测不不通过的 bug

8.基于本地pod库的组件化

上⾯讲到的⽅法是将组件库托管到公有远程仓库,任何人都可以下载集成组件库。但是有时候我们公司内部的⼀些大型项目也使用了组件化⽅方式来开发,这时候我们的组件库就不需要专⻔放到远程仓库来托管,照样也可以使用CocoaPods来管理。

  • 如图新建三个工程: MainTarget 是主工程,ComponentA,ComponentB分别是两个不同的组件⼯程
  • 设置组件⼯程的 podspec⽂件
Pod::Spec.new do |spec|
 spec.name
spec.version
spec.summary
spec.homepage
spec.license
spec.author
spec.source
spec.source_files = "ComponentA/Class/*.{h,m}"
= "ComponentA"
= "0.0.1"
= "A short description of ComponentA." = "https://www.yuntongxun.com/"
= "MIT"
= { "author" => "xxxx@yuntongxun.com" } = { :path => 'ComponentA.podspec' }
end

这里主要是 spec.source组件路径要指向自身,其他的配置根据实际需要可以添加

  • MainTarget 的 Podfile⽂件
target 'MainTarget' do
pod 'ComponentA' , :path => '../ComponentA'
end

执行 pod install 后, MainTarget 主⼯程就会将 ComponentA 组件集成进来