Findbug使用指南.docx

Findbug 使用指南 Findbug 是一个开源的 Eclipse 代码检查工具，能够简单高效全面地帮助我们发现程序代码中存在的 bug、bad smell 以及潜在隐患。它提供了简单的修改意见供我们重构时进行参考，通过使用它，可以一定程度上降低我们 code review 的工作量，并且会提高 review 效率。通过 findbugs 找到 bug，再由我们自己重构代码，可以培养我们的编码意识及水平，形成好的习惯提高开发编码能力。 Findbug 安装步骤： 1. 点击“Help->Install New Software”，然后点击“Add”，输入“findBugs”和“http://findbugs.cs.umd.edu/eclipse”，点击“OK”。 2. 选择对应插件，然后点击“next->next->finish”。 3. 完成安装之后重启 eclipse，右击项目文件或目录，会发现多了 Findbugs 的菜单。 Findbug 使用步骤： 1. 在 eclipse package Explorer 右键选择目标工程-> build project。 2. 选择指定的包或者类进行 findbug。 3. Findbugs 会遍历指定的包或者类，进行分析，找出代码 bug，然后集中显示在 find bugs 的 bugs explorer 中。 4. 添加 findbugs explorer（eclipse 左下角）。 5. 在 bugs explorer 中查看找到的 bug，可以双击 bug 项目就可以在右边编辑窗口自动打开相关代码文件并连接到代码片段。 Findbugs 错误修改指南： 1. EC_UNRELATED_TYPES Bug：调用 equals() 方法比较不同类型的对象，解决方法是应该改为 str.toString()。 2. IM_BAD_CHECK_FOR_ODD Bug：检查奇数的方法，不适用于负数，解决方法是考虑使用 x & 1 == 1 或者 x % 2 != 0。 3. NP_ALWAYS_NULL Pattern：空指针解引用，解决方法是检查代码中的空指针。 4. RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE Bug：多余的 null 检查，解决方法是删除多余的 null 检查。 Findbugs 的优点： * 能够简单高效全面地帮助我们发现程序代码中存在的 bug、bad smell 以及潜在隐患。 * 提供了简单的修改意见供我们重构时进行参考。 * 可以一定程度上降低我们 code review 的工作量，并且会提高 review 效率。 * 通过 findbugs 找到 bug，再由我们自己重构代码，可以培养我们的编码意识及水平，形成好的习惯提高开发编码能力。 Findbugs 的应用场景： * 代码 review：Findbugs 可以帮助我们发现代码中的 bug 和潜在隐患，提高 code review 的效率。 * 代码优化：Findbugs 可以帮助我们发现代码中的 bad smell 和潜在隐患，提高代码的质量。 * 编码实践：Findbugs 可以帮助我们养成良好的编码习惯，提高开发编码能力。 Findbugs 是一个非常有用的代码检查工具，它可以帮助我们发现代码中的 bug 和潜在隐患，提高代码 review 的效率，提高代码的质量，养成良好的编码习惯，提高开发编码能力。