SonarQube 自定义插件示例教程

SonarQube 自定义插件示例教程

1. 项目的目录结构及介绍

sonar-custom-plugin-example/
├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   │   └── org
│   │   │       └── sonar
│   │   │           └── example
│   │   │               ├── MySensor.java
│   │   │               ├── MyRulesDefinition.java
│   │   │               └── MyPlugin.java
│   │   └── resources
│   │       └── org
│   │           └── sonar
│   │               └── l10n
│   │                   └── example
│   │                       └── rules
│   │                           └── example.properties
│   └── test
│       └── java
│           └── org
│               └── sonar
│                   └── example
│                       └── MySensorTest.java

目录结构介绍

• pom.xml: Maven 项目配置文件，定义了项目的依赖和构建配置。
• src/main/java/org/sonar/example/: 包含插件的主要实现代码。
  • MySensor.java: 实现自定义的传感器，用于分析代码并报告问题。
  • MyRulesDefinition.java: 定义自定义的规则。
  • MyPlugin.java: 插件的主类，注册传感器和规则。
• src/main/resources/org/sonar/l10n/example/rules/example.properties: 规则的本地化描述文件。
• src/test/java/org/sonar/example/MySensorTest.java: 测试类，用于测试自定义传感器。

2. 项目的启动文件介绍

MyPlugin.java

MyPlugin.java 是插件的入口点，负责注册传感器和规则。以下是该文件的关键部分：

package org.sonar.example;

import org.sonar.api.Plugin;

public class MyPlugin implements Plugin {

  @Override
  public void define(Context context) {
    context.addExtensions(MySensor.class, MyRulesDefinition.class);
  }
}

功能介绍

• define(Context context): 该方法用于定义插件的扩展点，通过 context.addExtensions 方法注册 MySensor 和 MyRulesDefinition。

3. 项目的配置文件介绍

pom.xml

pom.xml 是 Maven 项目的配置文件，定义了项目的依赖和构建配置。以下是该文件的关键部分：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.sonar.example</groupId>
  <artifactId>sonar-custom-plugin-example</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>sonar-plugin</packaging>

  <dependencies>
    <dependency>
      <groupId>org.sonarsource.sonarqube</groupId>
      <artifactId>sonar-plugin-api</artifactId>
      <version>7.9.2</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.sonarsource.sonar-packaging-maven-plugin</groupId>
        <artifactId>sonar-packaging-maven-plugin</artifactId>
        <version>1.17.0.372</version>
        <extensions>true</extensions>
      </plugin>
    </plugins>
  </build>
</project>

配置介绍

• groupId, artifactId, version: 定义了项目的唯一标识和版本。
• packaging: 指定打包类型为 sonar-plugin。
• dependencies: 定义了项目依赖，包括 sonar-plugin-api。
• build: 定义了构建插件