配置RubyGems环境
接入 iOS 客户端之前,您必须先配置开发环境,包括检查 RubyGems 源、升级 RubyGems、安装 RMV、安装开发者工具、去除 Xcode 签名、安装 mPaaS 插件、安装命令行工具。
前置条件
作为开发者,您在本地环境中安装了 Xcode,并且要打开 Xcode,Xcode 会引导安装相关基础工具。
关于此任务
开发者工具
为帮助开发者快速集成 mPaaS 功能,mPaaS 提供了一套 mPaaS 开发者工具,主要包括以下部分:
- mPaaS 插件:帮助开发者对 mPaaS 组件进行管理,包括添加、删除和升级等,同时提供生成初始化代码、工程打包、重签名、埋点日志解析等功能。
- 命令行工具:给开发者提供安装和更新 mPaaS 插件 的脚本,支持通过命令行查看本地组件版本、打开 Xcode、去掉和恢复 Xcode 签名,以及为 mPaaS插件添加 UUID 等。
使用 mPaaS 开发 App 之前,必须先安装开发者工具。
RubyGems 和 Ruby
因为开发者工具的使用依赖 RubyGems 和 Ruby 环境,所以需要先搭建 RubyGems 和 Ruby 环境。RubyGems 是 Ruby 的一个包管理框架, 提供了分发 Ruby 程序和函式库的标准格式 gem,目的在于方便管理安装 gem 过程中需要的工具。Mac 系统本身支持 Ruby,需要对 RubyGems 进行检查更新。
注意:因为
taobao.org
已不再维护 RubyGems 源,如果您之前安装过 RubyGems 并且使用了taobao.org
提供的 Ruby 源,需要将其替换为 ruby-china 提供的 Ruby 源。否则,工具安装过程中可能会出现错误。详情参考 Ruby China。
RVM
RVM 是一个命令行工具,可以提供便捷的多版本 Ruby 环境的安装,管理和切换。
用 RVM 安装 Ruby,建议 Ruby 的版本为 v2.2。插件以及命令行工具使用了 CocoaPods 0.37.2 相关的 gem 工具,而 CocoaPods 是由 Ruby 编写的工具,因此对 Ruby 的版本有一定要求。经过长期试验,采用 Ruby 2.2.4 后,系统功能比较稳定。目前最新版 Ruby 2.4.0 与 CocoaPods 1.1.1 (当前最新版本)之前的版本不兼容。
操作步骤
1. 检查 RubyGems 源
-
运行以下命令检查本地的 Ruby 源,确保只有
gems.ruby-china.org
: -
如果存在
taobao.org
提供的 Ruby 源,运行以下命令去除该源: -
使用下面的指令替换 gem 源:
-
再次检查本地的 Ruby 源,确保只有
gem_sourcegems.ruby-china.org
,如下图所示:注意:如果出现报错,参考
https://gems.ruby-china.org/
中的解决方法。
2. 升级 RubyGems
升级后,检查 RubyGems 的版本,建议使用 RubyGems 2.6.10 或更高版本。
gem_version注意:如果因为依赖的缺失导致升级 RubyGems 失败,执行以下命令安装更新 Homebrew 相关工具来解决:
- 检查 HomeBrew 版本号,建议使用 HomeBrew 1.1.11 或更高版本。 brew_version
-
运行以下命令安装 Homebrew。执行
brew
,如果命令不存在,表示未安装 Homebrew: -
更新 Homebrew 相关工具。如果是 Mac 10.12 之后的系统版本,执行之前需要先执行
sudo chown -R $(whoami) /usr/local
:
注意:
- 更新完 Homebrew 相关工具之后,您需要继续回到步骤 2 升级 RubyGems。
- 安装 Homebrew 时,有时会因为网络等问题安装失败,尝试重新执行命令。在安装更新 Homebrew 相关工具之后,如果升级 RubyGems 还是遇到问题,参考 RubyGems.org 以及 常见问题。
3. 安装 RVM
- 运行以下命令检查 RVM 版本号,建议使用 RVM 1.29.1 或更高版本: rvm_version
-
运行以下命令安装 RVM 工具。执行
rvm
, 如果命令不存在,表示未安装 RVM 工具:如果上面的命令执行失败,尝试以下命令: -
载入 RVM 环境,使 RVM 环境变量立即生效:
-
安装 Ruby:
-
检查 Ruby 版本号。如果系统中使用 RVM 管理了多个 Ruby 版本,请先确认是否使用了版本号为 2.2.4 的 Ruby:
rvm_list -
安装 Ruby 2.2.4
注意:
- 在执行 rvm requirements 时,如果安装 rubygems 卡住,可以尝试逐个安装失败的 gem。
- cc49 以后不需要在 rvm requirement 装了,rvm 安装依赖时引入了对 gcc 的依赖,所以特别慢,但其实并不需要。
- 如果卡住,可以尝试直接 rvm install 2.2.4。
- 安装 Ruby 2.2.4 时,有时会因为依赖的缺失导致安装失败,如果出现异常问题,请参考 常见问题 中提示进行处理。
-
-
设置 Ruby 2.2.4 为默认版本:
- 检查是否成功安装 Ruby 2.2.4 which_ruby
上述步骤都完成之后,就已经搭建完成 RubyGems 和 Ruby 环境。
注意:由于开发者的电脑环境可能长期未升级,安装环境时环境升级可能会耗费较多时间。由于例如 Ruby、RVM、RubyGems 等基础环境的更新访问的都是国外的服务器,所以速度较慢,安装时请耐心等待。如果出现异常问题,请参考 常见问题 中的提示进行处理。
4. 安装开发者工具
-
完全退出 Xcode,在终端运行下列安装命令:
-
按照屏幕提示输入密码。
-
对于 Xcode 8 之后的版本,安装 mPaaS 插件时需要 unsign Xcode。按照提示输入
U
。脚本会自动完成安装。注意:如果在安装过程中遇到其他问题,参考 常见问题。
5. 去除 Xcode 签名
Xcode 8 对 mPaaS 插件的安装有限制,需要去除 Xcode 签名才能顺利安装 mPaaS 插件。去除签名本身对使用 Xcode 没有任何影响。随时可以按照下面的操作来恢复签名:
unsign_new注意:
- 去除 Xcode 签名的作用是确保能够正常使用插件,请按提示输入
U
。- 如果本地环境中安装了多个 Xcode,请上下移动箭头选中希望去除签名的 Xcode 按下回车键继续,同时会去掉 xcodebuild 的签名。
- 去掉的签名都是可恢复的。根据上图安装
reuse_xcode_plugins
后恢复签名,也通过使用下面的命令直接恢复签名:
mpaas restore
6. 安装 mPaaS 插件
-
安装完开发者工具后,重启 Xcode。在是否加载插件的弹框中,选择 Load Bundles:
load_bundle提示:如果不小心点击了 Skip Bundles,执行下面的命令恢复,其中将命令最后的版本号换成本机的 Xcode 版本号。然后,重启 Xcode,选择 Load Bundles:
-
打开本机上任意 Xcode 工程,点击 Edit> mPaaS > Main,进入如下主界面:
[图片上传失败...(image-43b498-1537238409157)]注意:进入主界面时,要先打开本机上的任意工程,再打开 Edit > mPaaS > Main,否则会因插件读取不到工程信息而报错。如果是打开 File > New > 新建mPaaS工程,则不需要先打开本机上的工程。
具体使用说明,参考 mPaaS 插件。
7. 安装命令行工具
除了 mPaaS 插件,您还可以借助命令行工具辅助开发 mPaaS。关于命令行工具的使用说明,参考 命令行工具。
后续操作
根据不同的使用场景和支持的接入方式,将 mPaaS 接入 iOS 客户端:
- 基于 mPaaS iOS 框架创建工程
- 基于系统 iOS 框架添加 mPaaS 组件
具体接入步骤,参考 创建工程 快速接入 mPaaS 功能。