代码走查总结报告

开源⼯具Findbugs使⽤总结⼀、代码检查法概念⽩盒测试分为静态测试和动态测试。

代码检查法是静态测试的⼀种，主要是由⼈⼯进⾏，充分发挥⼈的逻辑思维优势，也可以借助软件⼯具⾃动进⾏。

代码检查包括代码⾛查、桌⾯检查、代码审查等，主要检查代码和设计的⼀致性，代码对标准的遵循、可读性，代码的逻辑表达的正确性，代码结构的合理性等⽅⾯；可以发现违背程序编写标准的问题，程序中不安全、不明确和模糊的部分，找出程序中不可移植部分、违背程序编程风格的问题，包括变量检查、命名和类型审查、程序逻辑审查、程序语法检查和程序结构检查等内容。

⼆、Findbugs⼯具介绍静态分析⼯具有很多，其中商业⼯具⽐较有名的有Klocwork，coverity，pc-lint，开源的有splint，Findbugs等。

以下主要介绍⼀下Findbugs⼯具。

Findbugs是⼀款Java静态代码分析⼯具，与其他静态分析⼯具（如Checkstyle和PMD）不同，Findbugs 不注重样式或者格式，它专注于寻找真正的缺陷或者潜在的性能问题,它可以帮助java⼯程师提⾼代码质量以及排除隐含的缺陷。

有了静态分析⼯具，就可以在不实际运⾏程序的情况对软件进⾏分析。

Findbugs运⽤Apache BCEL 库分析类⽂件（class⽂件）⽽不是源代码，将字节码与⼀组缺陷模式进⾏对⽐以发现可能的问题。

Findbugs 的检测器已增⾄300多条，被分为不同的类型，常见的类型如下：· 正确性（Correctness）：这种归类下的问题在某种情况下会导致bug，⽐如错误的强制类型转换等。

· 最佳实践反例（Bad practice）：这种类别下的代码违反了公认的最佳实践标准，⽐如某个类实现了equals⽅法但未实现hashCode⽅法等。

· 多线程正确性（Multithreaded correctness）：关注于同步和多线程问题。

产品走查报告一、引言本报告旨在对产品进行走查，并对发现的问题进行总结和分析，以便为产品改进和优化提供有价值的意见和建议。

二、走查概述1. 走查时间：2022年1月1日至2022年1月15日2. 参与人员：开发团队、测试团队、产品经理3. 走查目的：发现并解决产品中的问题，提高产品质量和用户体验三、走查结果在走查过程中，我们对产品在功能、性能和界面三个方面展开了全面的检查和评估。

以下是我们发现的问题和对应的解决方案：1. 功能问题1.1 登录功能异常：偶尔出现登录功能失效的情况，导致用户无法正常登录系统。

解决方案：对登录流程进行全面测试，修复登录功能的bug并增强登录验证机制。

1.2 数据丢失问题：在部分场景下，用户输入的数据没有被正确保存，导致数据丢失。

解决方案：检查数据保存的逻辑，修复数据丢失的bug，并增加数据备份机制。

2. 性能问题2.1 响应速度慢：某些操作的响应速度不够快，给用户带来不良体验。

解决方案：优化相关代码，提升系统的处理速度和响应性能。

2.2 内存占用过高：长时间使用产品后，系统的内存占用逐渐增加，导致系统变得缓慢。

解决方案：进行内存泄漏的排查和修复，减少系统资源的占用。

3. 界面问题3.1 布局错乱：在某些屏幕分辨率下，产品的布局出现错乱，影响用户界面的美观性。

解决方案：适配不同屏幕分辨率，确保产品界面在各种设备上都能正常显示。

3.2 文字显示异常：某些场景下，产品中的文字显示出现乱码或显示不完整的情况。

解决方案：优化文字渲染机制，确保文字显示的准确性和清晰度。

四、总结和建议通过本次走查，我们成功发现了产品存在的问题，并提出了相应的解决方案。

为了进一步优化产品质量和用户体验，我们建议开发团队在后续的开发过程中，严格按照走查结果进行问题修复并进行全面测试。

同时，建议在产品发布前进行多轮走查，以确保产品的稳定性和可靠性。

在对产品的更新迭代过程中，我们鼓励持续进行走查活动，以及时发现和解决问题，提升产品的价值和竞争力。

刚刚知道“代码⾛查”是什么意思
代码⾛查的最主要的⽬的是为了发现程序中的逻辑错误，编程风格⽅⾯的错误可以通过风格检查的⼯具去检查。

如下的检查单给代码⾛查的专家发现逻辑错误提供了⼀个很好的帮助。

