iOS 创建pod库并发布到远程仓库

一、前言

我们在开发中经常会用到三方开源库,极大的方便了我们的开发工作,可以快速便捷的实现功能,完成开发任务,那么我们自己如何创建上传开源库呢?请继续看下面内容

二、pod创建与使用

1、创建本地pod所需项目文件

在终端,cd到指定文件夹,执行:pod lib create xxxx,结果如图,按照提示选择对应的选项,这样项目就创建成功了

lib创建.png

2、模版创建成功并调试

  • 创建成功后,下图中的Classes文件内部就是放我们代码的地方,删除自动生成的文件,添加我们自己的库文件,执行pod install, 文件会自动导入, 运行Example,并在里面调试我们的库文件

    项目结构图.png

  • 库文件调试成功


    调用效果图.png

3、提交代码并校验

  • 更改文件:打开Example中的项目,找到项目的podspec文件,更改内容如下

更改详情可以参考:podspec详解

#
# Be sure to run `pod lib lint HHTestKit.podspec' to ensure this is a
# valid spec before submitting.
#
# Any lines starting with a # are optional, but their use is encouraged
# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html
#

Pod::Spec.new do |s|
  s.name             = 'HHTestKit' #库的名称
  s.version          = '0.1.0' # 库的版本号,我们每次发新版本的时候版本号需要对应修改
  s.summary          = 'A short description of HHTestKit.' # 库的简单描述

# This description is used to generate tags and improve search results.
#   * Think: What does it do? Why did you write it? What is the focus?
#   * Try to keep it short, snappy and to the point.
#   * Write the description between the DESC delimiters below.
#   * Finally, don't worry about the indent, CocoaPods strips it!
# 库的详细信息
  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
# 主页
  s.homepage         = 'https://github.com/Ccalary/HHTestKit.git'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
# 遵循的协议
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
# 作者
  s.author           = { 'hh' => '[email protected]' }
# 库的git地址,tag就是对应的版本,注意这个tag就是发布的时候的版本,我们引用第三方库时,有时候要指定版本,对应的就是这个版本号
  s.source           = { :git => 'https://github.com/Ccalary/HHTestKit.git', :tag => s.version.to_s }
  # s.social_media_url = 'https://twitter.com/'
# 系统版本
  s.ios.deployment_target = '9.0'
# 库的文件
  s.source_files = 'HHTestKit/Classes/**/*'
  
  # s.resource_bundles = {
  #   'HHTestKit' => ['HHTestKit/Assets/*.png']
  # }
  # 设置swift的版本号
  # s.swift_version = '5.0'
  # s.public_header_files = 'Pod/Classes/**/*.h'
  # s.frameworks = 'UIKit', 'MapKit'
# 三方库依赖
  # s.dependency 'AFNetworking', '~> 2.3'
end
  • 更改后进行本地测试,cd 到 Example,执行 pod install

  • 上传代码到仓库
    在GitHub创建空的代码仓库HHTestKit,将本地pod项目工程上传


    代码上传仓库.png

打tag,这里需要重点注意的是,我们给打的标签值要与podspec文件中的版本号一致。这里查看podspec文件tag版本号为0.1.0,这个就是我们引用三方库时对应的版本号

tag.png

仓库结果.png
  • 校验
    cd到项目,输入指令:pod lib lint HHTestKit.podspec --allow-warnings,进行本地校验
    HHTestKit.podspec 是你的文件名称 --allow-warnings 是忽略警告等信息,出现如下结果,校验成功
    本地校验.png

    输入指令:pod spec lint HHTestKit.podspec --allow-warnings,进行远程校验
    远程校验.png

4、发布到cocoapods仓库

指令:pod trunk push HHTestKit.podspec --allow-warnings

1、pod trunk 可能会失败,需要个人信息验证,参考:Cocoapods使用详解--5、自定义仓库
2、M1芯片电脑,继续报错[!] Oh no, an error occurred., ,参考:pod install error: miss ffi
解决方案:
先执行:sudo arch -x86_64 gem install ffi
再执行:arch -x86_64 $SHELL
启动一个 X86 模式终端,使得之后运行的命令都在 X86 模式下运行
重新执行发布指令:pod trunk push HHTestKit.podspec --allow-warnings

image.png

5、检验和使用

  • 查看指令:pod search HHTestKit,查看到自己的库已经存在了,下面我们就可以使用了

刚上传的库无法搜索到解决方案

