Sonar实现自定义Java扫描规则

已于 2022-01-28 15:03:26 修改
阅读量1.7k 收藏 3
点赞数
文章标签： java jar 开发语言
于 2022-01-27 14:42:33 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_40927436/article/details/122717508
版权
本文档介绍了如何使用SonarQube实现自定义Java扫描规则。首先，从GitHub下载官方模板，并参照提供的教程进行操作。重点在于调整pom.xml文件，以确保SonarQube 8.9 LTS版本的兼容性。在打包过程中，由于未将Resources目录下的资源包含进jar，导致启动SonarQube时报错。解决办法是在pom.xml中添加打包参数，确保资源文件正确打包。
摘要由CSDN通过智能技术生成

下载官方提供的模板：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在放入$SONAR_HOME/extensions/plugins后启动SonarQube报错：

java.lang.IllegalStateException: Can’t read resource: org/sonar/l10n/java/rules/java/

这是因为打包时没有将Resources路径下的资源打入jar包导致根目录中不存在该路径。
在pom.xml增加打包参数即可：

<!--打包时将resource下的文件一起打包-->
最低0.47元/天 解锁文章
绿头龙
关注
SonarQube扫描代码规则设置
万物皆可学
06-29 2293
使用内置代码规则扫描和自定义代码规则后。
【项目实战】自定义设置Sonar的规则，要求DevOps工具链SonarQube只扫描指定模块
本本本添哥
04-21 2323
开发微服务项目，很多会基于网络上现成开源的微服务框架进行二开，公司有单元测试覆盖率的要求，往往会使用SonarQube 来实现扫描代码的单元测试覆盖率，但是因为网络上现成开源的微服务框架很大部分是已经现成的代码，因此补充单元测试工作会很痛苦，于是，可以自定义设置Sonar的规则，要求SonarQube 只扫描指定模块。
利用Sonar定制自定义扫描规则
weixin_30436101的博客
04-15 1596
上有3种方法可以自定义soanr的代码校验规则： 直接在sonar的web接口中增加XPath规则； 通过插件的功能来增加自定义规则，比如checkstyle，pmd等插件是允许自定义规则的； 通过新增一个代码分析器来实现自定义规则； sonar官方推荐的方式是使用最简单的XPath方式来增加自定义规则，如果语言太复杂或者XPath无法查询其结构的，再使用自定义...
在SonarQube上使用java自定义JavaScript检测规则
08-21
网上使用java开发sonarqube的检测规则的文档很少，本文档较为详细描述了JavaScript扩展的开发过程。
SonarJava：Java代码质量与安全性的守护者
gitblog_00314的博客
09-28 494
SonarJava：Java代码质量与安全性的守护者 sonar-java :coffee: SonarSource Static Analyzer for Java Code Quality and Security 项目地址:...
sonar自定义规则
weixin_34114823的博客
03-11 1779
Sonar并不是简单地把不同的代码检查工具结果（例如 FindBugs，PMD 等）直接显示在 Web 页面上，而是通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。 sonarqubue默认的对java的检测规则不一定适合我们，可以自己去自定义rules。 禁...
sonar-java 自定义规则
fenglllle的博客
02-18 2302
最近在搞代码质量方面的项目，主要是针对Java语言，其他语言实际上也可以执行检查，核心原理是一样的，都是静态代码扫描，如果需要进行动态代码运行验证则可以通过单元测试的方式。以其中一个示例，实现自定义Java sonar规则。实际上这个很简单，如果需要考虑，那么需要考虑扫描算法怎么写，性能是否OK，毕竟一般执行扫描都是在代码编译打包的过程，本地很少单独执行扫描。
利用Sonar定制自定义JS扫描规则（一）——sonar环境搭建
weixin_30402085的博客
09-14 694
接触sonar已经有段时间了，最早是在一个项目组里面听到这个框架，后来在公司持续集成活动的推动下，也逐渐学习了sonar的具体功能。sonar集成了findbugs，pmd，checkstyle各种静态代码检查工具的功能，并且可以将各种扫描结果组合成一张张漂亮的报告，功能很是强大。下面介绍一下如何使用sonar来自定义javascrpit的扫描规则。 虽然使用过很多次sonar，但都是在别人搭...
SonarQube插件开发自定义规则(2)常用api-扫描java文本内容
祈雨v的博客
10-03 5098
1、文本式读取被扫描java文件public class TXTestCheck extends BaseTreeVisitor implements JavaFileScanner { public void scanFile(JavaFileScannerContext context) { scan(context.getTree()); visitFi
sonar自定义规则c语言,sonar自定义规则笔记
weixin_28858229的博客
05-23 773
对于sonar的安装，笔记并未做相关记录，原因很简单，百度一下你就知道；笔记着重自定义规则开发，个人也是慢慢摸索，一路坎坷，接下来一点点分享，欢迎各路大神批评指正：1.针对于sonarqube的自定义规则开发，这边是通过IDEA来搭建的环境，对于源码阅读比较舒服。2.从官方下载了自定义规则的demo，这也就可以开始玩起来。结构树如图：image.png该类实现了接口Pluginimage.png那...
自定义SonarQube Java规则
程军高的专栏
11-06 2659
重写Sonar PMD插件定义我们自己的Java代码扫描规则
sonar自定义规则c语言,深入了解 sonar 自定义规则开发 (入门强烈推荐)
weixin_39681171的博客
05-23 1171
前言前一段时间(很久之前了????)弄了 sonarQube 以及如何开发自定义规则，在之前一直也没有去接触过。于是兴致勃勃的到网上一顿搜索的骚操作，本地的 sonarQube 就搭建好了，并且通过 sonar 自带的规则扫描自己的项目发现了一些问题。就在我准备更进一步去学习如何进行自定义规则开发的时候，碰坑了。。。在网上查了很多关于 sonar 自定义规则开发的资料，其内容都大同小异，介绍如何搭建 s...
添加sonarqube插件并自定义规则.docx
10-31
sonarqube上安装插件并自定义扫描规则的详细方法说明文档,详细说明Checkstyle和FindBugs插件的配置方法
SonarLint 默认扫描规则
jiaomubai的博客
05-20 9842
在平时写代码的时候，为了代码规范和减少 bug 的数量，使用 SonarLint 插件进行代码检查无疑是一个很好的方法。Sonar 是一个用于代码质量管理的开源平台，用来管理源代码的质量，通过插件的形式支持包括 Java、C++、C语言等多种编程语言的代码质量管理与检测。 Sonar 从以下七个维度来进行代码质量的检测： 不遵循代码标准：Sonar 可以通过 PMD、CheckStyle、Findbugs 等代码规则检测工具来规范代码的编写 潜在的缺陷：Sonar 可以通过 PMD、CheckStyl
Sonarqube规则插件自定义(sonar-pmd-p3c)
m0_54731428的博客
07-19 4374
sonarqube规则插件二次开发，针对规则的增删改展开探讨，实现sonar扫描规则自定义
SonarQube 7.8自定义规则插件教程
ygy1988的专栏
03-13 3030
网上教程参差不齐，到处copy，各种坑。另外SonarQube源码里面的demo都是最新版本的，不适用旧版的开发教程，当前7.8的版本已经用了好久，换新版本也不值当。所有只能自己捣鼓。在自己折腾一天后，结合网上教程和SonarQube的源码，决定把完整的过程写下来，以免后人捉急当前的要求是，不允许开发随便修改对外公共接口的任何属性，包括参数名，参数类型，方法名，返回类型，修饰符。所以就定义一个注解，假设注解名称叫@check，该注解中有个属性叫checkToken。
sonar-java 手写一个规则-单元测试分析
fenglllle的博客
02-25 1965
最近做项目，定制sonar规则，提高Java代码质量，在编写的sonar规则，做验证时，使用单元测试有一些简单的心得感悟，分享出来。sonar的自定义规则很简单，一般而言有2种模式可以使用：1. 自定义扫描代码逻辑，并对分类的Tree的结构处理2. 使用已扫描的分类，对分好类的Tree进行分析。
sonarqube+sonar-scanner如何自定义扫描properties文件
最新发布
11-01
SonarQube是一个用于静态代码分析的开源平台，而SonarScanner则是SonarQube的命令行客户端，用于在本地项目上运行分析并将结果上传到SonarQube服务器。如果你想自定义扫描过程中的Properties文件配置，可以按照以下步骤操作： 1. **创建或修改`sonar-project.properties`**： - 在你的项目的根目录下，通常会有一个名为`.sonar-project.properties`的文件，这是默认的SonarScanner配置文件。你可以在这里添加或编辑你需要的配置项。 ```properties # 示例配置 sonar.sources=src/main/java sonar.java.binaries=target/classes sonar.java.libraries=lib/*.jar sonar.exclusions=**/generated/** # 避免扫描生成的代码 # 如果你想覆盖特定扫描的规则文件 sonar.scan.coverage.exclusions=**/excludedFromCoverage.txt ``` 这里的配置项包括源码目录、目标文件夹、依赖库路径等，以及自定义的排除规则。 2. **环境变量覆盖**： - 如果某些配置只适用于特定环境，你可以通过系统环境变量来设置。例如，`SONAR_SCANNER_OPTS`可以用来传递额外的参数给SonarScanner。 ```bash export SONAR_SCANNER_OPTS="-Dsonar.projectKey=myProjectKey" ``` 3. **自定义Properties文件**： - 如果需要更复杂或者跨多个项目的情况，你可以创建一个单独的Properties文件（如`mycustom.properties`），然后在`sonar-project.properties`里引用它： ```properties sonar.project.properties=relative/path/to/mycustom.properties ``` 记得在执行`sonar-scanner`命令时加上这个配置。 4. **执行扫描**： - 使用`sonar-scanner`命令扫描项目，比如： ```bash ./path/to/sonar-scanner ``` **相关问题--:** 1. 如何在SonarQube中设置全局的Properties文件？ 2. SonarScanner如何读取环境变量的配置？ 3. 我可以在哪些地方找到关于SonarScanner更多配置选项的帮助文档？
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值