欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

创建自己的CocoaPods库并提交指南

程序员文章站 2024-03-20 22:40:16
...

来自我的个人博客Minecode.link

前言

CocoaPods是一款很棒的依赖管理工具,在开发中也经常用它来导入开源第三方库。最近也想把自己的一些库开源并加入CocoaPods中,特总结一下自己制作CocoaPods库的过程。

前提

在制作之前,你需要:

  • 掌握CocoaPods的基本使用
  • 掌握Git的简单使用
  • 准备好自己要开源的成品

开始制作

下面我们开始制作自己的开源库,以个人的MCScratchImageView为例。

推送至Git仓库(Github)

首先需要将你的开源框架上传至远程仓库,比如Github,使用方式不再赘述。记录下你要使用的commit版本对应的SHA值。如下图:

创建自己的CocoaPods库并提交指南

为所选版本打tag

在Github自带tag功能

在Github上为项目打tag可在release页面,选择创建新tag并按下图所示填写即可。删除tag也同理。
由于CocoaPods的版本信息仅支持数字的格式(如1.0.0),所以版本号请勿带有其他特殊符号和字母。
创建自己的CocoaPods库并提交指南

使用命令行

使用命令行进行版本管理较为方便,简单步骤为: 创建本地tag -> 将tag推至远程仓库。

参考如下代码:

// 创建本地tag
git tag -a 1.0.0 0c3b62d -m "Release Edition v1.0.0"
// 同步到远程仓库
git push origin 1.0.0

具体Tag的使用方式,可以参考使用Git添加tag的方法

制作Podspec描述文件

生成Podspec

首先在项目主目录输入一下命令
pod spec create <你的项目名>

该命令会在目录中生成一个.podspec格式的文件,包含了该框架的详细信息,我们创建CocoaPods库的所有配置都围绕它来完成。

配置Podspec文件

使用编辑工具(如SublimeText)打开该podspec文件,文档中已经有详细描述,在此简单说明一下各属性作用:

s.name: 框架名称

s.version: 框架最新版本号。这个版本号对应了你Git仓库中某个提交的tag,如果仓库中对应的tag不存在则会提交失败。

s.summary: 框架的概述。
s.description: 框架的详细介绍。
s.homepage: 框架对应页面,随便写
s.license: 框架的开源协议
s.author: 框架作者及邮箱,设置方式见注释

s.platform: 这个要按注释写清支持的系统和版本,同时也要保证实际情况,比如Swift3.0最低支持到iOS 8.0,你就不能写最低支持iOS 7.0

s.source: 对应的git源,在Github->Clone or download->Clone with HTTPS中
创建自己的CocoaPods库并提交指南

s.source_files: 库的源代码文件。这个是重点,应该包含全部你的库所需的文件。
"s.source_files = MCScratchImageView/*.swift"为MCScratchImageView文件夹内的全部swift代码文件。注意默认为.h和.m文件,需要设置为swift的格式。可以设置多个文件参数。

s.framework: 项目所用到的原生框架,如UIKit Framework

s.dependency: 项目需要的其他CocoaPods库,如s.dependency "JSONKit", "~> 1.4"

验证Podspec文件

配置完Podspec文件之后,我们可以预先验证一下文件是否可用。

pod spec lint <文件名称>.podspec

若提示<文件名> passed validation.,则验证通过。

发布到CocoaPods(Trunk方式)

完成了所有的制作之后,我们现在将库发布到CocoaPods。使用了其自带的Trunk工具进行提交。

注册Trunk

首先需要将本机注册到trunk

pod trunk register <E-mail> '<用户名>' --description='<设备别名>'

提交注册后,所填写的邮箱将会收到一个验证邮件,确认验证即可。

同时也可以为项目添加其他维护者:

pod trunk add-owner <库名> <其他维护者邮箱>

可以使用pod trunk me来查看当前账户信息。

使用Trunk提交

通过配置好的Podspec,我们可以将库提交到CocoaPods上。使用以下命令:

pod trunk push <文件名>.podspec

提交过程会检查你的代码能否正确编译、以及Podspec是否正确配置。若成功将会显示祝贺信息。

查看提交库信息

我们可以在提交成功后查看是库是否已经在CocoaPods上,命令如下:

pod search <库名>
// 如果查找不到,可以尝试
pod search <库名> --simple

如果找不到,可以尝试

pod setup
rm ~/Library/Caches/CocoaPods/search_index.json

如果能查看到库信息,则说明上传成功。我们可以看到库的介绍以及所有版本等信息。

删除库的指定版本

当上传的库版本号已存在时会发生冲突,不能覆盖。所以我们只能先删除指定版本再重新提交。

pod trunk delete <库名> <版本号>

示例

至此,我们已经成功把自己的库提交至CocoaPods,用户可以通过Podfile来使用。
下面附一份本人CocoaPods库的Podspec文件以供参考, MCScratchImageView

Pod::Spec.new do |s|
s.name         = "MCScratchImageView"
s.version      = "1.0.0"
s.summary      = "Custom ImageView like scratch card"
s.description  = <<-DESC
A custom ImageView that is used to cover the surface of other view like a scratch card, user can swipe the mulch to see the view below.
DESC
s.homepage     = "https://github.com/Minecodecraft/MCScratchImageView"
s.license      = "MIT"
s.author       = { "Minecode" => "aaa@qq.com" }
s.platform     = :ios, "8.0"
s.source       = { :git => "https://github.com/Minecodecraft/MCScratchImageView.git", :tag => "#{s.version}" }
s.source_files  = "MCScratchImageView/MCScratchImageView.swift"
s.framework  = "UIKit"
end

如有问题,可以发送邮件至 [email protected]
欢迎共同探讨iOS开发问题