用Eclipse自带插件创建自定义findbugs检测器.doc

用Eclipse自带插件创建findbugs的检测器 1.准备工作 1.1.为Eclipse安装插件 插件1：ByteCode下载地址：http://andrei.gmxhome.de/eclipse/ 用法：在Eclipse菜单栏上单击windows-show view-other…-Java-Bytecode即可打开Bytecode窗口，方便查看当前文件的字节码，效果如图1所示。 图1 插件2：Findbugs下载地址：/eclipse 用法：在Eclipse菜单栏上单击windows-show view-other…-Findbugs-Bug Explorer即可打开Bug Explorer窗口，进入Findbugs浏览状态，效果如图2所示。 图2 1.2.以下操作需要用的软件（可选） 为了操作方便，建议使用winRAR用来打开jar文件；使用Notepad++打开xml文件 2.创建自己的Findbugs检测器 2.1.编写自定义的检测器Detector 项目中需要引入Findbugs的jar文件：findbugs.jar 自定义的检测器需要继承OpcodeStackDetector，重写其sawOpcode方法。下面这个检查器Detector用来查找项目中有没有System.out和System.error情况出现。 package edu.umd.cs.findbugs.detect; import org.apache.bcel.classfile.Code; import edu.umd.cs.findbugs.BugInstance; import edu.umd.cs.findbugs.BugReporter; import edu.umd.cs.findbugs.bcel.OpcodeStackDetector; /** * @author 判断System.out和System.error这种情况 */ public class ForbiddenSystemOutClass extends OpcodeStackDetector { BugReporter bugReporter; public ForbiddenSystemOutClass(BugReporter bugReporter) { this.bugReporter = bugReporter; } /** * visit方法，在每次进入字节码方法的时候调用 在每次进入新方法的时候清空标志位 */ @Override public void visit(Code obj) { super.visit(obj); } /** * 每扫描一条字节码就会进入sawOpcode方法 * * @param seen 字节码的枚举值 */ @Override public void sawOpcode(int seen) { if (seen == GETSTATIC) { if (getClassConstantOperand().equals(java/lang/System)// get class mapping (getNameConstantOperand().equals(out) // get static field mapping || getNameConstantOperand().equals(err))) { BugInstance bug = new BugInstance(this, CHECK_SYSTEMCLASS, NORMAL_PRIORITY).addClassAndMethod(this).addSourceLine( this, getPC()); bug.addInt(getPC()); bugReporter.reportBug(bug); } } } } 文件1：自定义检测器ForbiddenSystemOutClass.java 接下来找到Eclipse编译的ForbiddenSystemOutClass.class文件，一般在项目的lib目录里可以找到。将其放入findbugs-plugin.jar文件中对应的目录下。 2.2.修改findbugs.xml文件 找到Eclipse插件安装文件夹中findbugs-plugin.jar所在的文件夹，我的文件夹是F:\eclipse\plugins\edu.umd.cs.findbugs.plugin.eclipse_0111221双击打开findbugs-plugin.jar文件，找到其中的fi