玩转微服务-SonarQube

news2025/1/15 14:22:35

这里写目录标题

  • 第一节 SonarQube
    • 1.1 简介
    • 1.2 四个组成部分
      • 1.2.1 SonarQube服务器
      • 1.2.2 SonarQube数据库
      • 1.2.3 插件
      • 1.2.4 Scanner
    • 1.3 工作流程
  • 第二节 SonarQube的安装
    • 2.1 安装
    • 2.2 插件
  • 第三节 P3C规范
    • 3.1 简介
    • 3.2 SonarQube 配置 P3C规范
    • 3.3 IDEA配置 P3C规范
  • 第四节 Maven项目代码检查
    • 4.1 根项目POM.xml修改
    • 4.2 代码扫描提交
  • 第五节 nodejs项目代码检查

第一节 SonarQube

1.1 简介

SonarQube是一款静态代码质量分析工具，支持Java、Python、PHP、JavaScript、CSS等25种以上的语言，而且可以集成在IDEA、Jenkins、GIt等服务中，方便随时查看代码质量分析报告。支持的语言：
在这里插入图片描述

SonarQube通过配置的代码分析规则，从可靠性、安全性、可维护性、覆盖率、重复率等方面分析项目，风险等级从A~E划分为5个等级，同时SonarQube可以集成pmd、findbugs、checkstyle等插件来扩展使用其他规则来检验代码质量；SonarQube还设置了质量阈，通过设置的质量阈评定此次提交分析的项目代码是否达到了规定要求。

其他的静态代码分析工具：PMD，CheckStyle，FindBug

1.2 四个组成部分

1.2.1 SonarQube服务器

  1. Web服务：供开发者，管理者，浏览质量快照和配置SonarQube实例
  2. 搜索服务：基于ElasticSearch的Search Server从UI进行后退搜索
  3. 计算引擎服务：负责处理代码分析报告并将其保存在SonarQube数据库中

1.2.2 SonarQube数据库

  • SonarQube实例的配置（安全性，插件设置等）
  • 项目，视图等的质量快照

1.2.3 插件

多个SonarQube插件，可能包括语言，SCM，集成，身份验证和管理插件

1.2.4 Scanner

一个或多个SonarQube Scanners：可以与CI服务进行集成

在这里插入图片描述

1.3 工作流程

  1. 开发人员的代码在自己的IDE和使用SonarLint运行局部分析；

  2. 开发人员推代码到Git服务器；

  3. 持续集成服务器触发自动构建和SonarQube扫描仪的运行SonarQube分析所需的执行。

  4. 分析报告被发送到SonarQube服务器进行处理。

  5. SonarQube服务器处理和存储分析报告导致SonarQube数据库，并显示结果在UI中。

  6. 开发者审核，评论问题，减少他们的技术债务问题。

  7. 团队负责人收到的分析报告。 OPS使用API​​从SonarQube自动化配置和提取数据。

在这里插入图片描述

第二节 SonarQube的安装

2.1 安装

我们采用docker，docker-compose的方式进行安装

version: '3'
services:
  sonarqube:
    image: sonarqube:9.9.0-community
    ports:
      - "9000:9000"
    networks:
      - sonarnet
    restart: always
    privileged: true
    volumes:
      - /docker/sxhm/sonarqube/conf/sonar.properties:/opt/sonarqube/conf/sonar.properties
      - /docker/sxhm/sonarqube/pdf-files:/opt/sonarqube/pdf-files
      - /docker/sxhm/sonarqube/extensions/plugins:/opt/sonarqube/extensions/plugins
    environment:
      - TZ=Asia/Shanghai
      - SONARQUBE_JDBC_USERNAME=xxxx
      - SONARQUBE_JDBC_PASSWORD=xxxx
      - SONARQUBE_JDBC_URL=jdbc:postgresql://postgresdb:5432/sonar
  postgresdb:
    image: postgres:bullseye
    ports:
      - 5432:5432
    networks:
      - sonarnet
    environment:
      TZ: Asia/Shanghai
      POSTGRES_USER: xxxxx
      POSTGRES_PASSWORD: xxxxx
      POSTGRES_DB: sonar
    volumes:
      - /docker/sxhm/sonarqube/postgresql/data:/usr/postgres/data
      - /etc/localtime:/etc/localtime:ro
networks:
  sonarnet:
    driver: bridge

2.2 插件

下载需要的插件，放到挂载目录下：/docker/sxhm/sonarqube/extensions/plugins 下 重启docker容器

  • sonar-pdf-plugin
  • sonar-pmd
  • sonar-pmd-p3c

