1.创建组件
pod lib create '组件名'
# 使用平台
What platform do you want to use?? [ iOS / macOS ]
> iOS
# 使用语言
What language do you want to use?? [ Swift / ObjC ]
> ObjC
# 在组件中创建一个Example
Would you like to include a demo application with your library? [ Yes / No ]
> Yes
# 是否添加测试框架
Which testing frameworks will you use? [ Specta / Kiwi / None ]
> None
# 是否添加UI测试
Would you like to do view based testing? [ Yes / No ]
> No
# 组件类前缀
What is your class prefix?
> YDD
执行完成后打开工程目录如图1:
将组件文件创建在图中ReplaceMe.m文件位置,将组件文件存储在ReplaceMe.m的文件夹Classes目录下,并删除ReplaceMe.m文件。
2.修改podspec描述文件
Cocopods原理:根据Podfile描述,找到对应代码库的podspec文件
然后根据podspec中的描述,找到代码库,并且拷贝需要的文件到自己的工程中。
如果组件工程已近存在,则直接在组件工程目录创建podspec文件即可
pod spec create '组件名'
Pod::Spec.new do |s|
# 组件名称
s.name = 'YDDCategroy'
# 组件版本号
s.version = '0.1.0'
# 组件简介
s.summary = 'A short description of YDDCategroy.'
# 组件详细描述,要比简介字数多一些
s.description = <<-DESC
TODO: Add long description of the pod here.
DESC
# 组件仓库
s.homepage = 'https://github.com/***/YDDCategroy'
# s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
# 设置许可
s.license = { :type => 'MIT', :file => 'LICENSE' }
# 组件作者
s.author = { '***' => '***' }
# 组件仓库源,表示在哪可以找到组件工程(支持 git、svn、http 服务器)
s.source = { :git => 'https://github.com/***/YDDCategroy.git', :tag => s.version.to_s }
# s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
# 组件支持的最低系统版本
s.ios.deployment_target = '9.0'
# 组件库需要暴露的文件
s.source_files = 'YDDCategroy/Classes/**/*'
# 设置依赖库(系统),不需要 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","VideoToolbox"
# 设置使用的静态库(非系统)
s.vendored_library = 'sdk/*.a'
# 设置使用的framework(非系统)
s.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"
# 三级目录
ss.subspec 'LiveChatRoomType' do |sss|
sss.source_files = "sdk/types/LiveChatRoomType/*.h"
end
end
s.subspec 'board' do |ss|
ss.source_files = "sdk/board/*.h"
end
# s.resource_bundles = {
# 'YDDCategroy' => ['YDDCategroy/Assets/*.png']
# }
# s.public_header_files = 'Pod/Classes/**/*.h'
# s.frameworks = 'UIKit', 'MapKit'
# 设置依赖的其他 pod 库
# s.dependency 'AFNetworking', '~> 2.3'
end
3.将本地组件push到远端仓库
在自己的github上新建组件仓库,将本地代码推向远端,并且打tag,注意tag版本号要和podspec文件中的版本号一直。
# 创建tag版本
git tag -a 0.1.0 -m '描述'
# 将本地所有tag版本push到远端
git push origin --tag
4.验证组件
验证组件,保证组件代码编译是没有问题的,verbose打印log,allow-warnings忽略警告保证lint通过,如果是私有组件要在后面添加--use-libraries
pod lib lint --verbose --allow-warnings
验证私有组件:
pod spec lint YDDCategroy.podspec --allow-warnings --use-libraries --platforms=ios --skip-import-validation --sources=https://github.com/***/privatespec.git
如果私有组件中依赖私有库,需要将sources指向私有spec地址
5.将组件的podspec描述文件推送到cocoapods
pod trunk push --verbose --allow-warnings --use-libraries
如果你的github账号之前没有注册cocoapod是不能推送podspec文件的,所以需要先注册。
pod trunk register 'git邮箱' 'git用户名'
执行完成后会收到验证邮件,在邮箱验证即可。
通过以上过程自己的pod库就已经制作完毕,在第一使用pod install时没有找到自己的库,可能是本地trunk没有更新的原因吧,使用pod update是可以导入。如果是Podfile文件指定的iOS版本低于podspec中指定的iOS版本也会报错找不到对应的库,这种情况可以修改Podfile文件也可以修改podspec文件中系统版本,修改podspec文件后需要重新上传。
6.更新组件:
更新完组件代码后修改podspec文件中的s.version版本号,然后提交组件代码到远程仓库并且打tag版本,tag版本号与podspec中的s.version版本号一致,然后安装步骤4验证podspec文件,最后将podspec文件推送到私有spec仓库。
# 更新cocoapod中的podspec
pod trunk push
# 更新私有仓库podspec
pod repo push PrivatePods YDDCategroy.podspec
如果报错后面加上 --verbose --allow-warnings --use-libraries --skip-import-validation
pod repo push PrivatePods YDDCategroy.podspec --verbose --allow-warnings --use-libraries --skip-import-validation
7.本地组件
组件在开发过程中还没有推送到远端,这时候需要使用本地组件,在主工程中对组件进行开发。
- 1.修改本地组件的podspec文件中的spec.source路径,使其指向自己的本地文件路径。
# path 为podspec文件目录下的相对路径
spec.source = { :path => 'YDDCategroy.podspec' }
- 2.修改Podfile文件中的pod, 添加path本地文件路径
target 'TestDemo' do
pod 'YDDCategroy', :path => '../YDDCategroy'
end
path路径可以是绝对路径也可以是相对路径,这里使用相对路径,由于TestDemo工程文件夹和YDDCategroy组件工程文件夹是同级文件夹,Podfile在TestDemo文件夹下,而YDDCategroy.podspec在YDDCategroy文件夹下,所以../指向TestDemo和 YDDCategroy的上级文件目录,YDDCategroy.podspec的文件目录的相对路径为 '../YDDCategroy' 。
如果组件代码已经在远端仓库,可以不用修改podspec文件的spec.source,直接修改Podfile文件中的path路径即可。
执行pod install后就会发现在工程的pods里面多了Development Pods,这时候说明可以直接在TestDemo工程中对组件进行开发。
8.构建私有podspec仓库
- 1.在github上新建一个privatespec仓库用来存储私有组件的podspec文件。
- 2.cd到 ~/.cocoapods/repos文件目录添加privatespec
pod repo privatespec https://github.com/***/privatespec.git
- 3.cd到组件文件目录,将组件podspec推送到Privatespec仓库
pod repo push [私有spec仓库名] [组件.podspec] --sources=私有spec仓库地址
pod repo push Privatespec YDDCategroy.podspec --sources=https://github.com/***/privatespec.git --verbose --allwo-warnings --use-libraries
- 4.验证私有spec仓库
新建一个demo工程,在Podfile文件顶行添加sources指向私有仓库
source 'https://github.com/***/privatespec.git'
platform :ios, '9.0'
target 'PrivateSpecTest' do
pod 'YDDCategroy'
end
pod update 即可
9.pod组件中添加资源文件
组件工程文件结构如下图2:
Assets用来存放资源文件,Classes文件用于存放类文件。使用pod将组件导入主工程后,组件实质上是作为framework库存在于工程中,此时在读取资源时直接使用[NSBundle mainBundle]是获取不到资源文件的。
- 1.加入资源文件
首先将图片等资源文件放入Assets文件夹下,然后修改podspec文件中的resource_bundles,设置组件bundle
s.resource_bundles = {
'YDDCategroy' => ['YDDCategroy/Assets/*']
}
修改完成后 pod install
- 2.查看组件资源
编译工程后在Products目录找到App包。显示报内容,文件结构如下图3、4:
(1)pod使用framework,即:Podfile文件顶部有 : use_frameworks!
(2)pod不使用framework,即:Podfile文件顶部没有 : use_frameworks!
- 3.读取组件资源
在读取资源时需要先找到YDDCategroy bundle,在通过bundle路径读取资源。
/// 获取framework组件bundle
/// @param pod 组件名
/// @param bundleName 组件bundle名(不带扩展名)
+ (NSBundle *)ydd_bundleWithPod:(NSString *)pod bundleName:(NSString *)bundleName {
NSString *path = [[NSBundle mainBundle] pathForResource:@"Frameworks" ofType:nil];
if (!path) {
/// pod没有使用 framework
path = [[NSBundle mainBundle] resourcePath];
NSString *bundlePath = [NSString stringWithFormat:@"%@/%@.bundle", path, bundleName];
return [NSBundle bundleWithPath:bundlePath];
}
NSString *bundlePath = [NSString stringWithFormat:@"%@/%@.framework/%@.bundle", path, pod, bundleName];
return [NSBundle bundleWithPath:bundlePath];
}
参考:https://www.jianshu.com/p/e3ec9a8bec97
参考:https://www.dazhuanlan.com/2019/12/14/5df40a0b09d99/