从使用git开始,遇到过各种各样的merge事故,本团队内的大大小小的事故就不下10起。小的merge错误,有的被测试当做bug提出,有的则是自己对该模块的代码再次修改时,才能再次发现;大的merge错误,则会block整个团队提交代码的动作,甚至会影响发版。本文主要讨论一些merge的注意事项以及小技巧。
1. 强烈建议使用Beyond Compare merge代码
Android Studio的VCS某些功能很好用,如批量pull与push,但是merge代码的功能实在不敢恭维。举一个比较简单的例子:
上图中,冲突的解决,需要手动选择local(left)与remote(right),常看到新手直接选择remote,或者直接选择local,把其中一个丢弃,甚至直接自信点击右下角apply,这无疑造成了一起merge事故。
来看看Beyond Compare的merge方式:
图片下半部分中,Beyond Compare会给出建议的merge结果,可视化效果也做得很不错,让用户有意识去选择local(left),或者remote(right),处理过后的结果还不满意,也可以自己手动编辑。在这个例子中,可以「choose left then right」。
以上的例子还算简单,遇到复杂且数量多的冲突,Beyond Compare会明显比Android Studio好用,而且基本都会提供靠谱「建议结果」。需要注意的是,即使提供了「建议结果」,也需要一一review,不要想当然。另外,如果自己不了解业务层代码,或者实在不知道怎么解决一个冲突,请叫人叫人叫当事人。
2. 尽量避免冲突
避免冲突,merge的时候就会省去很多力气。有几个避免冲突的小技巧(欢迎补充):
- 公共模块,尽量不要在文件的末尾增加代码。如styles.xml这类的公共模块文件,如新增的style直接在末尾增加,其他开发者也把新增的style添加在末尾,merge时则会造成冲突。如果没有严格的顺序要求,可以把新增的style增加到一个随机的中间位置。
-
禁止大面积format代码。有的同学有强迫症,写代码时容不下一两个空格的差异,然后顺手按下cmmd+shift+f,就把整个文件format了。merge的时候,发现几十个冲突(如果其他人也编辑了这个文件),用的还是Android Studio,瞬间懵逼。如果非要format代码,可以用鼠标选中看不顺眼那几行再format:
- 提前沟通,减小冲突的可能性。如果某些模块需要两个人一起修改,这时两人需要提前沟通各自需要修改的地方,merge代码时可能造成冲突的地方,然后再分工,尽量减小冲突,而且一定不要有重复工作。
3. 注意remote被删除了的情况
可能存在这种情况,merge的时候,remote上的a.java文件被删除了,而local又不小心地(1)在a.java增加了一些空格;(2)甚至进行了业务代码的修改。
首先,要识别出remote文件被删除并造成冲突的情况。如下图:
图片中的①位置diff区域,可以看出是空白的,而执行②,使用Beyond Compare merge时,Beyond Compare会没有反应,且图中③的位置会莫名其妙多出好多merge时的tmp文件。这时就可断定出remote中的该文件被删除了。
针对以上(1)的情况,可以选择「resolve using 'theirs'」直接把文件删除。而针对(2)的情况,需要与文件的删除者沟通,再把自己修改的代码挪到相应的地方。
反之,也可能出现local中文件被删除,remote中有人修改该文件的情况:
可以看到diff区域全是增加(+)的绿色。处理的方法和上述类似。
4. 新建文件重构时,注意及时同步代码
如果要新建a.java与b.java文件,对c.java文件进行重构,2个星期后,重构完成,需要保证这两个星期内在c.java的修改,也同步到重构后的a.java与b.java中。
5. import相关的冲突基本可以忽略,使用BC推荐的解决冲突方式即可
有时候import的冲突也比较多,解决起来也比较繁琐,其实可以跳过手工合并,直接选择Beyond Compare推荐的结果,即使推荐错了,编译期也能发现编译错误,到时候再自动import即可。
6. Merge时的commit message使用默认的
常常看到有人修改了merge节点的commit message,替换成俩字:merge。务必使用默认的commit message,如下图,带有conflict信息:
保留的conflict信息也对日后有用。
总结,使用好的解决冲突工具:Beyond Compare,当然还有Source Tree这样优秀的git工具。尽量减小冲突。以认真的态度对待merge。