序号检查项
1代码的注释与代码是否⼀致?注释是否是多余的?
2是否存在超过3层嵌套的循环与/或判断?
3变量的命名是否代表了其作⽤?
4所有的循环边界是否正确?
5所有的判断条件边界是否正确?
6输⼊参数的异常是否处理了?
7程序中所有的异常是否处理了?
8是否存在重复的代码?
9是否存在超过20⾏的⽅法?
10是否存在超过7个⽅法的类?
11⽅法的参数是否超过3个?
12是否有多种原因导致修改某个类?
13当发⽣某个功能变化时，是否需要修改多个类?
14代码中的常量是否合适?
15⼀个⽅法是否访问了其他类的多个属性?
16某⼏项数据是否总是同时出现，⽽⼜不是⼀个类的属性?
17switch语句是否可以⽤类来替代?
18是否有⼀类的职责很少?
19是否有⼀个类的某些属性或者⽅法没有被其他类所使⽤?
20在类的⽅法中是否存在如下的调⽤形式：a.b().c()?
21是否某个类的⽅法总是调⽤另外⼀个类的同名⽅法?
22是否某个类总是访问另外⼀个类的属性与⽅法?
23是否两个类完成了类似的⼯作，使⽤了不同的⽅法名，却没有拥有同⼀个⽗类?
24是否某个类仅有字段和简单的赋值⽅法与取值⽅法构成?
25是否某个⼦类仅使⽤了⽗类的部分属性或⽅法?。

代码走查制度
为代码走查的目的：
第一、及时了解程序员编写的代码是否符合设计要求以及编码规范；第二、及时了解程序员在编码过程中遇到的问题，并给以协助，从而达到有效、透明地掌控项目进度的目的；第三、通过代码走查活动，及时了解代码中可以重用的代码，并将其提取为公共方法或模块，提高代码的可重用性以弥补当前人员设计能力不足的现状；代码走查分为两种方式：日常代码走查、定期代码审查
日常代码走查的步骤
一、交叉走查
开发人员提交上线工作单前，需要把文件清单发给组内的其他成员进行交叉走查，开发人员根据走查报告修改代码后才能提交，技术组长对提交的代码进行抽查，如果抽查不通过则退回重新交叉走查。

产出：交叉走查报告（格式同代码走查记录表）
二、代码审核
上线工作单提交给技术组长审批时，技术组长需要判断是否有核心代码修改或数据库表结构变更，如果有则转交给架构组评审，架构组进行核心代码走查后在OA上审批通过
产出：OA工作审批记录和备注
定期代码抽查
部门内部定期（一个月或一个大型项目结束后）对代码进行抽查，总结该阶段内的程序员代码德尔情况，帮助程序员提高代码的质量和能力
产出：代码走查记录表。

代码走查机制代码走查机制是指在软件开发过程中，程序员之间对代码进行反复检查，发现并修复程序中可能存在的错误和问题。

由于代码走查具有及时发现问题、提升代码质量、降低开发成本的优势，一直被广泛应用于软件开发中。

代码走查机制可以有效地提升团队合作，加强团队沟通，避免代码质量问题带来的风险，降低重构成本，并且提升程序员的代码质量。

• 即时发现和解决问题，减少风险通过代码走查机制，可以及时发现代码中的错误、潜在问题，并及时解决，避免其成为软件产品发布后的隐患，从而减少风险。

• 保证代码质量走查机制可以提高开发人员的代码质量意识，对代码的质量进行严格把控，并在追求完美的过程中提高代码的可维护性和可扩展性。

• 降低重构成本在项目开发过程中，如果问题在早期被发现并及时解决，不仅可以避免问题成为系统稳定性的风险，也可以避免在后期项目中因为有大量的代码不合适，需要进行重构的情况发生。

• 提高开发效率代码走查是通过团队合作来完成的，利用走查机制可以相互学习，提供代码探讨。

活跃团队的参与可以让成员更多地学习解决问题和团队合作，从而提高开发效率。

在了解了代码走查机制的好处之后，如何实现代码走查呢？1.明确走查目的和范围定义走查时需要达成的目标和范围，会议的主持可以考虑在会前收集关于该次会议的注意事项和问题列表，让参与者有充分的时间准备，以便提高效率。

2.收集代码收集要走查的代码，代码走查可以包括整个代码库，特定模块或功能区域的代码。

3.分配任务分配走查任务，避免同一个人走查所有的代码。

在分配任务时应该考虑到团队成员的专业和技能，以便发挥各个成员的优势。

4.检查代码检查代码，发现可能存在的问题和错误，并在走查例会中进行讨论和解决。

5.记录问题对于发现的问题和错误，需要进行记录，以便在走查结束后进行跟踪和解决。

6.总结总结走查过程中发现的问题并加以改进。

这包括改进开发流程、增加代码规范和标准、提高程序员技能等。

总之，代码走查机制是在软件开发过程中必不可少的环节，通过走查机制可以提高代码质量，降低风险，包括提高开发效率，让开发人员相互学习，使团队合作更加紧密，从而实现软件开发的目标和要求。