java - 如何审计 Java EE 项目？

Question

我必须审核一个基于 JSF/CDI/EJB3.0/JPA 的 Java EE Web 项目的代码架构质量和可维护性(最终确保我们物有所值)(仅举几例)所涉及的技术)。

这可能不适合提问，但您如何处理此类任务？基本上，我会从粗粒度到细粒度，即从整个架构到 Java 代码。把每一层都处理完是不是更好？我应该花更多时间在低层上吗？

您是否评估整个过程(构建、部署、测试)？

Answer 1

在较低的物理/实现层面，我喜欢做的是采用 maven 作为构建工具，然后配置广泛的 maven 报告，以生成一个充满各种代码指标的网站。

• 对于初学者来说，有 maven checkstyle plugin它可以报告代码与指定标准的一致性，编码标准的一致性有很多明显的好处，大多数项目只会采用一种预先配置的标准，例如太阳或 Apache 。
• findbugs plugin列出潜在的编程错误
• 可以选择代码覆盖率报告，我用过cobertura .这些在应用程序中逐行显示单元测试涵盖了哪些部分。 Maven 支持构建生命周期中的单元测试，将它们作为构建的一部分运行。这救了我几次。
• PMD plugin识别重复代码，并突出显示可能需要重构的区域。

一旦设置好并成为正常构建周期的一部分，它基本上会自行处理，您不必担心进行大型的双年度审计/追赶。

许多报告都有阈值限制，可以将其配置为在违反构建时失败，即超过 n% 的检查样式错误会导致构建失败。

Maven 还促进了构建应用程序的模块化方法，这导致更小的更易于理解和可重用的模块，以及关注点分离，即表示层和持久层的独立模块。 maven 提供的主要好处是管理模块之间的相互依赖关系。

虽然这在更高级别的架构层上对您没有太大帮助，因此需要一种补充方法来涵盖该维度。

在此链接中查看一些示例报告
http://maven.apache.org/plugins/maven-dependency-plugin/project-reports.html