sonar3 使用 api/measures/componet 获取代码当，Java实现

阳仔的屁仔

于 2024-05-28 10:54:09 发布

阅读量995

点赞数 15

分类专栏：工具架构运维文章标签： java 开发语言

本文链接：https://blog.csdn.net/lly576403061/article/details/139258954

版权

运维同时被 3 个专栏收录

6 篇文章 0 订阅

订阅专栏

工具

4 篇文章 1 订阅

订阅专栏

架构

4 篇文章 0 订阅

订阅专栏

最近团队在做一个技术架构相关的优化，当前的目标是想要通过代码量，系统架构入手。先统计到部门的代码量，如何进行代码行数的统计呢，因为我们采用的是Java技术栈，我就Java技术栈进行说明。

1、如何统计代码行数

要统计Java代码的行数，你可以根据你的操作系统和可用工具选择不同的方法。下面是一些常见的方法：

1. 使用IDE

如果你使用的是IDE（如IntelliJ IDEA, Eclipse等），通常它们都有内置的功能或插件来统计项目中的代码行数。你可以查找你所使用的IDE的文档或在线资源来找到具体的操作步骤。

2. 使用命令行工具

在Linux或macOS上

咱们可以使用find和wc命令组合来统计特定类型的文件的代码行数。例如，要统计一个目录及其子目录中所有Java文件的行数，可以使用：

find . -name '*.java' | xargs wc -l

这条命令会列出所有.java文件的行数，并在最后给出总计。如果你想要使用find和xargs命令组合来统计Java代码行数，同时去掉空行，可以通过管道将find的输出传递给grep命令来过滤掉空行，然后再统计行数。这里有一个示例命令，展示了如何实现这一点：

find . -name '*.java' -print0 | xargs -0 grep -vE '^\s*$' | wc -l

这个命令的解释如下：

find . -name '*.java' -print0：查找当前目录及子目录下所有的.java文件。-print0选项与xargs的-0选项配合使用，用于正确处理文件名中可能包含的空格、换行等特殊字符。
xargs -0 grep -vE '^\s*$'：xargs -0接收find命令的输出作为grep命令的输入。grep -vE '^\s*$'用于过滤掉空行，其中-v选项表示选取不匹配的行，-E选项表示使用扩展正则表达式，'^\s*$'是一个正则表达式，用于匹配只包含空白字符（包括空格、制表符等）的行。
wc -l：统计通过grep过滤后剩余的行数，即非空行的数量。

这样，咱们就可以得到所有.java文件中非空行的总数。请注意，这种方法并不会区分代码行和注释行，它只是简单地去除了完全为空的行。

在Windows上

可以使用PowerShell来实现类似的功能。以下是一个使用PowerShell统计当前目录及子目录中所有.java文件行数的例子：

(Get-ChildItem -Recurse -Filter *.java | Select-String . -AllMatches).Matches.Count

3. 使用专门的代码行数统计工具

cloc（Count Lines of Code）是一个流行的、跨平台的工具，可以统计多种编程语言的代码行数。使用cloc统计Java代码行数的命令如下：

cloc --include-lang=Java .

这将会输出当前目录中Java代码的文件数量、空行数、注释行数和代码行数。

4. 使用简单的脚本

如果你的需求比较特殊，也可以编写简单的脚本来统计代码行数，比如使用Python或其他你熟悉的脚本语言。

选择哪种方法取决于你的具体需求和你使用的环境。上述方法中的大多数都可以很容易地适应来统计其他编程语言的代码行数。

5. 使用sonar WEB API 统计代码行数

因为我们的项目都接入了sonar，sonar可以在代码提交的时候进行一系列的检查和统计工作，同时他也提供了WebApi的方式对外提供了接口，所以我们用sonar3提供的接口api/measures/componet获取代码当量，使用Java实现。

创建令牌桶

在SonarQube中创建访问令牌（Access Token）是一个简单的过程，可以通过SonarQube的Web界面完成。访问令牌允许你以编程方式访问SonarQube API，而不需要使用用户名和密码。以下是创建访问令牌的步骤：

登录SonarQube：首先，使用你的账户登录到SonarQube的Web界面。
进入账户设置：登录后，点击右上角的用户名，然后在下拉菜单中选择“My Account（我的账户）”。
选择Security（安全）选项卡：在账户页面中，找到并点击“Security（安全）”选项卡。
生成Token：在“Security（安全）”页面，你会看到一个“Tokens（令牌）”部分。在这里，输入一个名称来标识你的Token，然后点击“Generate（生成）”按钮。名称可以是任何有意义的标识符，用于帮助你记住Token的用途。
保存Token：生成后，Token会显示在屏幕上。请确保复制并保存这个Token，因为它不会再次显示。如果你丢失了Token，你需要生成一个新的。
使用Token：现在你可以在API调用中使用这个Token了。在需要认证的地方，将Token作为用户名，密码部分留空。如果你使用的是HTTP请求，你可以通过在请求头中添加Authorization: Basic <encoded_token>来使用Token，其中<encoded_token>是你的Token经过Base64编码的结果。注意，编码时Token后面要加上冒号（:），即如果你的Token是abc123，你应该对abc123:进行Base64编码。

请注意，保护好你的Token，不要泄露给他人，因为拥有Token就等同于拥有你账户的访问权限。如果你的Token不慎泄露，应立即在SonarQube界面中撤销该Token，并生成一个新的。

sonar3使用api/measures/componet获取代码当量

要使用SonarQube的API /api/measures/component 来获取代码度量信息，你可以使用Java进行实现。这个API允许你获取特定组件（例如项目或模块）的度量信息，比如代码行数、复杂度等。

以下是一个简单的Java示例，展示了如何使用HttpURLConnection来调用SonarQube的API，并获取代码度量信息。请注意，你需要替换以下代码中的your_sonarqube_url、your_project_key、your_metric_keys和your_access_token为你自己的SonarQube服务器地址、项目键、度量键和访问令牌。

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class SonarQubeApiExample {
    public static void main(String[] args) {
        try {
            // 替换为你的SonarQube服务器地址
            String sonarQubeUrl = "http://your_sonarqube_url";
            // 替换为你的项目键
            String projectKey = "your_project_key";
            // 替换为你想要获取的度量键，例如：ncloc,complexity等，用逗号分隔
            String metricKeys = "your_metric_keys";
            // 替换为你的访问令牌
            String accessToken = "your_access_token";

            // 构建API URL
            String apiUrl = String.format("%s/api/measures/component?component=%s&metricKeys=%s", sonarQubeUrl, projectKey, metricKeys);

            // 创建URL对象
            URL url = new URL(apiUrl);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            // 设置认证信息
            conn.setRequestProperty("Authorization", "Basic " + java.util.Base64.getEncoder().encodeToString((accessToken + ":").getBytes()));

            // 发送请求并获取响应码
            int responseCode = conn.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // 读取响应内容
            BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
            String inputLine;
            StringBuilder response = new StringBuilder();
            while ((inputLine = in.readLine()) != null) {
                response.append(inputLine);
            }
            in.close();

            // 打印响应内容
            System.out.println(response.toString());

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

请确保你已经有了SonarQube的访问令牌，你可以在SonarQube的用户界面中生成它。在调用API时，需要使用基本认证（Basic Authentication），并将访问令牌作为用户名，密码部分留空。

此代码示例展示了如何构建API请求，设置必要的HTTP头（包括认证信息），发送请求，以及如何处理响应。你可以根据需要调整projectKey和metricKeys参数来获取不同项目的不同度量信息。