uts-ios-cocoapods.md

本文旨在帮助 uts 插件开发者和使用者，快速了解 uts 插件中配置使用 CocoaPods 依赖的问题。
包括在Mac系统真机运行时如何配置 CocoaPods 环境，以及 CocoaPods 使用过程中常见错误处理

> 此功能 HBuilder X 3.8.5+ 版本支持

## 在 uts 插件中使用 CocoaPods 依赖@useCocoaPods

在 uts 插件中使用 CocoaPods 依赖库，需要在 config.json 中 dependencies-pods 节点做相应配置，下面是配置示例：

```json
{
	"deploymentTarget": "9.0",   // 可选，插件支持的最低 iOS 版本  默认：9.0"
	"dependencies-pods": [ // 可选, 需要依赖的 CocoaPods 库, HBuilderX 3.8.5+ 版本支持
	{
		"name": "WechatOpenSDK",  
		"version": "2.0.2"     
	}, {
		"name": "Alamofire",
		"version": "5.7.3", //配置 repo 时可不指定 version
		"repo": {  // 可选，配置 pod 库为指定仓库，配置repo时，应至少指定 git。 （HBuilder X 3.8.10+ 版本新增支持）
			"git": "https://github.com/test/Alamofire.git", //指定 pod 库的仓库地址
			"tag": "5.7.3", // 指定该 pod 库仓库的 tag
			"branch": "dev", // 指定该 pod 库仓库的分支
			"commit": "b309714f3aa5091f1ce8d932094b7594ed7acad9" // 指定该 pod 库仓库的某次commit
		}
	}]
}
```

**配置说明：**
- deploymentTarget：插件支持的最低 iOS 版本号，此节点为可选项，默认设置为 9.0.
	+ 插件支持的最低版本号应该设置为所有依赖的三方库（包含 framework .a pod ）中最低支持版本号中的最高的一个。
	+ pod 库的最低支持系统版本号可在 pod 库的 spec 文件或者 readme 中查看。
- dependencies-pods：插件需要依赖的 pod 库,  HBuilderX3.8.5+ 版本新增支持
	+ 把需要依赖的 pod 库相关信息配置在 dependencies-pods 节点下，需要明确指定每个 pod 库的名字 (name)。 按需指定版本号 version 或者 repo （至少应配置 version 或 repo 中的一个，repo 优先级高于 version， 配置 repo 时 version 不再生效），可同时配置多个 pod 依赖库。目前不支持通过 podfile 文件直接设置，也不支持 podfile 文件中除了 name 、 version 、pod 特定仓库之外的其他配置项。
	+ 为了保证插件的稳定性，避免因未指定 pod 库版本，执行 pod install 之后 pod 库最新版本造成的代码不兼容问题，在未配置 repo 时需要明确指定 pod 库的具体版本。此时 version 字段不可省略，不可为空字符串。 建议将 version 配置为 `"9.7.0"` 这种明确的数字版本号，不建议使用 `~>, >, >=, <, <=` 等带符号的配置。
	+ repo: 自定义 pod 库仓库地址信息, HBuilderX3.8.10+ 版本新增支持
		+ 如果你需要自己指定 pod 库的仓库地址: git, tag, branch, commit 等信息，可以通过repo字段配置。请注意： repo 是一个对象，其中至少应包含 git 字段（用来指定 pod 库的仓库地址）。当你同时指定 tag、 branch、 commit 时，CocoaPods 会默认使用 commit，通常可以根据需要指定 tag / branch / commit 中的一个。当正确配置 repo 时 version 不再生效，此时可以省略 version 的配置。
	+ 使用 CocoaPods 官方默认地址 (source 'https://cdn.cocoapods.org/'), 暂不接受 source 配置。


## CocoaPods 环境配置@config

在Mac系统上使用标准基座真机运行时才需要配置 CocoaPods 环境， 使用自定义调试基座提交云端打包则可以不配置 CocoaPods 环境。
在Windows系统上不支持 CocoaPods 环境，只能提交云端打包使用自定义调试基座。

### CocoaPods安装

正常安装 CocoaPods 需要在终端执行下述命令

