起因

最近由于接手新的项目,由于文档注释等不完善,加上里面还到了商业框架,这就需要额外的时间来快速学习和上手,所以写篇文章作个总结.下面说一下怎么能快速熟悉项目.

1.从文档入手

首先将公司的所有文档大致看一下,主要看和项目相关的,比如项目的起源背景,架构设计,功能设计,需求文档,表设计文档,都是需要看的,以及做个整理,心里至少有个概念,不能懵懵懂懂的

2.从数据库入手

有些可能表设计文档都没有或者有也对应不上,这时候就需要连测试库将表大概看一下,首先看表的名称,总结下命名表名的规律,如果表名创建的好,基本可以知道这个表涉及什么业务,表的作用,以及表与表之间的关联.

3.项目入手

3.1从项目结构入手

为什么我说不急于看代码,而是先看结构呢,因为如果你一开始就扎入代码里,就不容易抽身出来纵观全局,尤其当你对代码部分有疑问的时候很容易越看越迷糊,此时最好就是先略过代码,看项目结构,其他不太清楚,java是分包的,包名起得好的话,你就能知道这个包干什么的,有什么作用.

3.2从项目配置文件入手

看完结构也就知道代码在哪,sql文件在哪,前端页面在哪,也就知道配置文件的位置了,最新的项目可能有些都是纯java类配置了,没有配置文件,不过作用是一样的,所以这里统称为配置文件了,配置文件就是像是打开项目的一把钥匙,有了这把钥匙,你就能知道为什么代码这么写以及为什么文件在这里生效,还有全局的编码调整,以及对页面的控制和请求的处理和过滤,通过配置文件,你能知道项目的入口以及怎么流转的.

3.3调试代码

如果有页面那就随便找一个页面入口,最好是主线功能的页面,在代码的controller层打断点,一步一步深入到服务层,再到数据层,查看每一步上下文的变化,查看涉及的表以及表结构,加深对业务的理解,如果没有页面的话,可以使用接口测试工具来进行对应接口的请求达到相同的学习目的

总结

梳理项目,一定要有耐心,细心,及时做文档,思维导图和流程图也有助于你对项目的理解,如果能尽快上手一些小的功能,那这个对你理解项目也是很有帮助的,别畏惧,要去尝试写,错了没关系,至少迈出去这一步就说明在进步了