【提升效率】排查代码的影响范围后,进行结构性地记录

背景

在排查影响的任务中,经常需要排查应用中某些变量、某些配置、某些方法的使用点及其影响范围。
他们的使用点和影响范围一般都涉及多个,甚至数十个。
如果用纯文本记录,不够结构化,可读性不强,不便于后续的回溯。

使用Excel结构性地记录起来

基于上述背景。
最近我们在排查某些代码的影响点时,使用Excel将其结构化地记录下来。
以下以在IntelliJ IDEA排查Java代码的影响点为例,比如我们需要排查send方法的影响点:

1、通过“Ctrl + Alt + H”(IntelliJ IDEA Windows版的快捷键)调出其代码引用的层级结构,然后点击红色方框的按钮,使其按字母有序排列

2、然后通过查看代码逻辑,将下面几个维度的信息结构化地记录起来,便于后续查看或者回溯。示例:

根代码 引用代码(2级) 业务触发点 业务逻辑描述 备注
NIOUtil#send MyHelloServer#handle MyHelloServer定时任务 如果满足下列条件之一,则发送邮件:1、A;2、B; 技术观点:需从业务需求层面确定如何修改
NIOUtil#send SomeController#test 管理后台的发送邮件按钮 如果管理员点击触发,则发送邮件 技术观点:需从业务需求层面确定如何修改

注意:其中引用代码需列到几级(示例列到2级),具体根据我们需排查代码的复杂度而定。

最后

小弟不才,学识有限,如有错漏,欢迎指正哈。
如果本文对你有帮助,记得“一键三连”(“点赞”、“评论”、“收藏”)哦!

posted @ 2024-12-05 23:56  nick_huang  阅读(47)  评论(0)    收藏  举报