源代码管理的一些问题

问题来自于：现代软件工程讲义源代码管理

0. 在吹牛之前，先回答这个问题： 如果你的团队来了一个新队员，有一台全新的机器， 你们是否有一个文档，只要设置了相应的权限，她就可以根据文档，从头开始搭建环境，并成功地把最新、最稳定版本的软件编译出来，并运行必要的单元测试？ （在这过程中，不需要和老队员做任何交流）

在团队的资料库的根目录中，会有一个"开发快速上手指南.docx"这个文档，这个文档作为一个索引文档，提供了资料库里面所有相关文档/工具的索引地址，格式可以多种多样，我提供一种格式作为参考：

开发工具以及配置：

jdk: svn://xxx.xxxx.xxxx /jdk-7u80-windows-i586.zip

eclipse: svn://xxx.xxxx.xxxx /eclipse-jee-luna-SR1a-win32.zip

Tomcat: svn://xxx.xxxx.xxxx /apache-tomcat-7.0.55.zip

MySQL: svn://xxx.xxxx.xxxx /mysql-5.5.47-win32.zip

部署详细步骤：

1. 新建文件夹workspace
2. 打开eclipse

   FileàSwitch WorkspaceàOther... àBrowse..., 选择workspace这个目录，点击Ok，切换至新的工作空间

3. 在新的工作空间里

   FileàImport... àSVNà从SVN检出项目à创建新的资源库位置àNext

àURL填：svn://xxx.xxxx.xxxx/xxx/xxxxàNextà选择xxxxàFinish,即可导入项目。

1. 配置Tomcat: xxx
2. 修改配置文件：

   WEB-INF/目录下的xxx.xml文件需要修改

3. 启动项目：

   例：项目加入Tomcat中，右键Tomcat，点击Run

4. 验证项目是否启动成功：

   访问:http://localhost:8080/xxxx，主页显示，启动成功。

1. 你的团队的源代码控制在哪里？用的是什么系统？如何处理文件的锁定问题？

   场景： 程序员果冻正在对几个文件进行修改，实现一个大的功能， 这时候，程序员小飞也要改其中一个文件，快速修复一个问题。怎么办？

    一个代码文件被签出 (check out) 之后，另一个团队成员可以签出这个文件，并修改，然后签入么？

   有几种设计，各有什么优缺点？

   例如，签出文件后，此文件就加锁，别人无法签出；  或者， 所有人都可以自由签出文件

针对这个场景，首先要划分优先级，

如果小飞要修复的问题需要马上立刻发布补丁，那么，小飞应该直接签入修改的文件，发布完以后，果冻先备份自己写好的文件，然后把小飞签入的文件更新到本地，然后在本地将自己备份的文件和更新的文件进行merge即可。

签出文件后，此文件就加锁，别人无法签出：

这种情况，可以保证每个人获取的文件版本是最新的，也不会产生修改冲突。但是这种方式花费的时间相对要长一些，因为其他人要等签出这个文件的人签入完毕以后才能签出下来进行修改。

所有人都可以自由签出文件：

所有人都可以自由签出文件，这种情况大家各自修改自己需要修改的模块，但是到合并代码的时候，需要人工Merge，这种方式风险会大一些，特别是同一个人修改一个文件涉及到相同函数的修改。

2. 如何看到这个文件和之前版本的差异？ 如何看到代码修改和工作项 （work item），缺陷修复 （bug fix) 的关系。

   场景：程序员果冻看到某个文件被修改了，他怎么看到这个文件在最近的修改究竟改了哪些地方？ （例子）

   场景：程序员果冻看到某个文件在最新版本被改动了100 多行， 那么和这100多行对应的其他修改在什么文件中呢？ 这个修改是为了解决哪些问题而作的呢？ 那些问题有工作项 （work item，issue），或者bug 来跟踪么？

对于场景1的情况：

很多开发工具都自带有show history的功能，对于文件的提交历史以及提交修改可以查看到，以Android Studio为例：

此外，Github提供这样一种方式来查看最近修改：

查看master分支最近7天内的差别：

https://github.com/mybatis/mybatis-3/compare/master@{7.day.ago}...master

查看与指定日期之间的差别，如下，查看最新版与2015年9月27号这个版本的差别：

https://github.com/mybatis/mybatis-3/compare/master@{2015-09-27}...master

对于场景2的情况：

我们曾经用过比较原始的方式：

基本是通过查看提交时候的comment来确定这次提交的修改原因是什么。Bug和功能列表通常在另外一个系统记录，比如：Excel，在Excel里面对Bug和功能进行标记（已完成，未完成，进行中），一般开会的时候大家对近期修复的Bug和功能按照这个Excel表的内容一起来过一遍。

对于和这个100多行的修改一起签入的其他修改，在Eclipse+SVN下可以查看相关修改的文件以及修改原因：

在某个文件上点击右键：Team->显示资源历史纪录：

Github上：

可以自动关联Bug/ issue和每次签入的修改之间的关系

用户可以提交Issue，并把Issue标记为bug，开发人员提交代码的时候，加上以下描述信息，对应的Issue就会被Close

fix #+Issue编号

如：fix #1 对应编号为1的Issue被关闭。

3. 如果某个文件在你签出之后已经被别人修改，并且签入了，那么你在签入你的修改的时候， 如何合并不同的修改（merge)? 你用了什么工具来帮助你？