第三节 P3C规范

3.1 简介

源自《阿里巴巴Java编码指南》，该指南汇集了阿里巴巴集团技术团队多年来的最佳编程实践。大量的Java编程团队对项目中的代码质量提出了苛刻的要求，因为我们鼓励重用和更好地理解彼此的程序。我们在过去看到过许多编程问题。例如，有缺陷的数据库表结构和索引设计可能会导致软件体系结构缺陷和性能风险。另一个例子是难以维护的混乱代码结构。此外，没有身份验证的易受攻击的代码容易受到黑客的攻击。

https://github.com/alibaba/p3c

3.2 SonarQube 配置 P3C规范

首先需要登录 sonarqube 管理员账号，然后在 Marketplace 中搜索“pmd”并安装。

安装完成后，在 Quality Profiles 中选择“Sonar way”规则集，然后点击“Activate more rules”按钮，搜索“p3c”并勾选相应规则，点击“Activate”即可。

这样就完成了在 sonarqube 中集成阿里 P3C 规则的操作。

3.3 IDEA配置 P3C规范

安装插件“Alibaba Java Coding Guidelines”即可

第四节 Maven项目代码检查

4.1 根项目POM.xml修改

    <properties>
        <sonar.host.url>http://10.10.10.108:9000</sonar.host.url>
        <sonar.plugin.version>3.4.0.905</sonar.plugin.version>
        <sonar.projectKey>${project.groupId}:${project.artifactId}</sonar.projectKey>
        <sonar.moduleKey>${project.artifactId}</sonar.moduleKey>
        <sonar.projectName>${project.artifactId}</sonar.projectName>
        <sonar.login>xxxx</sonar.login>
        <sonar.password>xxxxx</sonar.password>
       </properties>
    <build>
        <plugins>
            <!--sonar 代码扫描插件-->
            <plugin>
                <groupId>org.sonarsource.scanner.maven</groupId>
                <artifactId>sonar-maven-plugin</artifactId>
                <version>${sonar.plugin.version}</version>
            </plugin>
        </plugins>
    </build>

确保项目使用的maven setting.xml 文件中未配置任何关于sonar的配置项

4.2 代码扫描提交

mvn clean package sonar:sonar

也可以借助idea 的maven图形化界面， 若出现编译问题， 可先clean package 修改编译的环境，如jdk11，再执行sonar:sonar

第五节 nodejs项目代码检查

  1. 安装SonarScanner（确保SonarQube服务器正在运行）：
# 下载
wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.6.2.2472-linux.zip
 
# 解压
unzip sonar-scanner-cli-4.6.2.2472-linux.zip
 
# 配置环境变量
echo "export PATH=$PATH:/path/to/sonar-scanner-4.6.2.2472-linux/bin" >> ~/.bashrc
source ~/.bashrc
  1. 创建 sonar-project.properties
# 必要属性
sonar.projectKey=your-project-key
sonar.projectName=your-project-name
sonar.projectVersion=1.0
 
