java自定义findbugs规则_findbugs自定义规则并配置实现检测

findbugs不过多介绍了，对于这个主题找了一些资料，没有找到一个完整的介绍，要么是介绍怎么写detector，要么就是没有完整的介绍怎么配置生效，下面主要介绍一下怎么配置其生效，至于怎么写这个detector还是有很多资料说明的，不过在些也重复一下。

一、自定义detector

1 ForbidSystemOutClass检测类

packagecom.test.findbugs;importorg.apache.bcel.classfile.Code;importedu.umd.cs.findbugs.BugInstance;importedu.umd.cs.findbugs.BugReporter;importedu.umd.cs.findbugs.bcel.OpcodeStackDetector;public class ForbidSystemOutClass extendsOpcodeStackDetector {privateBugReporter bugReporter;publicForbidSystemOutClass(BugReporter bugReporter) {this.bugReporter =bugReporter;

}

@Overridepublic voidvisit(Code obj) {super.visit(obj);

}

@Overridepublic void sawOpcode(intseen) {if (seen ==GETSTATIC) {if ("java/lang/System".equals(getClassConstantOperand())&& ("out".equals(getNameConstantOperand()) || "error".equals(getNameConstantOperand()))) {

bugReporter.reportBug(new BugInstance("SYSTEM_OUT_ERROR", HIGH_PRIORITY)

.addClassAndMethod(this).addSourceLine(this));

}

}

}

}

View Code

参考：http://blog.csdn.net/franklies/article/details/6830534

https://www.ibm.com/developerworks/cn/java/j-findbug2/

至于里面的一些相关逻辑不在此探讨之内；

2 findbugs.xml

View Code

3 messages.xml

detector decription]]>

short decription

long decription

System.out can't be released, you must delete it.]]>

System.out can't allow

View Code

参考：http://www.warski.org/staticaccess.html，这两个xml文件直接是从这个开源工程里面拿出来修改的

自定义检测规则主要有这三个步骤，写完这三个，剩下的工作就是编译配置；

二、编译配置

主要是编写ant脚本

Builds the Systemout Checker.

View Code

使用ant命令：

ant dist

编译过程如下：

在ant配置脚本中已经默认把生成的testFindBugs.jar包放到findbugs安装目录里面的plugin中，对于自定义的规则，打成jar包后，放在这个plugin目录就会自动生效，而不是像网上介绍的那样放在findbugs.jar包中。

三、检测

Builds the Systemout Checker.

View Code

使用ant命令：

ant findbugs

过程如下：

ok了，可以在工程的bin目录下，看到findbugs检测生成的结果findbugs_result.xml文件，至此整个过程结束，以上只上讲解了一个配置及过程，至于findbugs规则的具体编写以及findbugs.xml、message.xml里面的每个符号代表的意思没有涉及，向findbugs迈出了一步，接下来还是需要更多的时间摸索。

另外怎么在eclipse的插件中配置自定义的规则还是个问题，试过，可以把规则加进来，但检测的时候却没有生效，目前还没有找到原因。

附上demo：

右键保存这张图片到本地，然后把扩展名改成zip，解压就OK了。