编写SonarQube自定义Java和Xml规则

最新推荐文章于 2025-05-31 01:00:00 发布
转载 最新推荐文章于 2025-05-31 01:00:00 发布 · 2.1k 阅读 · 7 ·
CC 4.0 BY-SA版权
原文链接：https://segmentfault.com/a/1190000009744795
文章标签：

#java #测试 #运维

本文介绍了如何在SonarQube中编写自定义的Java和Xml规则，包括基本思路、开发环境、编写方法、编译打包、测试以及总结。通过下载官方规则插件，使用Java类或XPath表达式实现自定义规则，然后编译打包并上传到SonarQube。文章还提供了单元测试和手工测试的方法。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

因为工作需要最近接触到了SonarQube，需要根据项目自定义Java和Xml规则，由于国内的资料实在是比较少，并且官网的资料全是英文的，看起来实在是头疼，所以希望写点资料能够帮助到其他人。
官网地址：https://www.sonarqube.org
在此感谢hu_qingen (古月随笔) 和 冯澍雨 提供的帮助

基本思路

1、下载官方提供的规则插件包
2、根据需求编写规则类
3、编译打包
4、上传自定义规则插件

下载地址：
1、Java自定义规则插件:
https://github.com/SonarSourc...

2、Xml自定义规则插件：
https://sonarsource.bintray.c...

开发环境

JDK1.8以上
Mavean
Jenkins

编写方法

目前SonarQube自定义规则支持的方式有两种： 编写java类和编写XPath表达式，这两种方式都是基于AST（Abstract Syntax Tree抽象语法树）语法结构来实现的。
1、Xpath方式
需求：
从Java代码中查找是否存在 while {}这种语法结构

表达式代码：
//WhileState

最低0.47元/天 解锁文章

