Cocoapods整理(三)——编写podspec文件


前言

    看到pod上各种形形色色的三方库,自己肯定也会想要创建一个分享一下。做组件化时也会想要将项目拆分成一个一个的私有库。而使用pod管理三方库或私有库最重要的就是要学会如何写podsepc文件。

以下均以我自己写的一个私有库ZCPKit去介绍。


目录


1.如何创建podspec文件

创建podspec文件只需要一行命令,在你自己的三方库的根目录下输入下面的命令:

pod spec create XXXKit

例如我自己的ZCPKit

然后在项目目录下将会生成一个podspec文件

2.如何编写podspec文件

我们先来打开ZCPKit.podspec文件看看里面的内容。基本都是针对ZCPKit的描述和介绍。

一些常用的信息介绍:

上面列举的信息大部分来自pod默认生成的podspec文件中的给的,其中需要重点注意标识黑体的这几个信息。

你在三方库中看到的那些文件都是通过这些配置来确定的。当pod install引入三方库时,只会引入你在podspec中配置的那些文件。

下面我会举例说明该如何写podsepc中的每项配置。

目录结构如下

ZCPKit
┗━━━━Classes
     ┗━━━━ZCPKit.h
     ┗━━━━ZCPKit.m
┗━━━━Frameworks
     ┗━━━━MyFramework.framework
┗━━━━Libraries
     ┗━━━━libZCPKit.a
┗━━━━Resources
     ┗━━━━MyRes.bundle

如图所示的目录结构,每个配置项的写法如下:

附上官网链接,可以去看一看:podspec
关于更详细的podspec文件写法,可以看这篇文章:Podspec语法参考 v1.2.0.beta.1
关于资源文件更详细的写法,可以看这篇文章:给 Pod 添加资源文件

3.如何实现目录分层

使用subspec来实现目录分层。
目录分层的好处:

例如AFNetworking:

下面举例说明,如图所示的目录结构:

ZCPKit
┗━━━━Classes
     ┗━━━━ZCPKit.h
     ┗━━━━ZCPRouter
          ┗━━━━ZCPRouter.h
          ┗━━━━ZCPRouter.m
     ┗━━━━ZCPUtil
          ┗━━━━ZCPUtil.h
          ┗━━━━ZCPUtil.m

写法如下:

效果:

如果想有多层的目录结构还可以继续嵌套下去。

有几个需要注意的地方:

4.如何校验podspec文件

在podspec写好之后我们需要验证一下编写的内容是否有误。可以在命令行的三方库当前路径下使用下面的命令:

pod lib lint (从本地验证你的pod能否通过验证)
pod spec lint (从本地和远程验证你的pod能否通过验证)

pod lib lint --verbose (加--verbose可以显示详细的检测过程,出错时会显示详细的错误信息)
pod lib lint --allow-warnings (允许警告,用来解决由于代码中存在警告导致不能通过校验的问题)
pod lib lint --help (查看所有可选参数,可选参数可以加多个)

我们目前只是在本地写的三方库,所以只需要使用pod lib lint验证即可(这个过程会较为费时,需要稍微等待)。

我自己加了个循环依赖的错误然后再重新检测一下试试,可以看到检测到了错误(发现有错误的时候,建议用加--verbose的命令看详细错误信息):

需要注意的:
在检测的时候会很经常会出现各种乱七八糟的错误,在文件多的情况下不太容易一次通过,并且即使你的代码在Xcode中编译通过了,但是也还是会出现很多错误。所以你需要尽量去注意下面的几个问题:

5.其他

如果想要了解一些实实在在的例子,你可以把别人的三方库下载下来,podspec文件一般会跟其放在一起,这样就能参考别人的podspec文件是怎么写的。比如AFNetworking:

1>用pod搜索AFNetworking

2>进入AFNetworking的源码地址

3>下载并查看

6.补充 校验时出现的一些问题

1.不支持i386编译的库无法通过pod lib lint的问题()
解决pod lib lint/repo push不支持i386编译&只能真机运行的库

https://github.com/CocoaPods/...

2.在A私有库中引入了B私有库,导致pod lib lint不通过的问题

在调用命令时需要添加B私有库所在的repo源地址。

pod lib lint <文件名>.podspec --sources='<私有库所在repo的source>,https://github.com/CocoaPods/Specs.git'

3.报错 ··· error: include of non-modular header inside framework module ··· [-Werror,-Wnon-modular-include-in-framework-module]

解决办法:在pod lib lint 或者 pod spec lint 以及 pod repo push ....时候加上 --use-libraries

参考:COCOAPODS创建私有PODS


后续

Cocoapods整理(一)——安装Cocoapods
Cocoapods整理(二)——使用Cocoapods
Cocoapods整理(四)——搭建Cocoapods私有库环境

本篇文章的私有库demo:ZCPKit

个人的repo:zcprepo
私有库:ZCPKit


参考文章

给 Pod 添加资源文件
解决pod lib lint/repo push不支持i386编译&只能真机运行的库
Podspec语法参考 v1.2.0.beta.1


03-05 21:20