iOS学习(四十四)组件化:构建私有远程pod仓库及处理pattern did not match any file

CocoaPods

根据pod的使用原理,当使用pod install 安装库时,会在索引仓库中搜对应的库,搜到后,根据索引仓中的spec文件中的信息,去对应的git仓库中拉取相应的代码。基于此,我们添加一个私有索引仓即可。官方文档:构建私有pod

本文记录创建私有仓的方法,以及提交一个测试项目到私有仓,再通过pod的方式加载测试项目的步骤。

一、构建远程私有库

我们需要准备两个空的远程仓库,一个作为私有索引库作为全部spec的存放仓库即索引库,另一个为模拟要发布的私有组件仓库。

第一步:创建私有组件库项目

这一步是通过pod 自带的cli命令创建项目,该项目中会将需要发布的代码以本地pod的方式引入,并同时创建测试项目以及对应的配置文件,为之后的发布做好准备。

将空仓库私有组件库clone到本地,cd进入目录后输入pod lib create XXXX创建新项目,XXXX 是项目名称,一般都会以组件名称命名。我们这里使用BaseMoudle作为组件名称,输入pod lib create BaseMoudle,然后填写相关信息后会自动生成项目(这里单词写错了,应该是Module,忽略这个小问题):

What platform do you want to use?? [ iOS / macOS ]
 > iOS

What language do you want to use?? [ Swift / ObjC ]
 > ObjC

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 ]
 > no

What is your class prefix?
 > Test

完成后项目会自动打开,项目结构如下:


项目结构

目录结构如下:


文件目录

最左边的BaseMoudle是git仓库clone的目录,中间的BaseMoudle是pod创建的项目所在的文件夹,右边的BaseMoudle才是真正放库代码的地方。

此时,发现git不能提交,并没有识别到这个新创建的项目,这是因为该文件夹下也有.git文件,这是pod的项目下载下来的,删掉即可(如果没有可以按键command + shift + . 显示隐藏文件)。
同时,为了方便期间,我们把中间这个多余的BaseMoudle层级也删除掉。
最终,目录结构如下:


文件目录

第二步:修改.podspec文件

.podspec 文件是存放在索引库中的,pod会根据该文件中的配置去下载对应的文件。该文件最终会上传到索引库中。

打开工程后,找到BaseMoudle..podspec文件,该文件是默认生成的,必须修改的字段如下:

  s.summary          = '基础库'
  s.description      = <<-DESC
              这里填写比summary更多的内容做为描述
                    DESC
  s.homepage         = '填写库的地址,比如https://gitee.com/xxxxx/xxxxx'
  s.source           = { :git => '填写库的代码地址,比如https://xxx.git', :tag => s.version.to_s }

这里,我们添加一些测试代码,需要将组件的代码放到这个文件夹下(ReplaceMe文件可以删除)。


代码位置

正确的代码添加的方式是将代码放在和BaseMoudle.podspec同层级的BaseMoudle ->Classes文件夹下,然后在Example文件夹下执行pod install加载代码到项目中(即这是一个本地pod引入代码方式)。

提交代码后,需要给该次提交打一个标签,标签必须和.podspec文件中version字段一致。默认这里是0.1.0

BaseMoudle.podspec同级目录中,可以使用指令pod spec lint 对文件进行验证(会检测填写的远程地址的是否可用,以及一些其他的合法性检测。)

注意:
  1. s.description 必须比 s.summary 更长,这里的格式也不能修改,写在DESC两个关键字中间一行
  2. s.source中,:git =>字段,这里如果写git@xxx.git这种地址,则需要使用pod ''xxx" 的用户是配置了SSH认证方式,否则会有权限错误。所以通常这里写https://xxx.git这样的方式确保可以正常拉取代码。
  3. s.source中,:tag =>字段,理论上tag是一个字符串(git中关于tag官方文档描述),但仍需遵循一些规则。
    tag中关于名称的描述

    具体规则详见文档。通常,我们以一个类似0.1.0这样的方式设置tag。这是因为,在pod管理中,可以使用一些方式限定加载的版本,比如~>之类的,只有这样的版本号才能正确解析。否则就需要指定版本号。

第三步:添加私有索引库搜索地址

在执行pod install 的时候,会在当前的pod索引库中查找库(使用pod repo指令可以查看当前所有的索引库),为了能查询私有索引仓,我们需要添加私有仓地址到搜索库中。

