iOS通过Cocoapods创建私有库

一、简介

iOS通过cocoapods创建私有库不是什么新技术了，一段时间之后经常容易忘记，这里记录下全过程便于查阅，也给有需要的同学引个路。
创建私有库整体分为2块：1.创建库源代码。2.创建并配置库索引。下面针对这2块详细说下步骤。

二、创建步骤

前置条件：mac已配置好cocoapods环境。

2.1.创建pod私有库模板

//该命令会创建一套私有库的模板
MacBook-Pro:desktop wp$ pod lib create ****Framework

接下来会有一套针对你创建的私有库的询问流程：

# 选择编程语言
What language do you want to use?? [ Swift / ObjC ]
> Swift  
# 在你的项目中是否创建一个demo工程，为了方便测试，我选择了Yes
Would you like to include a demo application with your library? [ Yes / No ]
 > Yes  
# 测试框架选择哪一个
Which testing frameworks will you use? [ Specta / Kiwi / None ]
 > None
#要不要做视图测试
Would you like to do view based testing? [ Yes / No ]
 > Yes
# 类前缀名
What is your class prefix?
 > DY

这里结束之后，当前目录下会创建一个模板项目：

image.png

2.2.git上创建spec索引库（原先没有spec索引库）和私有库工程

这里以码云上创建项目为例进行说明。

2.2.1.git上创建spec索引库

spec索引库用于做pod私有库的索引，创建方式和普通创建项目一样，这里为了便于命名规范，索引项目名称最好以**Specs结尾

image.png

最后得到该索引库的地址：https://gitee.com/wp_iOSlib/****pecs.git

附：如果你的git库中原先已有同事创建过spec库，你如果想把索引放在这个索引库上也可以用已有的库，方法如下：

//该命令是给本地的索引库（repo）增加一个新的索引目录，后面的地址为索引库地址
//执行该命令后会把刚才的索引库克隆到/Users/peng.wu/.cocoapods/repos目录下
//格式： pod repo add [索引名] 索引库地址
pod repo add ****Spec https://gitee.com/wp_iOSlib/****pecs.git

2.2.2.创建私有库工程

创建私有库工程方法同上，之后你同样得到该私有库源码的git地址：https://gitee.com/wp_iOSlib/****Framework.git

2.3.编辑私有库索引

打开2.1步骤中我们创建的库工程中的***.spec文件

image.png

以下是关于****.spec文件内相关内容的注释

version             功能版本，建议和tag保持一致，版本从0.0.1开始。
summary             功能概要，需要填写更新，否则lint检测无法通过。
description         功能描述，可以选择性删除，否则lint检测无法通过。
homepage            资源首页，私有库对应的浏览器地址。
resource            资源地址，git克隆地址。建议使用http/https，git类型有权限控制。
source_file         类资源文件，默认Classes下的所有文件，放置私有库核心文件。
resources           Bundle资源文件（不推荐使用），会合并至MainBundle中，访问便利，但会存在命名冲突问题。个别SDK必须放在MainBundle中才能使用，比如微博SDK！！！。
resource_files      Bundle资源文件（推荐使用），单独的Bundle文件，不与MainBundle合并，使用内部资源时和MainBundle路径有区别！！！。
exclude_files       指定不被包含的文件、目录
vendored_libraries  内部包含的.a静态库 例如'ModuleName/Classes/Lib/*.{a}'
vendored_framework  内部包含的.framework静态库 例如'ModuleName/Classes/Framework/***.framework'
static_framework    指定pod加静态库标签 true/false

指定支持的架构，如果因为i386等架构问题lint检测不通过，可以在检测时添加 --skip-import-validation参数
s.xcconfig = {
  'VALID_ARCHS' => 'armv7 arm64e armv7s arm64 x86_64',
}

如果支持单文件目录下的文件引用，可以设置subspec
s.default_subspec = 'Core'
s.subspec 'Core' do |core|
    core.dependency 'MBProgressHUD'
    core.source_files  = "DYFoundationFramework/Classes/**/*.{h,m}"
end

s.subspec 'OldCommonTools' do |oct|
    oct.dependency 'SAMKeychain'
    oct.source_files  = "DY****Framework/Classes/Object-C/DY****Tools/**/*.{h,m}"
end

具体编辑如下：

image.png

这里有个坑：如果我们的私有库中有本来就不包含任何文件，我们一定不要随意写添加相关资源文件的代码，比如source_files，resource_bundles，否则会验证不通过！！

// Classes下不包含任何内容时，以下代码要注释或者直接删除
# s.source_files = 'DYFinancialRobotFramework/Classes/**/*'
// 不包含任何bundle资源时，以下代码要注释或者直接删除
# s.resource_bundles = {
  #   'DYFinancialRobotFramework' => ['DYFinancialRobotFramework/Assets/*.png']
  # }

2.4.编辑私有库内容

