kotlin插件_Kotlin的SonarQube插件-正确创建插件

最新推荐文章于 2024-08-26 15:58:47 发布

dlz00001

最新推荐文章于 2024-08-26 15:58:47 发布

阅读量959

点赞数

文章标签： java python spring 编程语言 vue ViewUI

本文是关于创建SonarQube插件的Kotlin系列的最后一部分，主要介绍如何将ANTLR解析代码与SonarQube传感器对接，实现插件的完整功能。文中提到的主要步骤包括理解Sonar模型、编写插件代码、连接ANTLR解析器和传感器，以及运行和测试插件。此外，还讨论了当前实现的局限性和潜在的优化方向。

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

kotlin插件

这是一系列关于创建SonarQube插件的Kotlin语言^第三职位：

第一篇文章是关于创建解析代码本身的。
^第二篇文章详细介绍了如何使用解析代码检查两个规则。

在这最后一篇文章中，我们将使用前两篇文章的代码来正确创建插件。

声纳模型

Sonar模型基于以下抽象：

插入

插件的入口点，用于将扩展注入SonarQube

一个插件指向其他抽象实例，以使SonarQube平台加载它们

抽象语言

很不言自明。代表一种语言-Java，C＃，Kotlin等

ProfileDefinition

定义在声纳启动期间自动注册的配置文件

配置文件是一组可变的完全配置的规则。尽管不是绝对必要的，但预先注册了Sonar配置文件后，用户无需进行进一步配置即可分析其代码。 Sonar提供的每种语言插件都至少附加了一个配置文件。

规则定义

定义同一存储库的一些编码规则

在存储库中定义一组不变的规则定义。规则定义定义可用参数，默认严重性等时，规则（从配置文件中）定义参数的确切值，特定严重性等。简而言之，规则实现角色定义。

传感器

从叶模块开始，为项目的每个模块调用一次传感器。传感器可以解析平面文件，连接到Web服务器...传感器用于在文件级别添加度量和问题。

传感器是魔术发生的入口。

开始编写插件代码

上面的每个抽象都需要一个具体的子类。请注意，API类本身都是完全解耦的。 Plugin子类的作用是将它们绑定在一起。

classKotlinPlugin:Plugin{

    overridefundefine(context:Context){
        context.addExtensions(
                Kotlin::class.java,
                KotlinProfile::class.java,
                KotlinSensor::class.java,
                KotlinRulesDefinition::class.java)
    }
}

大多数代码主要是样板代码，但适用于ANTLR代码。

接线ANTLR解析代码

一方面，解析代码基于生成的侦听器。另一方面，传感器是SonarQube解析的入口点。两者之间需要一座桥梁。

在第一篇文章中，我们使用了Kotlin的现有语法来生成解析代码。 SonarQube提供了自己的词法分析器/解析器生成工具（ SonarSource Language Recognizer ）。插件API的很大一部分基于此。对于任何一种现实生活的语言来说，描述语法都不是一件容易的事，因此我宁愿设计自己的适配器代码。

AbstractKotlinParserListener

生成的ANTLR KotlinParserBaseListener子类。它具有存储违规的属性以及添加此类违规的方法。

违反

违规仅包含行号，因为其余所需信息将存储在KotlinCheck实例中。

KotlinCheck

包装了AbstractKotlinParserListener抽象类。定义什么构成违规。它处理ANTLR样板代码本身。

可以表示为以下内容：

传感器正常

通用伪代码应类似于以下内容：

FOR EACH source file
    FOR EACH rule
        Check for violation of the rule
        FOR EACH violation
            Call the SonarQube REST API to create a violation in the datastore

转换为：

classKotlinSensor(privatevalfs:FileSystem):Sensor{

    valsources:Iterable<InputFile>
        get()=fs.inputFiles(MAIN)

    overridefunexecute(context:SensorContext){
        sources.forEach{inputFile:InputFile->
            KotlinChecks.checks.forEach{check->
                valviolations=check.violations(inputFile.file())
                violations.forEach{(lineNumber)->
                    with(context.newIssue().forRule(check.ruleKey())){
                        vallocation=newLocation().apply{
                            on(inputFile)
                            message(check.message)
                            at(inputFile.selectLine(lineNumber))
                        }
                        at(location).save()
                    }
                }
            }
        }
    }
}