飞花蝶舞剑

飞花蝶舞剑 查看完整档案

上海编辑福建师范大学  |  计算机科学与技术 编辑平安好医生  |  开发工程师 编辑 segmentfault.com/u/invincible_zcp/about 编辑
编辑

Zcp大官人的iOS小站

个人动态

飞花蝶舞剑 发布了文章 · 2019-05-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-05-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-17

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-17

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-04-16

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-03-15

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

飞花蝶舞剑 发布了文章 · 2019-03-13

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

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


前言

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

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


目录

  • 如何创建podspec文件
  • 如何编写podspec文件
  • 如何实现目录分层
  • 如何校验podspec文件
  • 别人写的例子
  • 补充 校验时出现的一些问题

1.如何创建podspec文件

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

pod spec create XXXKit

例如我自己的ZCPKit

clipboard.png

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

clipboard.png

2.如何编写podspec文件

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

clipboard.png

一些常用的信息介绍:

name:框架名
version:当前版本(注意,是当前版本,假如你后续更新了新版本,需要修改此处)
summary:简要描述,在pod search ZCPKit的时候会显示该信息。
description:详细描述
homepage:页面链接
license:开源协议
author:作者
source:源码git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:头文件(.h文件)
resources:资源文件(配置的文件都会被放到mainBundle中)
resource_bundles:资源文件(配置的文件会放到你自己指定的bundle中)
frameworks:依赖的系统框架
vendored_frameworks:依赖的非系统框架
libraries:依赖的系统库
vendored_libraries:依赖的非系统的静态库
dependency:依赖的三方库

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

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

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

目录结构如下

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

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

source_files:配置三方库的源文件(.h或.m文件)

写法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路径下的所有匹配文件

public_header_files:配置公有的头文件(.h文件)

写法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夹下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路径下的所有匹配文件

vendored_frameworks:配置需要引用的非系统框架(**/*的写法后面不再赘述

写法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依赖的系统框架

写法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系统静态库(要注意,这里的.a静态库名字必须要带lib前缀,如果引用的静态库名字没lib前缀会导致编译报错,只需要重命名加上即可

写法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依赖的系统库(要注意,这里的写法需要忽略lib前缀

写法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置资源文件(.bundle,.png,.txt等资源文件,这些资源文件会被放到mainBundle中,要注意避免发生命名重复的问题

写法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的资源文件(可以解决resources导致的命名冲突问题

写法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依赖的三方库,pod库或者可以是自身的subspec

写法:
dependency 'AFNetworking', '~>3.1.0' // pod三方库
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

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

3.如何实现目录分层

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

  • 目录分层,结构清晰;
  • 使用pod引入一个三方库时,可以只引入一个subspec而不用将整个三方库引入。

例如AFNetworking:
clipboard.png

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

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

写法如下:
clipboard.png

效果:
clipboard.png

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

有几个需要注意的地方:

1.层级不能出现循环依赖。

  • 比如类ZCPUtil.h中 #import "ZCPRouter.h",同时ZCPRouter.h中 #import "ZCPUtil.h"。这样当写podspec时就需要在Util层级中写dependency 'ZCPKit/Router',在Router层级中写dependency 'ZCPKit/Util'。如此便存在Router与Util层级之间的循环依赖。出现循环依赖时,三方库是无法成功提交到repo上的,会报依赖错误。解决办法是,层级间要尽量解耦。

2.分层的层级不要太多,层级不要太深。

  • 为了避免出现上述的循环依赖错误。

3.source_files使用的是真实的物理路径,而dependency依赖其他层级时使用的是层级路径,不是真实的物理路径

  • 例如:ZCPUtil.h文件的真实路径是:ZCPKit/Framework/Util,而Util层级是属于ZCPKit层级下的一个子subspec,所以当写Router层级依赖Util层级时要写:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

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验证即可(这个过程会较为费时,需要稍微等待)。

clipboard.png

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

clipboard.png

clipboard.png

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

1.当代码中存在警告时要记得使用--allow-warnings参数。

2.如果引入的文件或分好的层级需要依赖系统库或三方库,要记得使用上面介绍的libararies,frameworks等属性。

3.如果你的三方库是在一个xcode项目中编写调试,那么尽量不要用pch。

  • 因为很多类之间的小依赖会被pch给遮掩过去,这会导致在校验时出现大量错误。

4.如果想要分层,那么尽量解耦使模块能够单独存在。

  • 原因是当分层较多层级较深时,很可能产生循环依赖的问题。

5.其他

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

1>用pod搜索AFNetworking
clipboard.png

2>进入AFNetworking的源码地址
clipboard.png

3>下载并查看

clipboard.png

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' 

clipboard.png

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

clipboard.png

解决办法:在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


查看原文

赞 7 收藏 8 评论 20

认证与成就

  • 获得 27 次点赞
  • 获得 3 枚徽章 获得 0 枚金徽章, 获得 0 枚银徽章, 获得 3 枚铜徽章

擅长技能
编辑

开源项目 & 著作
编辑

  • 个人Demo

    针对一些技术点做的相关Demo,Just for study.

注册于 2015-09-02
个人主页被 827 人浏览