SonarQube外掛開發自定義規則(1)簡易demo
阿新 • • 發佈：2019-02-01
1、maven依賴
本開發教程適用於sonarqube5.x、6.x。
<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>wxtx</groupId 2、制定規則
/**
* @author 孫澤明
* 抽象類命名使用TXAbstract或TXBase開頭
*/
@Rule(
// 規則id
key = "TXAbstractClassNameCheck",
// 規則名稱
name = "抽象類命名使用TXAbstract或TXBase開頭",
// 規則介紹
description = "抽象類命名使用TXAbstract或TXBase開頭",
// 規則標籤
tags = {"wxtx-java"},
// 規則級別
priority = Priority.MINOR)
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.ARCHITECTURE_CHANGEABILITY)
// 糾正錯誤所需時間
@SqaleConstantRemediation("10min")
public class TXAbstractClassNameCheck extends BaseTreeVisitor implements JavaFileScanner {
private JavaFileScannerContext context;
public void scanFile(JavaFileScannerContext context) {
this.context = context;
scan(context.getTree());
}
@Override
public void visitClass(ClassTree tree) {
if(tree == null || tree.simpleName() == null){
super.visitClass(tree);
return;
}
String className = tree.simpleName().name();
boolean isAbstract = tree.symbol().isAbstract();
if(isAbstract && isNameIll(className)){
context.reportIssue(this, tree, "抽象類命名使用TXAbstract或TXBase開頭");
}
super.visitClass(tree);
}
private boolean isNameIll(String className){
return !className.startsWith("TXAbstract") && !className.startsWith("TXBase");
}
}3、註冊規則
3.1、自定義外掛入口
public class TXSonarPlugin implements Plugin {
public void define(Context context) {
context.addExtension(TXJavaRulesDefinition.class);
context.addExtension(TXJavaFileCheckRegistrar.class);
}
}3.2、server extensions
在sonarqube server啟動時例項化，實現org.sonar.api.server.rule.RulesDefinition介面
public class TXJavaRulesDefinition implements RulesDefinition {
public static final String REPOSITORY_KEY = "TXRepo";
public void define(Context context) {
NewRepository repository = context.createRepository(REPOSITORY_KEY,Java.KEY);
repository.setName("Java編碼規範");
AnnotationBasedRulesDefinition.load(repository, "java",TXRulesList.getChecks());
repository.done();
}
}3.3、batch extensions
在分析程式碼的時候例項化，實現org.sonar.plugins.java.api.CheckRegistrar介面
public class TXJavaFileCheckRegistrar implements CheckRegistrar {
public void register(RegistrarContext registrarContext) {
registrarContext.registerClassesForRepository(TXJavaRulesDefinition.REPOSITORY_KEY,
Arrays.asList(checkClasses()), Arrays.asList(testCheckClasses()));
}
public static Class<? extends JavaCheck>[] checkClasses() {
new Class[] {TXAbstractClassNameCheck.class};
}
@SuppressWarnings("unchecked")
public static Class<? extends JavaCheck>[] testCheckClasses() {
return new Class[] {};
}
}public class TXRulesList {
private TXRulesList() {
}
public static List<Class> getChecks() {
return ImmutableList.<Class>builder().addAll(getJavaChecks()).addAll(getJavaTestChecks()).build();
}
public static List<Class<? extends JavaCheck>> getJavaChecks() {
return ImmutableList.<Class<? extends JavaCheck>>builder()
.add(TXAbstractClassNameCheck.class).build();
}
public static List<Class<? extends JavaCheck>> getJavaTestChecks() {
return ImmutableList.<Class<? extends JavaCheck>>builder().build();
}
}4、輸出
maven執行命令mvn clean install輸出jar包，其中修改MANIFEST.MF的Plugin-Dependencies，例如：
Manifest-Version: 1.0
Plugin-Dependencies: META-INF/lib/*
Plugin-Description: test
Plugin-BuildDate: 2017-11-08T12:12:27+0800
Archiver-Version: Plexus Archiver
SonarLint-Supported: true
Built-By: Administrator
Plugin-License:
Plugin-Version: 0.0.1-SNAPSHOT
Sonar-Version: 5.6
Plugin-Developers:
Plugin-ChildFirstClassLoader: false
Plugin-Key: javacustom
Plugin-Class: wxtx.com.MySonarPlugin
Created-By: Apache Maven 3.3.9
Build-Jdk: 1.8.0_144
Plugin-Name: Java Custom Rules並將依賴的jar包複製進META-INF/lib/目錄下(例如guava、sonar-plugin-api)
5、測試
5.1、將自定義外掛jar放到sonar下的extensions/plugins路徑下
5.2、啟動SonarQube
5.3、啟用規則：登入admin賬號後，點選activate按鈕啟用規則