打开我们私有库中的example目录，并执行pod install

//定位到我们创建的2.1步骤中创建的项目
MacBook-Pro:Desktop wp$ cd /Users/wp/Desktop/DYNetworkFramework/Example
//安装pod
MacBook-Pro:Desktop wp$ pod install

打开example中的DYNetworkFramework.xcworkspace，在Development Pods文件夹下，找到你pod本地引用的库，在下面创建该库需要的代码文件。
到这里你的库的核心代码就写完了。

image.png

2.5.push我们的本地的私有库源码到git

该过程就是把我们本地的代码push到刚才创建的私有库git地址。

//定位到我们创建的2.1步骤中创建的项目
MacBook-Pro:Desktop wp$ cd /Users/wp/Desktop/DYNetworkFramework
# 添加远程地址,即上面创建码云项目的地址
MacBook-Pro:DYNetworkFramework better$ git remote add origin https://gitee.com/wp_iOSlib/****Framework.git
# 添加文件
MacBook-Pro:DYNetworkFramework better$ git add .
# 提交本地，并写描述
MacBook-Pro:DYNetworkFramework better$ git commit -a -m "第一次提交 版本为0.1.0"
# --allow-unrelated-histories
# git pull origin maste会失败 ,提示：fatal: refusing to merge unrelated histories
# 原因是远程仓库origin上的分支master和本地分支master被Git认为是不同的仓库，所以不能直接合并，需要添加 --allow-unrelated-histories

MacBook-Pro:DYNetworkFramework better$ git pull origin master --allow-unrelated-histories
# 推送到码云的Pro:DYNetworkFramework项目的master分支上
MacBook-Pro:DYNetworkFramework better$ git push origin master
# 提交版本号,注意这个版本号需要和前面spec文件中对应的版本号保持一致
MacBook-Pro:DYNetworkFramework better$ git tag 0.1.0
# push到远程分支
MacBook-Pro:DYNetworkFramework better$ git push origin 0.1.0

注意：1.podspec文件中的地址要和远程仓库保持一致
2.podspec文件中的s.version的版本号也和我们打的tag版本一致（每次组件更改后需要打新的tag，并推送到远程仓库）
截止这里，我们私有库就已经push到git上去了。

2.6.发布私有库索引

这里我们推荐先对podspec文件进行本地验证，再发布到私有库索引中（也可以直接发布，pod会自动先进行验证）

//定位到私有库目录
cd /Users/wp/Desktop/DYNetworkFramework
//验证私有库
pod lib lint
//或者pod lib lint DYNetworkFramework.podspec

如果验证通过，我们可以在repo 中进行发布

//pod repo push [Repo名] [podspec 文件名字]  
pod repo push libspecs DYNetworkFramework.podspec

pod repo push libspecs  --sources='https://github.com/CocoaPods/Specs.git,https://gitee.com/wp_iOSlib/****pecs.git' --allow-warnings --skip-import-validation

至此，我们的这个组件库就已经制作添加完成了，使用pod search命令就可以查到我们自己的库了.
在Terminal中执行 pod search DYNetworkFramework,此时可能一直报错。
解决办法是：rm ~/Library/Caches/CocoaPods/search_index.json 重新搜索

//先删除索引缓存
rm ~/Library/Caches/CocoaPods/search_index.json
//重新search
pod search DYNetworkFramework

三、常见错误

3.1.更新本地pod库失败
[!] Unable to add a source with url https://github.com/CocoaPods/Specs.git named master.
解决办法是:Go to ~/.cocoapods/repos and run git clone https://github.com/CocoaPods/Specs.git master

3.2.私有库pod repo push DYNetworkFramework DYNetworkFramework.podspec --verbose --use-libraries --allow-warnings后一直报 is not clean

[!] The repo `DYNetworkFramework` at `../../.cocoapods/repos/DYNetworkFramework` is not clean
/Library/Ruby/Gems/2.3.0/gems/cocoapods-1.3.1/lib/cocoapods/command/repo/push.rb:159:in `check_repo_status'
/Library/Ruby/Gems/2.3.0/gems/cocoapods-1.3.1/lib/cocoapods/command/repo/push.rb:74:in `run'
/Library/Ruby/Gems/2.3.0/gems/claide-1.0.2/lib/claide/command.rb:334:in `run'
/Library/Ruby/Gems/2.3.0/gems/cocoapods-1.3.1/lib/cocoapods/command.rb:52:in `run'
/Library/Ruby/Gems/2.3.0/gems/cocoapods-1.3.1/bin/pod:55:in `'
/usr/local/bin/pod:22:in `load'
/usr/local/bin/pod:22:in `
'

解决办法是:到本地的私有库中执行git status,确保nothing to commit, working directory clean,若有未提交的文件，则进行提交。再次执行pod repo push DYNetworkFramework DYNetworkFramework.podspec --verbose --use-libraries --allow-warnings能成功。