这种情况我一般的处理方式是备份本地自己开发的一份代码，先把别人签入的代码更新到本地，然后在本地手动合并修改，用的工具是Beyond Compare。 

4. 你有20个文件都是关于同一个功能的修改，你要如何保证这些文件都同时签入成功（修改的原子性），或者同时签入不成功？

    场景： 程序员果冻要签入 20 个文件，他一个一个地签入， 在签入完5 个 .h 文件之后， 他发现一些 .cpp 文件和最新的版本有冲突，他正在花时间琢磨如何合并... 这时候， 程序员小飞从客户端同步了所有最新代码， 开始编译， 但是编译不成功 - 因为有不同步的 .h 文件和 .cpp 文件！  这时候， 别的程序员也来抱怨同样的问题，果冻应该怎么办？

在签入之前，一定要先对比处理有冲突的文件！

Eclipse+Subsversion有一个与资源库同步的功能，这个功能可以显示有冲突的文件（用红色标注），在签入的时候，先把冲突文件更新下来，与本地自己要签入的文件进行一轮merge，参考第三题的方式，然后再把20个文件一起签入即可。 

5. 你的PC 上有关于三个功能的修改， 但是都没有完成，有很多文件处于半完工的状态，这时你要紧急修改一个新的 bug，如何把本地修改放一边，保证在干净的环境中修改这个 bug, 并成功地签入你的修改 --- changelist management。

先备份本地修改的整个工程，然后把工程还原成（Revert）成基线版本（参考第九问），然后进行修改bug并签入，最后通过Beyond Compare工具来对比本地备份的版本和最新的版本，并merge。

6. 规范操作和自动化

    你的团队规定开发者签入的时候要做这些事情：

    - 运行单元测试，相关的代码质量测试。

    - 代码复审 （要有别的员工的名字）

    - 和这次签入相关的issue 编号， 任务/task， 缺陷/bug 编号，等等， 以备查询。

    请问你的团队有这样的自动化工具让开发者方便地一次性填入所有信息然后提交么？  （高级功能， 代码提交之后， 相关bug 的状态会改动为  "fixed"， 并且有链接指向这次签入。）

例子。

完善中….

   

7. 如何给你的源代码建立分支？

    场景：你们需要做一个演示，所以在演示版本的分支中对各处的代码做了一个临时的修改， 同时，主要的分支还保持原来的计划开发。 你们怎么做到的？ 在演示之后，演示版本的有些修改应该合并到主分支中，有些则不用，你们是怎么做到的？

    场景： 你们的软件发布了，有很多用户，一天，一个用户报告了一个问题，但是他们是用某个老版本，而且没有条件更新到最新版本。 这时候，你如何在本地构建一个老版本的软件，并试图重现那个问题？

 对于场景1:

以Github为例：

1. 打分支
2. 有条件地合并分支和主分支

对于场景2：

1. 新建一个分支
2. 在这个分支上，回滚到用户所用的版本

在Github中，可以通过git log命令来查看历史提交记录：

通过：

8. 一个源文件，如何知道它的每一行都是什么时候签入的，为了什么目的签入的 （解决了哪个任务，或者哪个bug）？

   场景： 一个重要的软件历经几年，几个团队的开发和维护，忽然出现在某个条件下崩溃的事故， 程序员果冻经过各种debug手段，发现问题是在某一个文件中有一行代码似乎显然出了问题， 但是这个模块被很多其他模块调用，  这行代码是什么时候，为了什么目的，经过谁签入的呢？  如果贸然修改， 会不会导致其他问题呢？  怎么办？

以Github为例：

执行git blame命令，即可显示每一行都是什么时候签入的，为了什么目的签入的，签入人是谁

或者在Github页面

9. 如何给一个系统的所有源文件都打上标签，这样别人可以同步所有有这个标签的文件版本？

   代码每天都在变， 有时质量变好，有时变差，我们需要一个 Last Known Good （最后稳定的好版本） 版本， 这样新员工就可以同步这个版本， 我们如果需要发布，也是从这个版本开始。  那么如何标记这个 Last Known Good 版本呢？ 

 Last Known Good （最后稳定的好版本） 版本可以理解为基线版本，通常情况下，每次正式上线的版本都会打基线，即备份这个版本的源代码和发布包，

以SVN为例：

新版本V1.0发布了，

源码在这个目录：

在tags目录下创建以下目录：

将发布版本的源码Copy To到./tags/V1.0/Source Code下

在demosystem上右键：

TortoiseSVN->Repo-browser->

选择这个项目右键：

Copy to…

输入相应备注点击ok即可

更新tags/V1.0这个目录，即可获取 Last Known Good （最后稳定的好版本）

10. 你的项目的源代码和测试这些代码的单元测试，以及其他测试脚本都是放在一起的么？ 修改源代码会确保相应的测试也更新么？你的团队是否能部署自动构建的任务？

    在签入之前，程序员能否自动在自己的机器上运行自动测试，以保证本地修改不会影响整个软件的质量？

    在程序员提交签入之后，服务器上是否有自动测试程序， 完成编译，测试，如果成功，就签入，否则，就取消签入？

    团队是否配置了服务器，它自动同步所有文件，自动构建，自动运行相关的单元测试，碰到错误能自动发邮件给团队

完善中……