目录:
1.入门
2.官方代码导入IDEA
3.修复官方代码报错问题
4.了解代码结构
5.开发规则
6.将开发的规则导入到sonar平台
7.使用开发的规则进行代码检测
8.结束
入门:
想要开发规则可以依靠 SonarQube Java插件API。为了高效地开始工作,可以直接使用一个空的模板maven项目(当然也可以直接新建一个maven项目从零开始),地址:https: //github.com/SonarSource/sonar-custom-rules-examples/tree/master/java-custom-rules
该项目已经包含一些规则,目前要做的是添加自己想要的规则。
官方代码导入IDEA
进入上面的地址,导出项目或者下载相关代码本地解压,导入到IDEA中,可以选择你要编写规则的相应的语言,我要Java的所有只在IDEA中打开了java-custom-rules,如下图
修复官方代码报错问题
导入成功后,MyJavaRulesDefinition类会有一个依赖包导入不了,Java.KEY显示的是红色的,这个时候的解决办法是:进入pom.xml文件,将<type>sonar-plugin</type>注释掉即可(将下图改成下下图)。官方下载的会有上面的这个问题。
紧接着先了解下官方代码的结构,然后在了解了结构的基础上进行规则开发。