如何精细化管理代码质量？
背景与范围
代码是工程师与硬件机器交流的语言。和人类语言交流一样，表达一个相同的意思可以用很多不同的方法。哪一种表达的方法更好呢？对于代码而言，大概有三个方面的内容。第一个方面是看起来如何，第二个方面是分析起来如何，第三个方面是运行起来如何。前面两个方面的内容属于代码的静态质量问题，最后一个方面属于代码的动态质量问题。总之，静态的代码质量问题包括：抒写风格、逻辑规则、静态分析等等；动态的代码质量问题包括代码的单元测试，
性能测试等等。
方法与困难
在
编码阶段的一个迭代周期中,开发人员需要完成的过程如统一编码规范、单元测试、代码评审、重构、持续集成、代码分析等等。报怨代码的质量问题是毫无用处的,解决代码质量的问题，唯一有效的办法就是行动起来,严格的进行代码审查过程.常见的方法是小组的领导人，带领团队人员定期的抽查部分代码，进行校正，从而达到其它成员参考的作用。在这一过程中使用自动化的检测工具，可以代替部分人工的功能。团队成员坚持不断地执行代码审查，使所有的工程师形成良好的编码
习惯，不断提高编程能力，从而提高软件产品的代码质量。但是这个过程需要大量的时间和人力的成本。
代码风格是代码审查的最基本的内容。在代码审查过程中，逐条针对代码风格的定义进行审查，核对。每个公司都有自己对代码的通用风格定义，也有自己的特殊风格定义。比如公司版权，属性名、
注释等等。尽管公司有严格定义，但是却难以执行。
代码的逻辑规则以及潜在的缺陷是代码重大缺陷审查的主要内容.这些问题一般在测试过程中难以
发现,或者需要花费大量的精力才能发现.所以在代码审查的过程中提前发现,提前解决.这些问题种类繁多,需要大量的
编程经验才能发现.例如空对象的处理问题；捕获Runtime类型的
异常问题等等；所以在执行代码审查的过程中需要花费大量的时间和人力成本。
代码审查还有一个更加重要，并且更加困难的部分就是对系统设计方面的审查。优秀的代码不仅需要遵循代码的风格、逻辑的规则，而且需要优秀的代码结构和高效的性能。拙劣的设计，往往伴随着代码冗余、逻辑混乱、效率低下。比起经验欠缺的工程师，优秀的工程师可能会使用更少量的代码完成更为复杂的功能。例如初级的工程师经常使用大量的if-else去实现逻辑的判断，而经验丰富的工程师会使用
设计模式去解决这样的问题；再如经验丰富的工程师善于使用简捷的
算法去解决一些看似复杂的问题，而初级的工程师往往使用非常复杂的逻辑来处理等等。
解决方案
代码审查可以解决代码质量的大部分问题，但是人工检测比较费时费力，所以我们需要一种自动化的方案。市场上也一些工具辅助执行，例如 jindent、checkstyle、pmd、Jtest、jfindbugs等等。jinent、checkstyle主要解决代码的书写格式的问题；pmd主要解决代码的一些逻辑规则的问题；jtest、findbugs主要解决了代码的分析问题可以检测很多代码中存在的潜在bug。这些工具存在一些缺点，一个方面需要我们在开发中安装多种工具，以解决不同的问题。 另一个方面是均不能很好的自动的优化我们的代码，检测出来的问题需要我们去分析才能解决，这个将花费我们很多的精力。再有一个方面是我们
自定义的扩展功能不强。
针对上面这些问题，我们推出了一款可编程的代码自动分析工具---JRULER精细化代码质量
管理工具。JRULER内置了一种标准化代码的编写风格和逻辑规则、以及代码分析功能的
脚本编程语言.可以自动检测、并且可以自动优化开发人员生产的代码，从而把优秀的编程技术和经验
积累下来。我们只要将开发人员的代码通过我们系统检测，就可以自动的优化源码在编写风格上面的缺陷，以及大量积累的良好编程经验，也可以检测代码中潜在的问题。大概80%的问题可以自动的优化，对不能自动优化的部分，会生成报告,然后提交给相应的工程师去解决。从而大大降低管理成本，有效的提高了公司软件的代码质量，并且使所有开发人员生产的代码达到统一的标准。
总结JRULER产品的特点：
1，书写格式功能，可以自动的优化代码的书写格式，包括空格、换行、注释等等。
2，逻辑规则功能，可以自动的检测代码的逻辑规则，并且可以自动的进行优化。
4，自动的报告生成功能。系统可以根据脚本的执行情况，决定是否产生检测结果的报告。
5，自动的代码优化功能。系统检测出来的报告，脚本可以自动化的优化问题，对可以自动
优化了的问题，就不再产生报告了。
3，可编程功能， 代码的检测和优化均通过脚本编程的方式实现，可编程的检测可以达
到灵活的自定义效果。工程师根据自己编程的经验，将优秀的编程习惯通过脚本固化下
来。从而达到，积累优秀编程经验的目的。
网站地址：www.jruler.com
资源下载：www.jruler.com/downloads/plugins_v2.0.zip
插件连接：www.jruler.com/downloads/plugins_v2.0.feature
脚本
例子
1、如何检测类名命名规则
/**
* 如何检测类名命名规则
*/
#include "java.h"
string getClassName(token tk);
string checkClassNaming() hooks tk : @"CLS" {
if(tk == null) return null;
string cls_name=getClassName(tk);
if(cls_name == null) {
return null;
}
boolean b=regMatch(cls_name, "[A-Z][a-zA-Z]+");
if(!b) {
return "
class name is not suitable.";
}
}
string getClassName(token tk){
token [] tkList = tk.childs;
var i=0;
while(i<tkList.length) {
token ttk=tkList[i];
string s = toString(ttk.values);
if(s=="class") {
break;
}
i=i+1;
}
if(i<tkList.length) {
token tkCName = tkList[i+1];
return toString(tkCName.values);
}
return null;
}
[/size][size=medium][/size][size=large]
相关文章