200万优质内容无限畅学
【云原生技术】 Windows 下按照上述步骤创建和部署 SonarQube 自定义规则
weixin_46453070的博客
06-08 759
可以在 Windows 下按照上述步骤创建和部署 SonarQube 自定义规则。以下是一些具体的操作建议： 在 Windows 下创建自定义规则的步骤 安装工具： 确保您安装了 JDK（Java Development Kit），建议使用 JDK 11 或更新版本。 安装 Maven（如果使用 Maven 进行构建）并配置系统环境变量。
自定义SonarQube Java规则
程军高的专栏
11-06 2844
重写Sonar PMD插件定义我们自己的Java代码扫描规则
sonar自定义规则
weixin_34114823的博客
03-11 1886
Sonar并不是简单地把不同的代码检查工具结果（例如 FindBugs，PMD 等）直接显示在 Web 页面上，而是通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。 sonarqubue默认的对java的检测规则不一定适合我们，可以自己去自定义rules。 禁...
【详细教程】sonarQube的自定义规则开发
热门推荐
冰糖柠檬雪梨茶的博客
08-30 1万+
sonar自定义规则开发，实际上是对sonar的官方JAR包里面的方法进行重写，然后添加自己定义的规则。 sonar提供的XPath 或Java的方式的扩展，有的语言支持的XPath ，有的只能支持Java的，比如Java的语言只支持Java的方式的扩展。具体详见通过语言自定义规则的支持 一，下载官方的示例演示 下载地址：https：//github.com/SonarSource/so...
二、SonarQube自定义规则
chenze的博客
07-25 3427
一、介绍   不可避免的，在实际的开发中sonar提供的官方的代码检测经常不满足我们的要求，比如如下代码： /** * 以下代码sonar会认证name和age是从来没有使用过的，它不认识lombok的注解 */ @lombok.Data public class SonarDto implements Serializable { private static final long serialVersionUID = -8224351388102104833L; priva
【亲测免费】 SonarQube 自定义规则示例教程
gitblog_00208的博客
08-21 1292
SonarQube 自定义规则示例教程 项目介绍 SonarQube 是一个用于代码质量管理的开源平台，通过插件机制可以支持多种编程语言的代码质量分析。sonar-custom-rules-examples 项目是由 SonarSource 提供的，旨在帮助开发者创建和部署自定义的代码分析规则。该项目包含了多种编程语言的示例规则，如 Java、Python 等，以及详细的文档和教程，帮助开发者理解...
【云原生技术】写一条自定义 SonarJava 规则 这个需要怎么写？
最新发布
weixin_46453070的博客
05-31 895
下面给出一条「从零开始」编写、打包并在 SonarQube 中启用 **自定义 SonarJava 规则**的完整示例，专门拦截 `BigDecimal.valueOf(double|float)`。 ──────────────────────────── 一、准备工作 ──────────────────────────── 1. 环境 • JDK 8 或以上      (与 SonarQube Server 兼容即可) • Maven 3.6+        (推荐)
Sonar实现自定义Java扫描规则
Sweet77
01-27 1855
下载官方提供的模板：https://github.com/SonarSource/sonar-java.git 参考官方链接：https://github.com/SonarSource/sonar-java/blob/master/docs/CUSTOM_RULES_101.md 教程 关于pom.xml： 我们根据SonarQube的版本来选择对应的pom文件，我使用的SonarQube版本是8.9 LTS。 初始化工程之后我们根据教程来一步一步填充模板后，打包。 我在这一步遇到的问题是：打出的jar在
sonarqube自定义规则
l1477026345的博客
11-29 823
比如这两个词 startIndex,endIndex,开始的下标,结束的下标,两个值的差值是token、firstToken().text()的长度,那么这个下标用在了哪里，怎么用？if(tree.kind().equals(Kind))或者tree.is(Kind...)判断tree代表的代码段是不是对应的情形。有以上的发现，加上一些其他的网络资料，有一个设想，token是在文件中读出来的字符串是可以根据下标在某个字符串中截取的。看了以前的代码,通过断点调试,方法中的tree参数用处大多是这样;
SonarQube配置自定义的CheckStyle代码规则
cspecialy的博客
04-25 1万+
对于自定义的CheckStyle代码规则如何配置到SonarQube？网上找了很久，也没找到多少有用的信息，没办法，自己撸吧。一通撸下来发现，其实挺简单 (⊙▽⊙) 惯例第一步肯定是SonarQube的安装与运行配置了，但这部分不在本文主题内，网上一搜一大把，这里就不讲了，大家可以先看这篇文章：SonarQube的安装、配置与使用 。我们直接讲自定义CheckStyle代码规则的配置方法。 ...
sonar-java-custom-rules.zip
05-26
sonar自定义java代码检测
sonarQube的自定义规则开发【详细教程】
q1335882的专栏
07-02 1万+
官网Demo演示插件开发地址: https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101 基于官网的我暂时不多说，基础框架按照官网的范例进行搭建即可 #开源地址: https://github.com/tigerge000/sonar-java-custom-rules.git sonar常用方法说明 范...
SonarQube 7.8自定义规则插件教程
ygy1988的专栏
03-13 3617
网上教程参差不齐，到处copy，各种坑。另外SonarQube源码里面的demo都是最新版本的，不适用旧版的开发教程，当前7.8的版本已经用了好久，换新版本也不值当。所有只能自己捣鼓。在自己折腾一天后，结合网上教程和SonarQube的源码，决定把完整的过程写下来，以免后人捉急当前的要求是，不允许开发随便修改对外公共接口的任何属性，包括参数名，参数类型，方法名，返回类型，修饰符。所以就定义一个注解，假设注解名称叫@check，该注解中有个属性叫checkToken。
SonarQube插件开发自定义规则(2)常用api-扫描java文本内容
祈雨v的博客
10-03 5239
1、文本式读取被扫描java文件public class TXTestCheck extends BaseTreeVisitor implements JavaFileScanner { public void scanFile(JavaFileScannerContext context) { scan(context.getTree()); visitFi
SonarQube插件开发自定义规则(6)注意事项
祈雨v的博客
10-03 1914
1、单例模式所有的规则类都是单例模式，所以规则类中最好不要有成员变量。若无法避免时，则必须在节点扫描前清空成员变量的数据。例如private List<String> methodNameList = new ArrayList<String>(); private List<VariableTree> variableTreeList = new ArrayList<VariableTree>()
【亲测免费】 《SonarQube 自定义规则示例项目》常见问题解决方案
gitblog_00506的博客
12-17 490
《SonarQube 自定义规则示例项目》常见问题解决方案 1. 项目基础介绍及主要编程语言 《SonarQube 自定义规则示例项目》是一个开源项目，旨在帮助开发者理解和学习如何为SonarQube编写自定义规则。通过这个项目，开发者可以学习如何创建和部署用于代码质量分析的插件。该项目主要使用Java编程语言开发，同时也涉及一些JavaScript和Python代码，用于展示如何针对不同编程语言...
sonarqube代码规则配置
u010680986的博客
01-29 9714
1.进入sonarqube质量配置页面，选择某一语言，点击右侧设置按钮，选择复制 2.输入名称后，点击复制，进入配置页面 3.点击修改项目，可以选择当前已存在的项目，直接应用到该项目中 PS： 1.修改当前项目配置的缺陷严重程度：可以选择某个bug，进入后在bug详情的质量配置中，点击修改进行严重级别修改，修改后保存即可应用。 2.挂起或激活规则：进入项目的质量配置页面，选择对应的问题，点击挂起后，该规则失效 ...
SonarQube Java自定义规则扩展工具开发
通过这份压缩包内的文件，可以获取到SonarQube自定义Java规则扩展工具的具体实现代码，学习如何通过编程扩展SonarQube的功能，以及如何为Java项目创建和管理自定义的静态代码分析规则。这对于希望深化对代码质量分析...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值