Sonar Java 规则插件开发 (基于阿里开发手册)

最新推荐文章于 2024-08-21 08:50:32 发布

古月随笔

最新推荐文章于 2024-08-21 08:50:32 发布

阅读量6.6k

点赞数

分类专栏： sonar 文章标签： sonar 插件开发开源

本文链接：https://blog.csdn.net/tigereg000/article/details/79312022

版权

本文介绍了如何基于阿里开发手册开发Sonar Java规则插件，提供了开源地址和sonar常用方法说明。示例需求包括抽象类、异常类和测试类的命名规范，并展示了AbstractClassNameCheck的实现，包括资源目录结构和测试用例。

摘要由CSDN通过智能技术生成

引言

最近在做Sonar静态代码扫描管理，以此顺手接了Sonar的插件开发，基于阿里开发手册进行开发，在整体开发过程中，其中还是遇到不少坑位，也以此给大家做相应借鉴

官网Demo演示插件开发地址:
https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101
基于官网的我暂时不多说，基础框架按照官网的范例进行搭建即可

开源地址:

https://github.com/tigerge000/sonar-java-custom-rules.git

sonar常用方法说明

范例

需求:【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始，以 Test 结尾。
实现:
AbstractClassNameCheck

package org.finger.java.rule.checks.namerules;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.check.Rule;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.*;

/**
 * 抽象类命名检查
 * 抽象类命名使用 Abstract 或 Base 开头
 * Created by 古月随笔 on 2017/3/17.
 */
@Rule(key = "AbstractClassNameCheck")
public class AbstractClassNameCheck extends BaseTreeVisitor implements JavaFileScanner{
   

    private static final Logger