```
gem install cocoapods
```

#### CocoaPods 安装成功

这会耗费一段时间，完成后可查看 cocoapods 的版本号

```
pod --version
```
如： 1.12.1

也可以查看 pod 的安装位置

```
which pod
```
如：/Users/dcloud/.rvm/rubies/ruby-3.0.0/bin/pod

至此 CocoaPods 已经安装完成，可以尝试 Search 下一 pod 库：

```
pod search Alamofire
```

如果执行 pod search 失败，说明当前网络不能正常访问 github 或者 cdn, 更多信息详见[无法访问 github ](https://uniapp.dcloud.net.cn/plugin/uts-ios-cocoapods.html#timeout), [CDN错误](https://uniapp.dcloud.net.cn/plugin/uts-ios-cocoapods.html#cnderror)。

#### CocoaPods 安装失败

- 如果执行 gem install cocoapods 之后报下面的错误：

```
ERROR:  Error installing cocoapods:
        The last version of activesupport (>= 5.0, < 8) to support your Ruby & RubyGems was 6.1.7.3. Try installing it with `gem install activesupport -v 6.1.7.3` and then running the current command again
        activesupport requires Ruby version >= 2.7.0. The current ruby version is 2.6.10.210.
```
说明缺少activesupport插件，在终端执行以下命令

```
sudo gem install activesupport -v 6.1.7.3
```
插件安装成功后再次执行 sudo gem install cocoapods 安装 CocoaPods.


- 如果报错如下，说明需要升级 gem 和 ruby

```
Building native extensions. This could take a while...
ERROR: Error installing cocoapods:
ERROR: Failed to build gem native extension.
current directory: /Library/Ruby/Gems/2.6.0/gems/ffi-1.15.5/ext/ffi c
/System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/bin/ruby-I/System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/lib/ruby/2.6.0-r./siteconf20230612-9566-nht0td.rbextconf.rb
mkmf.rb can't find header files for ruby at /System/Library/Frameworks/Ruby.framework/Versions/2.6/us/lib/ruby/include/ruby.h
You might have to install separate package for the ruby development environment, ruby-dev or ruby-devel for example.
extconf failed, exit code 1
Gem files will remain installed in /Library/Ruby/Gems/2.6.0/gems/ffi-1.15.5 for inspection.
Results logged to /Library/Ruby/Gems/2.6.0/extensions/universal-darwin-22/2.6.0/ffi-1.15.5/gem make.out
```

下面是升级 Gem 和 Ruby 的方法

### 升级 Gem

Gem 是管理 Ruby 标准包,如果 Gem 版本过低可能造成无法安装 CocoaPods,升级 Gem 使用下述命令

```
gem -v  //查看当前gem版本
sudo gem update --system　  //升级gem
```

### 升级 Ruby

MacOS 会自带 Ruby，但可能系统的Ruby版本过低，导致无法安装 CocoaPods, 可通过以下方式更新 Ruby

- 如果没有安装 Homebrew，可以先在终端中输入以下命令安装 Homebrew：

```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

Ruby 的升级有以下两种常见的方式，可根据自己的需要任选其中一种：

#### 通过 RVM 升级 Ruby

- 安装 RVM：在终端中输入以下命令安装 RVM：

```
curl -sSL https://get.rvm.io | bash -s stable
```

这个命令会从 RVM 官网下载安装脚本并运行。安装完成后，需要在终端中执行以下命令以便让 RVM 生效：

```
source ~/.rvm/scripts/rvm
```

- 查看 rvm 版本

```
rvm -v
```

- 查看可安装的 ruby 版本列表

```
rvm list known
```

- 安装指定 ruby 版本（eg:安装 ruby 3.0.0版本）

```
rvm install ruby-3.0.0
```

- 切换 Ruby 使用版本（eg:指定使用3.0.0版本）

```
rvm use ruby-3.0.0
```

#### 通过 Homebrew 升级 Ruby

在终端执行如下命令

```
 brew install ruby
```

安装完成后，ruby 默认使用的是系统自带的版本

- 查看版本号

```
ruby -v
```
- 查看 ruby 安装路径

```
 which ruby
```
- 配置环境变量

```
 echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc
```
- 配置完成后重启终端，再次查看 Ruby 版本号，校验是否为安装的 Ruby版本


升级完 Gem 和 Ruby 后，在终端重新输入如下命令安装 CocoaPods。

```
sudo gem install cocoapods
```
安装完成后，可如上文所示，查看 CocoaPods 版本号。



## 常见问题@questions

### MAC 环境真机运行 uts 插件时未安装 CocoaPods@notInstall

错误信息：uni_module [xxxx](iOS)存在pod三方依赖库，请先安装 CocoaPods！
说明：出现此错误是因为当前环境没有安装 CocoaPods
处理方法： 请参照上述章节描述的方式安装 CocoaPods 工具。

### 找不到指定版本的 pod 库，或者找不到指定依赖@noDependency

错误信息：CocoaPods could not find compatible versions for pod "xxx"  或者 None of your spec sources contain a spec satisfying the dependency:
报错示例：

```ts
'Analyzing dependencies\n' +
    '[!] CocoaPods could not find compatible versions for pod "HandyJSON":\n' +
    '  In Podfile:\n' +
    '    HandyJSON (= 2.0.2)\n' +
    '\n' +
    'None of your spec sources contain a spec satisfying the dependency: `HandyJSON (= 2.0.2)`.\n' +
    '\n' +
    'You have either:\n' +
    ' * out-of-date source repos which you can update with `pod repo update` or with `pod install --repo-update`.\n' +
    ' * mistyped the name or version.\n' +
    ' * not added the source repo that hosts the Podspec to your Podfile.\n',
```

说明：出现此错误是因为执行 pod install 时找不到指定依赖。

处理方法：

- 请首先确保配置的 pod 库 name 正确，配置的 version 不高于 pod 库发行的最高版本号。
- 确保未使用存放在私有仓库的 pod 库。
- 真机运行时在确保配置正确的前提下触发重新编译。
- 云打包时请重新打包，或者联系管理员。

### 无法访问 github@timeout

错误信息示例：

```ts
'[!] Error installing Alamofire\n' +
'[!] /usr/bin/git clone https://github.com/Alamofire/Alamofire.git /var/folders/9h/2znqhy813g932mrj_c9f781w0000gn/T/d20230614-22451-49mc32 --template= --single-branch --depth 1 --branch 5.7.1\n' +
'\n' +
"Cloning into '/var/folders/9h/2znqhy813g932mrj_c9f781w0000gn/T/d20230614-22451-49mc32'...\n" +
"fatal: unable to access 'https://github.com/Alamofire/Alamofire.git/': error:02FFF03C:system library:func(4095):Operation timed out\n",
```

说明： 出现此错误是因为当前网络无法正常访问 github

处理方法：
- 请检查您的网络连接，或者使用翻墙工具，确保当前网络环境可以正常访问 github

### CDN 错误@cnderror

错误信息示例：

- 示例一 无法解析 CDN 主机名

```ts
"[!] CDN: trunk URL couldn't be downloaded: https://cdn.cocoapods.org/all_pods_versions_8_e_e.txt Response: Couldn't resolve host name\n",
```

- 示例二 trunk Repo 更新失败

```ts
'[!] CDN: trunk Repo update failed - 75 error(s):'
```

- 示例三 验证失败

```ts
"[!] CDN: trunk URL couldn't be downloaded: https://cdn.cocoapods.org/deprecated_podspecs.txt Response: SSL peer certificate or SSH remote key was not OK"
```

- 示例三 连接不到服务器

```ts
"[!] CDN: trunk URL couldn't be downloaded: https://cdn.cocoapods.org/all_pods_versions_f_2_b.txt Response: Couldn't connect to server"
```

说明： 出现此类错误是因为网络网络问题无法正常访问 [CDN 服务器](https://cdn.cocoapods.org)

处理方式：
- 真机运行：检查您的网络，确保网络连接正常，或者使用翻墙工具，使当前网络环境可以正常访问 [CDN 服务器](https://cdn.cocoapods.org)。在网络不好时，请多试几次。