由于个人编码习惯和对细节的忽略,导致我们编写的代码非常不规范并且伴随着一些隐藏的问题。虽然这些问题在短时间内并不会影响我们的系统,
但是人员随着人员变化,时间推移,代码量的逐渐增加,这些问题就会暴露出来。所以必须要有一个良好的代码质量管理来约束我们。
代码质量管理会带来一下好处:
1. 避免一些bug 和 漏洞,增强代码的可读性,统一风格
2. 便于维护和扩展
对应代码质量,有一些约定的定义:
代码类型:
BUG : Bug是出现了明显错误或是高度近似期望之外行为的代码。
漏洞 : 漏洞是指代码中可能出现被黑客利用的潜在风险点。
坏味道: 代码异味会困扰代码的维护者并降低他们的开发效率。主要的衡量标准是修复它们所需的时间
代码严重程度:
Blocking: 即系统无法执行、崩溃或严重资源不足、应用模块无法启动或异常退出、无法测试、造成系统不稳定。如 严重的数值计算错误
Critical: 即影响系统功能或操作,主要功能存在严重缺陷,但不会影响到系统稳定性。 如 系统刷新错误
Major: 即界面、性能缺陷、兼容性
minor:即易用性及建议性问题。
其实开发过程中,由于有测试的参与,所以bug 和 漏洞是我们必须要去发现和处理的。但是坏味道就很容易被忽略,而这恰恰是造成代码后期出现莫名错误和难以维护的主要原因。
目前比较流行的代码质量管理平台是sonar
Sonar 是一个用于代码质量管理的开放平台。通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具。
与持续集成工具(例如 Hudson/Jenkins 等)不同,Sonar 并不是简单地把不同的代码检查工具结果(例如 FindBugs,PMD 等)直接显示在 Web 页面上,而是通过不同的插件对这些结果进行再加工处理,通过量化的方式度量代码质量的变化,从而可以方便地对不同规模和种类的工程进行代码质量管理。
sonar 中有很多代码规则,这个是检测代码质量的依据,目前比较流行的代码静态分析工具:
pmd:基于源代码分析,主要面向安全编码规则,如“避免声明同名变量”,包括风格类、类型使用等等,具备一定的数据流分析和路径分析能力。
checkstyle:基于源代码,与pmd类似,但更侧重编码的语法风格,分析深度不及pmd。
findbugs:基于字节码分析,大量使用数据流分析技术,侧重运行时错误检测,如空指针引用等,分析深度大于前述两个。
p3c : alibaba 的代码分析工具
sonar 作为平台是可以集成这些静态分析工具的,当然也可以自定义规则。