【详细教程】sonarQube的自定义规则开发

时间:2024-03-23 12:36:09

sonar自定义规则开发,实际上是对sonar的官方JAR包里面的方法进行重写,然后添加自己定义的规则。

sonar提供的XPath Java的方式的扩展,有的语言支持的XPath ,有的只能支持Java的,比如Java的语言只支持Java的方式的扩展。具体详见通过语言自定义规则的支持

【详细教程】sonarQube的自定义规则开发

一,下载官方的示例演示

下载地址:https//github.com/SonarSource/sonar-custom-rules-examples

导入后可见下图目录结构:

【详细教程】sonarQube的自定义规则开发

第①部分,我们主要用到RulesList.java文件,当我们写完规则后,需要在RulesList.java中添加对应规则的类类进行注册具体如下:

 

第②部分,存放我们对应的规则文件。

第③部分,存放编写规则的示例页面的文件,如需修改文件存放位置,则需修改①中的MyJavaRulesDefinition.java类,规则示例文件的命名需要和规则的关键值相同加上默认_JAVA后缀,后缀也可进行修改。

 

第④部分存放的是规则测试类存放地址

二,规则书写

2.1常用的重写方法

  • visitClass

visitClass方法主要是对类进行规则时使用,通过ClassTree可以得到类相关的属性。一般来说,我们根据它获取到扫描文件的类名。

 

  • visitMethod

visitMethod方法主要是对类里面的方法进行规则,常用的有对方法名进行规则,对方法是否抛出异常进行规则

 

  • visitVariable

visitVariable方法是对变量进行规则,常用的有对变量的修饰符,名称进行规则。

 

  • visitMethodInvocation

visitMethodInvocation方法是指对类中调用方法进行规则,通过它可以对项目中禁止使用的方法进行检测,对调用的方法进行检测。

 

2.2规则示例

@ControllerMethod注解的值与对应的方法名相同

【详细教程】sonarQube的自定义规则开发

该规则中,首先我们先得到它的方法名。

【详细教程】sonarQube的自定义规则开发

其次,通过重写visitAnnocation方法,在AnnotationTree中判断该注解是否是ControllerMethod,若是,则设定一个开关。

【详细教程】sonarQube的自定义规则开发

    最后,通过上面的开关取得ControllerMethod注解的值,然后对方法名进行判断。

2.3书写技巧

    ①一个规则不一定只重写一个方法,有时可能需要几个重写方法共同完成

    ②当我们不知道所需定义规则的代码属于哪一部分时,我们可以采用调试模式,在树中,找到我们需要的值,然后对该值所属的树进行重写。

2.4注意事项

    ①在写自定义规则时,尽量不要写树之间的强制转换,避免规则不生效

    ②在使用汉字进行提醒时,汉字尽量采用的unicode编码,避免在页面显示乱码

三,使用Maven的发布成JAR包

在本地找到项目对应的目录在有pom.xml中的文件夹中,打开命令窗口

使用mvn clean package sonar-packaging:sonar-plugin

四,使用流程

4.1如何在sonar中使用

将jar放入sonarqube安装目录的\ extensions \ plugins下

 

 

4.2重启sonarqube

找到自己定义的规则,进行**使用。

4.3 Eclipse上使用自定义sonar

  1. Eclipse的上连接SouarQube服务器(若已连接则更新规则)
  2. 绑定项目
  3. 使用sonar扫描

 

第一篇博客,大家简单看一下,有不懂的也可以问我