知方号

知方号

经验分享:如何快速上手公司的项目代码<产品的文档看不懂怎么办>

经验分享:如何快速上手公司的项目代码

经验分享:如何快速上手公司的项目代码 前言阅读项目代码的步骤把项目先运行起来了解项目后端架构情况观察项目的目录结构观察数据库表状况 深入项目,阅读代码从被调用的接口入手理解整个操作的逻辑给关键代码加上注释 阅读项目代码的四大原则跑不起来的代码不读,用不到的代码暂时不读以功能逻辑为主,不要死抓细节虚心请教,学会提问勤记笔记,多画图 后记

前言

来公司实习也一个多星期了,基本上啥事也没干,主要就是看公司项目的代码。坦白说,第一次接触到这种实际的项目中来,确实和平时所能接触到的项目代码很不一样。平时无论是自己做的那些课程设计、毕业设计,还是GitHub上能下载到的绝大多数项目,用同事的话来说就是:太干净了,一看就没有经历过产品经理的摧残。

实际上,我们进公司后接触到的代码,绝大部分是有一定历史的:经历过了N个人的转手,并且在期间经历过了多次的功能迭代更新,新代码与旧代码杂糅在一起,光看目录就头疼得不行。

我接触到的这个项目就是类似的情况,并且没有项目有关的文档能给我看,有部分代码还没有注释,对于一个完全没有过接手别人代码经验,也对这个项目完全不了解的实习生来说,实在是太不友好了。

好消息是公司的人对我都很好,也给了我很多的时间去学习,积累经验。经过这段时间的摸索,感觉隐隐约约也能触碰到一点读项目代码的窍门了,在这里分享一下我的学习过程吧。

阅读项目代码的步骤

公司的代码不方便展示出来,我就以GitHub上面的这个开源项目newbee-mall为例子,记录一下我读项目代码的步骤。

把项目先运行起来

这可能是一句废话,但是却是阅读项目代码的起点。

配置项目的运行环境可能是一件比较繁琐的事情,多多少少会遇到一些问题。但是在解决这些问题的过程中,可以让你对项目的技术路线有个大致的了解,例如所使用的开发框架、使用的库、数据库服务器等信息。

项目跑起来之后,可以比较直观地看到项目的功能模块,让你对公司业务也有一个初步认识。尤其是对于没有文档而言的情况,体验这个运行起来的项目是了解业务的最好方法。

因为是下载下来的项目,还需要把数据库配置到本地,并且去配置文件中将数据库的信息改成自己本地的配置。如果是公司的项目,数据库应该是在公司服务器上面的,就不需要修改了。

因为是个SpringBoot的项目,修改完之后直接运行NewBeeMallApplication就能跑起来了,可以看到是一个商城。

大致操作了一下这个商城系统,和后台的管理系统,已经对这个系统的功能有大概了解了,接下来需要从大体上把握项目的后端情况。

了解项目后端架构情况

了解项目的架构情况,可以从两个角度出发。

观察项目的目录结构

读目录结构其实也属于读程序的一个部分,最起码能让你对代码的功能分类有个大概的了解。如果经验比较丰富,项目的目录结构也比较合理的话,其实看包名就能知道对应包的作用。但是如果是经验不太充足,或者是目录结构很混乱的情况,最好还是要花点时间记录一下。

这个项目代码量并不是特别多,也没有用到其他特别的框架,包名都是很常见的包名,因此见名知意,很快能知道每个包的作用,寻找代码文件的时候也方便得多。

观察数据库表状况

观察数据库表状况,就是去了解有哪些实体,实体与实体之间的关系如何,如果有余力的话,可以自己画画关系图。当然,公司的项目上有一百多张表,以我目前的能力来说,肯定是没有余力的,因此我选择了用工具来导出。

我常用的数据库管理软件是MySQL Workbench,它恰好提供了这项功能。

首先点击左侧这个像

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至lizi9903@foxmail.com举报,一经查实,本站将立刻删除。