# 源代码位置
sonar.sources=.
sonar.exclusions=**/node_modules/**
sonar.language=js
sonar.sourceEncoding=UTF-8
 
# 数据库认证
sonar.login=your-sonarqube-login
sonar.password=your-sonarqube-password
 
# SonarQube服务器
sonar.host.url=http://localhost:9000

  1. 运行SonarScanner扫描项目：

    # 在项目根目录执行
sonar-scanner

确保替换your-project-key、your-project-name、your-sonarqube-login和your-sonarqube-password为实际值，并且设置正确的sonar.host.url。

这个过程会将Vue项目的代码扫描完毕，并上传到SonarQube服务器进行分析。你可以在SonarQube的界面上查看扫描结果。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1623334.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

基于opencv的单目相机标定

基于opencv的单目相机标定

openCv版本&#xff1a;4.4.0 从源码处拷贝标定代码出来使用&#xff0c;需要拷贝samples/cpp/tutorial_code/calib3d/camera_calibration 需要的文件如下&#xff1a; -rw-rw-r-- 1 rog rog 28490 Jul 18 2020 camera_calibration.cpp -rw-rw-r-- 1 rog rog 3152 Jul 18 …
阅读更多...
初识C++·类和对象(中)(3)

初识C++·类和对象(中)(3)

前言&#xff0c;最难的已经结束了&#xff0c;来点轻松了放松一下。 目录 1 流重载 2 const成员 3 取地址及const取地址操作符重载 1 流重载 C语言中printf和scanf是有局限性&#xff0c;只能直接打印内置类型&#xff0c;对于自定义类型就哦豁了&#xff0c;所以在C中就…
阅读更多...
5月计算机各省报名时间汇总报名流程

5月计算机各省报名时间汇总报名流程

&#x1f4e3;5月有5省可进行计算机报名 天津&#xff1a;5月6日-5月10日 福建&#xff1a;5月6日9:00-5月12日17:00 广西&#xff1a;5月6日9:00-5月12日23:55 重庆&#xff1a;5月6日9:00-5月12日24:00 西藏&#xff1a;预计5月6日-12日 &#x1f50d;计算机等级考试报…
阅读更多...
linux DNS域名解析服务

linux DNS域名解析服务

目录 一.DNS DNS系统的作用 域名结构&#xff1a; 根域 顶级域 二级域 子域 主机 二.DNS解析过程 迭代查询&#xff1a; 递归查询&#xff1a; 三.实验模拟 主、从服务器设置 1.搭建本地DNS服务器------(主服务器配置) 1&#xff09;初始化系统 ​编辑2&#xf…
阅读更多...
win c++使用lua环境配置 5.3.5版本

win c++使用lua环境配置 5.3.5版本

编译lua 下载lua源码&#xff0c;github仓库 使用vs编译源码&#xff0c;新建一个静态库项目(只会生成lib文件)&#xff0c;想要dll的话就新建dll项目&#xff08;有一个lib文件和dll文件&#xff09; 把lua源码下面的文件夹都是&#xff0c;复制到vs项目中 lib目录是我手动…
阅读更多...
Linux蓝牙驱动模拟HID设备（把Linux系统模拟成蓝牙鼠标和蓝牙键盘）

Linux蓝牙驱动模拟HID设备（把Linux系统模拟成蓝牙鼠标和蓝牙键盘）

by fanxiushu 2024-04-24 转载或引用请注明原始作者。 在经过windows的蓝牙驱动开发模拟成HID设备的大风大浪之后&#xff0c; 现在回到linux下实现相同功能&#xff0c;简直就是如小孩嬉闹一样的轻松。 但无论如何&#xff0c;作为模拟蓝牙HID设备的windows&#xff0c;linux一…
阅读更多...
冰箱、保险柜门不要对准外面

冰箱、保险柜门不要对准外面

风水真的和我们的生活息息相关&#xff0c;它会影响到我们的事业财运、婚姻感情、健康平安等等。很多人在不知情的情况下&#xff0c;触犯了风水里的禁忌&#xff0c;那结果可想而知&#xff01; 峰民特别提示您&#xff1a;千万不要将冰箱、保险柜的门对准外面。冰箱是不能与…
阅读更多...
什么是重放攻击(Reply attack)?

什么是重放攻击(Reply attack)?

什么是重放攻击(Reply attack)? 重放攻击&#xff0c;也称为回放攻击&#xff0c;是一种网络攻击方式。重放攻击是一种中间人攻击&#xff0c;攻击者通过截获合法的数据传输并重新发送它们来欺骗接收方&#xff0c;让接收方误以为是合法的消息。重放攻击是非常常见的&#xf…
阅读更多...
printjs打印表格的时候多页的时候第一页出现空白

printjs打印表格的时候多页的时候第一页出现空白

现象&#xff1a;打印多页的时候第一页空白了&#xff0c;一页的时候没有问题 插件&#xff1a;printjs 网上搜索半天找到的方式解决&#xff1a; 1. 对于我这次的现象毫无作用。其他情况不得而知&#xff0c;未遇见过。&#xff08;这个应该是大家用的比较多的方式&#xf…
阅读更多...
古籍数字化平台中的OCR：这个平台更精准

古籍数字化平台中的OCR：这个平台更精准

在浩瀚的历史长河中&#xff0c;古籍作为中华民族的文化瑰宝&#xff0c;承载着无数先人的智慧与心血。然而&#xff0c;由于岁月侵蚀、保存不当等多种原因&#xff0c;许多珍贵的古籍面临损坏、失传的危机。为了守护这些无价之宝&#xff0c;云聪研发团队倾力打造了一款尖端的…
阅读更多...
使用QTcpSocket

使用QTcpSocket

(1)客户端每隔10ms向服务器发送一次数字字符串&#xff0c;从0开始。 #ifndef MAINWINDOW_H #define MAINWINDOW_H#include <QMainWindow> #include <QTcpSocket> #include <QLabel> #include <QTimer> namespace Ui { class MainWindow; }class Mai…
阅读更多...
11 - 在k8s官方文档上，经常搜索不到内容的问题

11 - 在k8s官方文档上，经常搜索不到内容的问题

使用k8s官方文档时&#xff0c;会出现首页可以正常打开&#xff0c;但是输入搜索关键字之后&#xff0c;搜索不到内容的情况&#xff0c;如下图&#xff1a; 这是由于相关搜索组件被墙的原因&#xff0c;处理方法如下&#xff1a; 谷歌浏览器&#xff1a; 火狐浏览器&#x…
阅读更多...
Epic游戏商店再送大作，兽人必须死3即将免费领取

Epic游戏商店再送大作，兽人必须死3即将免费领取

Epic游戏商店再送大作&#xff01;兽人必须死3即将免费领取 圣诞节过后&#xff0c;Epic游戏商店一直在送出精心制作的小游戏或者在小圈子里备受热议的作品。虽然之前送过的游戏如《天外世界》和《幽灵行者》等名气不小&#xff0c;但对于一直在“白嫖”的玩家们来说&#xff0…
阅读更多...
采用php vue2 开发的一套医院安全（不良）事件管理系统源码（可自动生成鱼骨图）

采用php vue2 开发的一套医院安全（不良）事件管理系统源码（可自动生成鱼骨图）

采用php vue2 开发的一套医院安全&#xff08;不良&#xff09;事件管理系统源码&#xff08;可自动生成鱼骨图&#xff09; 医院安全&#xff08;不良&#xff09;事件管理系统采用无责的、自愿的填报不良事件方式&#xff0c;有效地减轻医护人员的思想压力&#xff0c;以事件…
阅读更多...
【Go语言快速上手(四)】面向对象的三大特性引入

【Go语言快速上手(四)】面向对象的三大特性引入

&#x1f493;博主CSDN主页:杭电码农-NEO&#x1f493;   ⏩专栏分类:Go语言专栏⏪   &#x1f69a;代码仓库:NEO的学习日记&#x1f69a;   &#x1f339;关注我&#x1faf5;带你学习更多Go语言知识   &#x1f51d;&#x1f51d; GO快速上手 1. 前言2. 初识GO中的结构…
阅读更多...
记内网http洪水攻击，导致网页无法访问一事

记内网http洪水攻击，导致网页无法访问一事

事由 最近两日&#xff0c;部分同事在访问税纪云平台时&#xff0c;登录跳转页面频繁转圈、要么就是出现无法连接的错误提示。 无法访问此页面 已重置连接。 请尝试: 检查连接 检查代理和防火墙 运行 Windows 网络诊断经过以下几方面的排查&#xff0c;无果。 后续通过检查…
阅读更多...
【Node.js】02 —— Path模块全解析

【Node.js】02 —— Path模块全解析

&#x1f31f;Node.js之Path模块探索&#x1f308; &#x1f4da;引言 在Node.js的世界中&#xff0c;path模块就像一把万能钥匙&#x1f511;&#xff0c;它帮助我们理解和操作文件与目录的路径。无论你是初入Node.js殿堂的新手&#xff0c;还是久经沙场的老兵&#xff0c;理…
阅读更多...
Docker容器概念介绍与基本管理

Docker容器概念介绍与基本管理

前言 在软件开发和部署环境中&#xff0c;使用 Docker 等容器技术可以帮助团队实现快速、一致、可靠的应用程序部署&#xff0c;提高开发效率和应用程序的可移植性。 目录 一、虚拟化产品介绍 1. 云服务模型 1.1 IaaS 1.2 PaaS 1.3 SaaS 1.4 DaaS 2. 产品介绍 2.1 虚…
阅读更多...
【八股】Spring篇

【八股】Spring篇

why Spring? 1.使用它的IOC功能&#xff0c;在解耦上达到了配置级别。 2.使用它对数据库访问事务相关的封装。 3.各种其他组件与Spring的融合&#xff0c;在Spring中更加方便快捷的继承其他一些组件。 IoC和DI &#x1f449;IOC是Inversion of Control的缩写&#xff0c;“…
阅读更多...
Nginx 四层和七层代理区别、配置

Nginx 四层和七层代理区别、配置

四层&#xff1a;通过报文中的目标地址和端口&#xff0c;加上负载均衡设备设置的服务器选择方式&#xff0c;决定最终选择的内部服务器&#xff0c;使用tcp、udp协议。 七层&#xff1a;"内容交换"&#xff0c;通过报文中真正有意义的应用层内容&#xff0c;加上负…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023