1.编写该文档的原因:
①.因为公司没有提供最新的需求文档;
②.也没有最近迭代版本的需求文档;
③.也没有之前负责该零售中台模块/ECRP开放平台接口API的同事编写相关新人指导文档。
所以,对于有300多张数据表的后台,要提高学习效率,尽快熟悉现有已上线业务,需要从每个页面对应的数据表入手,了解数据表结构;
============================================================================
2.学习思路:
①.每个查询接口,都有写相关查询sql日志,可以通过日志定位到数据存储的数据表;
============================================================================
3.准备工作:
①.服务器
⑴.获取到服务器登录信息;
⑵.获取到日志存储的相对路径;
⑶.获取到日志文件的生成规则;
⑷.获取到控制层接口跟日志文件夹名的对应规则;
②.数据库
⑴.获取到数据库登录信息;
⑵.获取到数据保存对应的数据库名;
⑶.大致了解表结构,对重要字段和表外键做相关学习记录;
③.xmind/excel
⑴.结合【单接口&单数据表】关系,做系统性的业务整理;
⑵.同时,记录页面数据源的入口路径,一个接口对应有几个入口等等关联功能点;
============================================================================
4.执行步骤:
①.登录堡垒机;
②.找到服务器列表,进入对应的单个服务器;
③.进入指定路径,备份原先已生成的日志文件;
涉及核心命令行语法: mv A B;
④.后台页面,触发curd请求,查看日志更新记录;
涉及核心命令行语法: tail -f C.log;
⑤.记录api接口所对应controller日志文件名;
例如:
api名:kdgoods/saveOrUpdate;
controller日志文件名:KdGoodsController;
⑥.形成系统性的xmind文档,完整记录信息,方便后续数据迭代更新;
============================================================================
5.实现效果:
①.提高个人服务器/数据库操作能力;
②.完成一个有益于团队新老成员维护的文档;
③.多形成一个可实现目标的思路,提高学习效率;
④.减少跟开发人员/测试人员/产品人员碰问题的不必要时间;
============================================================================