如何快速熟悉新系统

很多工程师都会遇到这样一种情况:被指派到另外一个项目参与开发工作,这个项目已经开发了一段时间了,代码还比较多,作为一个项目的新人,要如何尽快地熟悉项目融入团队呢?

对系统进行测试

作为一名新系统的小白,首先当然是要熟悉系统的功能,还有操作流程。

  • 如果有相关的系统说明文档(帮助手册)的话先阅读这些资料,了解系统是如何工作的,有哪些功能点。
  • 了解了系统如何操作以后,对系统的各个功能点进行功能测试,通过手动操作来加深对系统的了解,并帮助系统找到bug。
  • 发现bug后将bug记录起来,比如github(gitlab)上项目里的issue区域,并提醒其他开发人员关注这些问题。

尝试修复bug

操作了一段时间系统后,可能你对系统功能已经有了一个大概的了解,但实际的代码可能还了解不多,这个时候你可以通过修复一些小bug来达到了解系统的目的。

  • 首先找到bug对应的页面或者文件,设置断点,运行程序,查看是什么原因导致发生bug。
  • 搞清楚bug发生的原因后,动手修复这个bug。
  • 修复bug后,如果有测试案例要保证不破坏其他测试案例,如果有测试案例失败了,这可能表示你修复的代码破坏了其他正常的功能。
  • 对其他相关模块进行测试,保证没有其他副作用。
  • 如果可以的话,让其他资深的开发人员给你review一下代码,看看你有没有改出问题,或者是有没有其他更好的解决方案。

为系统添加测试案例

除了修复bug,还可以为系统添加测试案例。这里的测试案例是指单元测试、集成测试或者一些自动化测试。

  • 如果是写单元测试的话,要先读懂对应的功能代码,知道功能代码的逻辑是怎样的,有多少个分支需要写多少个测试案例才能覆盖完整。然后编写测试案例,并保证测试案例运行通过。
  • 如果是集成测试或者自动化测试,先了解要测试的功能的流程是怎样的,是要读取数据库数据做校验,还是可以直接在页面上面校验等。然后编写测试案例,因为自动化测试可能由于网络延迟等原因会让你的测试有时成功有时失败,请记住要避免这种情况,确保测试是百分之百运行成功的。

对代码进行重构

有时候系统开发久了,就会不知不觉产生一些烂代码,如果没有及时修复,整个系统可能就会慢慢腐烂,然后崩溃,最后维护都维护不了只能重做。所以如果你有一些代码重构的经验的话,可以在熟悉系统的过程中,通过代码重构的方式了解系统的代码。

  • 要重构代码,就要先熟悉你要改动的那一块代码,读懂它们并确保你做的重构不会影响到其他功能。
  • 如果要重构的代码之前有单元测试那是最好的,你可以边重构边运行测试,只要不破坏测试就可以了,但如果没有单元测试的话,你最好是先加上单元测试,以保证你的重构不会破坏原来的功能。
  • 这里的重构不是指哪种伤筋动骨的大改动,而是一些代码上的小修改,以让你的代码更具可读性和可维护性,比如变量名或方法名的重命名,相同代码的提取,长方法的分解等。

Comments