xUnique - 摆脱 XCode 的 project 文件冲突

Posted 2021-04-30 SwiftCafe

问题背景

这次咱们来聊聊这个话题。 大家在合作开发一个项目的时候，肯定会遇到这样一个情况。 团队的其他成员给项目中添加了一些文件。 XCode 会重新生成 project 文件， 随后他们把更改提交到版本控制系统中。 你更新他们的代码后，经常会碰到一个叫做 project 文件冲突的问题， 这时候你的项目就无法在 XCode 中正常打开了， 非常头疼。

其实这是 XCode 项目文件生成机制对于版本控制系统的一个缺陷。 我们可以打开 project 文件，看看它里面的结构：

对于每个文件的引用， XCode 都会生成一长串 16 进制数， 每一个代表引用的文件。 但问题是， XCode 的这个生成算法在不同设备上对同一个文件生成的这个串是有差异的。 这就导致我们平时遇到的这个问题了。 另外一台设备在提交版本控制的时候， project 文件是基于那台设备来生成的。 而我们更新代码后， 和我们自己设备上的 project 文件一对比， 自然会发生冲突了。 这也是很多 ios 开发者面临的一个问题。

xUnique

xUnique 的出现，正是要帮助我们解决这个问题。 xUnique 其实就是一个 Python 脚本， 会对 XCode 生成的 project 文件做一些处理。

简单来说就是这样， 首先 xUnique 将 project 文件转换为 JSON 格式， 然后将文件的引用改为通过路径形式引用。 随后， xUnique 会对每个文件的路径进行 MD5 加密， 并用他们替换原来 XCode 生成的那些 16进制 UUID。 因为是采用文件路径加上 MD5 的方式， 就可以保证在不同设备上生成的内容是一样的了。

以上就是 xUnique 的基本原理了。 下面咱们来看看如何使用。

首先通过 Python 自带的 pip 命令安装 xUnique:

$ pip install xUnique

安装成功后，打开一个新的命令行窗口， 输入 xunique 就可以看到这样的内容了：

使用 xunique 命令加上你的 project 文件的路径就可以进行处理操作了：

$ xunique xxx.xcodeproj/project.pbxproj

运行之后你会看到类似这样的输出：

Uniquify and Sort Ignore uniquify, no changes made to "/Users/Documents/samples/xUniqueTest/xUniqueTest.xcodeproj/project.pbxproj Ignore sort, no changes made to "/Users/Documents/samples/xUniqueTest/xUniqueTest.xcodeproj/project.pbxproj Uniquify and Sort done

这样就完成了 project 文件的处理。 当然，我们可能会在任意时候都会添加或修改项目的文件结构。 所以 xunique 命令最好能够自动化的运行。 否则如果我们哪次不小心在提交到版本库之前忘了运行它了。 还是造成文件冲突。

git hook

让 project 自动化的方式很多， 假如你使用的是 git 版本库，那么可以直接创建一个 git hook， 在每次提交版本的时候自动运行一下 xunique, 执行这个命令即可：

$ { echo '#!/bin/sh'; echo 'xunique path/to/MyProject.xcodeproj'; } > .git/hooks/pre-commit

你需要把 project 文件的路径修改成你自己的。 然后在每次提交 git 的时候， xunique 就会自动运行了。

结尾

xUnique 不失为解决 XCode 项目文件冲突的一个折中方案。 但前提是， 你要保证团队成员都正确配置了 xUnique 以及它的自动运行机制。 如果因为没有配置完善，某个设备不小心提交了未经处理的 project 文件， 还是会引起冲突。 当然，如果做好正确配置， xUnique 能很大的提升团队的整体效率。