使用pod repo add XxxName XxxPath( 其中XxxName是自定的repo名称,比如PrivateRepoXxxPath为该索引库的地址,比如 https://xxx.git)指令添加一个私有的全局pod 索引库。

添加完成后,可以使用pod repo查看列表是否添加成功。

// 输入pod repo 后查看索引库信息
cocoapods
- Type: git (remotes/origin/master)
- URL:  https://github.com/CocoaPods/Specs.git
- Path: /Users/x/.cocoapods/repos/cocoapods

Private
- Type: git (master)
- URL:  https://xxx.git
- Path: /Users/x/.cocoapods/repos/Private

trunk
- Type: CDN
- URL:  https://cdn.cocoapods.org/
- Path: /Users/x/.cocoapods/repos/trunk

第四步:将私有库的podspec文件推送到私有索引仓库中

BaseMoudle.podspec文件的所在的目录下执行pod repo push PrivateRepo BaseMoudle.podspec,表示给PrivateRepo索引库中推送podspec(这里是pod的推送命令,并不是git的推送命令,该指令会检查.podspec文件的合法性):

Validating spec
 -> BaseMoudle (0.1.0)
    - WARN  | source: Git SSH URLs will NOT work for people behind firewalls configured to only allow HTTP, therefore HTTPS is preferred.
    - WARN  | url: The URL (https://xxx.git) is not reachable.
    - NOTE  | xcodebuild:  note: Using new build system
    - NOTE  | xcodebuild:  note: Using codesigning identity override: -
    - NOTE  | xcodebuild:  note: Build preparation complete
    - NOTE  | [iOS] xcodebuild:  note: Planning
    - NOTE  | [iOS] xcodebuild:  note: Building targets in dependency order
    - NOTE  | [iOS] xcodebuild:  warning: Skipping code signing because the target does not have an Info.plist file and one is not being generated automatically. (in target 'App' from project 'App')

Updating the `PrivateRepo' repo


Adding the spec to the `PrivateRepo' repo

 - [Add] BaseMoudle (0.1.0)

Pushing the `PrivateRepo' repo

可以看到,这里会自动执行Pushing thePrivateRepo' repo`指令,即对远程索引仓库自动进行git的push操作,将其更新到远程仓库。

注意,这里可以直接不写BaseMoudle.podspec参数,即pod repo push PrivateRepo,会自动查找当前目录下的.podspec文件。

第五步:安装远程库

默认pod 搜索的只是默认的索引库,我们需要在Podfile文件中添加更多的索引库地址。
创建一个新项目,初始化pod后,在Podfile文件最上方填写source信息(可通过pod repo指令查看),表示需要搜索的索引库地址,然后引入库文件pod 'BaseMoudle'

# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'

source 'https://github.com/CocoaPods/Specs.git'
source 'https://xxx.git'

target 'test' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!
  
  # Pods for test

  pod 'BaseMoudle'
end

执行pod install 即可

第六步:升级远程库(可选)

当需要对库进行升级时,需要修改.podspec文件,同时,对代码重新打tag,和第二步一致。然后执行第四步,重新推送到本地repo。

在项目中,需要执行pod update --no-repo-update,更新文件。这里使用pod install 是不行的,因为在Podfile.lock文件中已经“锁定”了版本号,只有update指令才可以去更新这里的库,而--no-repo-update表示更新repo中的文件(本地索引库),私有的索引库已经更新了(第六步中重新推送到本地repo),使用该命令可以避免更新官方的索引库(如果没有显式的指定其他库的版本号,不加--no-repo-update会导致其他的库更新到最新版本从而引起一些问题)。

二、常见问题处理:

1.[iOS] file patterns: The `source_files` pattern did not match any file. 或者 [iOS] file patterns: The `resource_bundles` pattern for `xxx` did not match any file.

出现这中错误有几种可能:

  1. 字段设置错误
    字段修改为第二步中的,特别是s.description,要在<<-DESCDESC写注释,不能删掉

  2. 文件夹路径错误
    在第一步中删掉多余的BaseMoudle层级才能正确匹配s.source_files = 'BaseMoudle/Classes/**/*'字段,如果没有删除,则这里应该为s.source_files = 'BaseMoudle/BaseMoudle/Classes/**/*'

  3. 版本号没有修改
    更新版本后没有修改版本号s.version字段,即重复提交了相同的版本号。修改版本号后重新提交即可。

2.Could not find remote branch 0.1.0 to clone.

这个错误是由于没有打标签,会检测到找不到该标签。如果没有打标签这个错误不一定会有,gitee上不打也可验证通过,gitlab就会有这样的错误,可能和仓库有关系。但是在具体安装的时候(pod install),如果没有标签也会报错找不到该标签。

3.Specs satisfying the xxxx dependency were found, but they required a higher minimum deployment target.

这个是安装的库的版本比podfile中的版本高,在.podspec文件中s.ios.deployment_target字段配置版本信息。

4.Could not read from remote repository

报错信息如下:

[!] Error installing xxxxxxx
[!] /usr/bin/git clone git@gitlab.xxxxx.xxxxx/xxxxx/xxxxxx.git /var/folders/f8/jkfbygnx2hvfx6s4k78vw51h0000gn/T/d20220406-63219-53c6s0 --template= --single-branch --depth 1 --branch 0.1.0

Cloning into '/var/folders/f8/jkfbygnx2hvfx6s4k78vw51h0000gn/T/d20220406-63219-53c6s0'...
ssh: Could not resolve hostname gitlab.autel.com: nodename nor servname provided, or not known
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

该问题并非git配置问题,是文件夹写入权限问题。执行一次sudo pod install输入电脑密码,再执行一次pod install即可正常安装。

5.库中有文件夹,引入后文件夹丢失

当只有一个文件夹或者文件夹中是空的时候,pod在引入的时候会对其进行过滤。这是一个正常现象

6. 只有WARNNOTE仍然不能提交成功,提示[!] The `xxxxx.podspec` specification does not validate.

在后面添加--allow-warnings参数即可。参考文章

7. 提交成功后别人使用pod install仍然安装的是旧版本

这个问题是pod的索引缓存问题,通过pod repo update XXX更新本地索引库即可。在本机上通过第四步已经推送到本地索引库上则无需此操作。
注意:这里自己虽然本地上的索引库已经更新,但是安装仍然是旧版,这是因为Podfile.lock这个文件中会锁定版本信息。我们可以先注释引入的pod库,然后执行pod install将其移除,再重新引入pod库,执行pod install即可安装到最新版本了。

8. 报错- ERROR | [iOS] unknown: Encountered an unknown error (incompatible character encodings: UTF-8 and ASCII-8BIT) during validation.

检查s.source中配置的路径是否正确,这种错误往往是验证的url中存在异常字符

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容