结果.png
  • 具体使用

项目中Podfile引入库文件,执行 pod install,下面是使用结果


使用.png

三、pod更新

上面的流程走完,pod更新就相对简单了,本地pod库开发完成后,HHTestKit.podspec文件的版本号记得增加,代码上传到仓库。

  • 版本号更改


    更改版本号.png
  • 更改代码


    更改代码.png
  • 提交代码并打对应的tag(tag和podspec文件中保持一致)


    提交代码.png
  • 提交到cocoapods仓库
    pod trunk push HHTestKit.podspec --allow-warnings

    提交成功.png

  • 项目中更新使用
    执行指定仓库更新:pod update HHTestKit,从下图可以看到版本从0.1.0更新到了0.1.1,这样我们就可以使用新的库里的方法了

    image.png

  • 使用结果


    image.png

至此发布和更新库结束

四、搭建私有仓库

发布到cocoapods的公共仓库代码是开放的,大家都可以下载使用,那么如何搭建一个私有仓库,提供给内部人员使用呢?由于本篇文章篇幅已经过长,我们放到下篇文章讲解iOS 搭建私有pod仓库

五、新版本缓存问题(不更新Tag发布)

有时候我们自己的某个pod库修改了某些代码,但是不想更新tag,就把原来的tag删了加到了最新的代码上。所以说就是tag没更新代码更新了。这时我们在项目上去更新这个pod的时候会发现代码根本没更新。

  • 解决办法:

删除缓存目录 ~/Library/Caches/Cocoapods对应库的源码。
删除工程目录里的Podfile.lock文件。
删除工程Pods目录下对应的源码。

六、Podfile 具体版本引用说明

对于我们自己开发中的版本,为了避免每次使用同样的tag清除缓存的问题,可以【使用远程地址 + 'commit'提交记录】的方式来引用最新版本,当开发版本稳定了,再更新tag,使用tag版本的常规方式引用

// 1、根据不同的target下载不同的第三方代码
target 'ProjectName' do
  pod 'AFNetworking'
  pod 'SDWebImage'
end

target 'NotificationService' do
  pod 'GTExtensionSDK', '2.2.4'
end


// 2、版本控制
pod 'AFNetworking'           # 使用最新版本
pod 'AFNetworking', '3.0.0'  # 只使用3.0.0版本

除了没有版本或特定版本之外,还可以使用逻辑运算符:
pod 'AFNetworking', '> 0.1'  # 任何高于 0.1 的版本
pod 'AFNetworking', '>= 0.1' # 0.1 版及更高版本
pod 'AFNetworking', '< 0.1'  # 任何低于 0.1 的版本
pod 'AFNetworking', '<= 0.1' # 版本 0.1 和任何更低版本

除了逻辑运算符之外,CocoaPods 还有一个乐观运算符~>:
pod 'AFNetworking', '~> 0.1.2 ' # 0.1.2 及 0.2 及以下版本,不包括 0.2 及更高版本
pod 'AFNetworking', '~> 0.1'    # 0.1 及 1.0 以下的版本,不包括 1.0 及更高版本
pod 'AFNetworking', '~> 0'      # 版本 0 和 1.0 之前的版本,不包括 1.0 及更高版本


// 3、使用本地文件夹路径(通常用于本地库,一般建议采用相对路径,避免重新配置)
pod 'AFNetworking', :path => '~/Documents/AFNetworking' # 绝对路径
pod 'AFNetworking', :path => '../AFNetworking'          # 相对路径


// 4、使用远程索引库的地址
# 使用远程地址
pod 'AFNetworking', :git => 'https://github.com/AFNetworking/AFNetworking.git'
# 使用远程地址 + 'dev'分支
pod 'AFNetworking', :git => 'https://github.com/AFNetworking/AFNetworking.git', :branch => 'dev'
# 使用远程地址 + 'tag'标签
pod 'AFNetworking', :git => 'https://github.com/AFNetworking/AFNetworking.git', :tag => '3.1.1'
# 使用远程地址 + 'commit'提交记录
pod 'AFNetworking', :git => 'https://github.com/AFNetworking/AFNetworking.git', :commit => '0f506b1c45'

外链

  • podspec官网
  • Cocoapods使用详解
  • ios私有库上传cocoapods
  • cocoapods的缓存问题
  • Cocoapods流程及pod库的制作

你可能感兴趣的:(iOS 创建pod库并发布到远程仓库)