SonarQube一款更好用代码质量检测工具

2024-06-07 17:44

本文主要是介绍SonarQube一款更好用代码质量检测工具,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

什么是慢SQL?

  • 定义

    通常指的是在数据库中执行时间较长的 SQL 查询。由于数据库查询执行时间较长,这些查询可能会导致数据库性能下降,影响应用程序的响应速度和整体用户体验。识别和优化慢 SQL 是数据库性能调优的一个重要部分。

  • 示例


SELECT *
FROM products p
WHERE p.id IN (SELECT product_idFROM order_items oiWHERE oi.order_id IN (SELECT idFROM orders oWHERE o.customer_id IN (SELECT idFROM customers cWHERE c.region IN (SELECT regionFROM sales_regionsWHERE region_name = 'North America')))
);

慢SQL排查的重要性

SQL查询会对数据库和应用程序的性能产生多方面的负面影响,可能导致性能下降、资源消耗增加、系统稳定性受影响、用户体验变差、业务受影响、运维成本增加以及安全风险增加。因此,及时监控和优化慢SQL查询,对于保障系统性能和稳定性至关重要。

慢SQL排查的挑战

  • 无法严格按照标准规范执行

    1. 能不能只是主键/索引的单条查询
    2. 能不能拆成多次简单的查询(程序合并处理业务去)
    3. 能不能避免在查询结果中做计算(程序计算去)

    规范是需要工具和人来执行的,检查机制,自动扫描机制,测试机制是保证这些问题不发生的根本。主要问题在于谁来管理,如何检查,如何持久的执行下去。

  • 手动排查的复杂性和耗时

    产品对接审计平台,测试过程中发现慢查询,测试需要有疲劳测试,需要数据量测试。

  • 业务逻辑和查询复杂度

    1. 不合理的数据库设计,或复杂的业务逻辑嵌入到查询中等;造成多层嵌套、多表关联等情况
    2. 复杂的条件过滤;WHERE子句中有多个复杂条件,尤其是涉及OR、LIKE等操作,会增加查询处理时间
    3. 不必要的数据处理;在查询中进行大量的数据过滤和转换操作,如复杂的CASE WHEN语句、字符串操作等,会增加查询的计算开销

如何排查慢SQL?

  1. 在数据库服务端集成组件;
  2. 直接使用数据库透明代理,或者直接dump数据库流量;
  3. sdk的方式是最后考虑的方式。

推荐:使用自动化工具持续监控和优化数据库性能。

SonarQube

  • Sonar集成过程

sonarlint集成过程

  1. 开发人员在他们的ide中使用SonarLint运行分析本地代码
  2. 开发人员将他们的代码提交到代码管理平台中(SVN,GIT等)
  3. 持续集成工具自动触发构建,调用SonarScanner对项目代码进行扫描分析
  4. 分析报告发送到SonarQube Server中进行加工
  5. SonarQube Server 加工并且保存分析报告到SonarQube Database中,通过UI显示分析报告

部署SonarQube

1. 创建PV & PVC(样例)

  • postgres-storage.yaml
apiVersion: v1
kind: PersistentVolume
metadata:name: postgreslabels:app: postgres
spec:accessModes:       - ReadWriteOncecapacity:          storage: 5GimountOptions:   #NFS挂在选项- hard - nfsvers=4.1 #NFS Server版本nfs:            #NFS设置server: 192.168.xxx.xxxpath: /nfs/data/postgres
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:name: postgreslabels:app: postgres
spec:accessModes:- ReadWriteOnceresources:requests:storage: 5Gi  #设置大小为5Gselector:matchLabels:app: postgres
  • 创建PostgreSQL PV & PVC

-n:指定启动的 Namespace,这个值替换为自己集群的 Namespace

$ kubectl apply -f postgres-storage.yaml -n nbsp

2. 创建PostgreSQL

  • postgres.yaml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:name: postgres-data 
spec:accessModes:- ReadWriteManystorageClassName: nas-storeresources:requests:storage: 1Gi---apiVersion: v1
kind: Service
metadata:name: postgres-sonarlabels:app: postgres-sonar
spec:type: NodePort        #指定为 NodePort 方式暴露出口ports:- name: serverport: 5432targetPort: 5432nodePort: 30543   #指定 Nodeport 端口protocol: TCPselector:app: postgres-sonar
---
apiVersion: apps/v1
kind: Deployment
metadata:name: postgres-sonarlabels:app: postgres-sonar
spec:replicas: 1selector:matchLabels:app: postgres-sonartemplate:metadata:labels:app: postgres-sonarspec:containers:- name: postgres-sonarimage: postgres:11.4imagePullPolicy: IfNotPresentports:- containerPort: 5432env:- name: POSTGRES_DBvalue: "sonarDB"- name: POSTGRES_USERvalue: "sonarUser"- name: POSTGRES_PASSWORD value: "123456"resources:limits:cpu: 1000mmemory: 2048Mirequests:cpu: 500mmemory: 1024MivolumeMounts:- mountPath: /var/lib/postgresql/dataname: postgredbvolumes:- name: postgredbpersistentVolumeClaim:claimName: postgres-data         #引用上面创建的 PVC
  • 创建PostgreSQL

# 查看所有nodePort端口号
kubectl get service --all-namespaces -o jsonpath="{..nodePort}"kubectl apply -f postgres.yaml -n nbsp

3. 部署SonarQube

  • sonarqube.yaml
apiVersion: apps/v1
kind: Deployment
metadata:name: sonarqubelabels:app: sonarqube
spec:replicas: 1selector:matchLabels:app: sonarqubetemplate:metadata:labels:app: sonarqubespec:initContainers: #设置初始化镜像,执行 system 命令- name: init-sysctlimage: busyboximagePullPolicy: IfNotPresentcommand: ["sysctl", "-w", "vm.max_map_count=262144"] #必须设置vm.max_map_count这个值调整内存权限,否则启动可能报错securityContext:privileged: true   #赋予权限能执行系统命令containers:- name: sonarqubeimage: sonarqube:9.0.1-community # 8.9.6-community 7.9-community lts-communityports:- containerPort: 9000env:- name: SONARQUBE_JDBC_USERNAMEvalue: "sonarUser" #引用 PostgreSQL 配置中设置的用户名- name: SONARQUBE_JDBC_PASSWORDvalue: "123456"  #引用 PostgreSQL 配置中设置的密码- name: SONARQUBE_JDBC_URLvalue: "jdbc:postgresql://postgres-sonar:5432/sonarDB"  #指定 PostgreSQL 在 Kubernetes 中的地址livenessProbe:httpGet:path: /sessions/newport: 9000initialDelaySeconds: 60periodSeconds: 30readinessProbe:httpGet:path: /sessions/newport: 9000initialDelaySeconds: 60periodSeconds: 30failureThreshold: 6resources:limits:cpu: 2000mmemory: 2048Mirequests:cpu: 1000mmemory: 1024MivolumeMounts:- mountPath: /opt/sonarqube/confname: datasubPath: conf- mountPath: /opt/sonarqube/dataname: datasubPath: data- mountPath: /opt/sonarqube/extensionsname: datasubPath: extensionsvolumes:- name: datapersistentVolumeClaim:claimName: sonarqube-data  ---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:name: sonarqube-data 
spec:accessModes:- ReadWriteManystorageClassName: nas-storeresources:requests:storage: 5Gi---
apiVersion: v1
kind: Service
metadata:name: sonarqubelabels:app: sonarqube
spec:type: NodePortports:- name: sonarqubeport: 9000targetPort: 9000nodePort: 30003 #指定 NodePort 端口protocol: TCPselector:app: sonarqube
  • 创建SonarQube

$ kubectl apply -f sonarqube.yaml -n nbsp# 更新镜像版本号
$ kubectl patch deployment sonarqube -p '{"spec":{"template":{"spec":{"containers":[{"name":"sonarqube","image":"sonarqube:7.9.6-community"}]}}}}' -n nbsp

注意:如果项目启动失败,或者显示无法执行 initContainers 操作,那么可能是没有 RBAC 权限导致,请创建一个有一定权限的 ServiceAccount 后,再在 SonarQube 部署文件中指定这个 ServiceAccount 即可。

配置SonarQube

1. 登录SonarQube

程序启动完成后,进入 SonarQube 页面,上面 SonarQube Service 以 NodePort 方式暴露 SonarQube 到集群外,并且本人 Kubernetes 集群地址为"192.168.xxx.xx",所以这里输入地址 http://192.168.xxx.xx:30003 访问 SonarQube UI 界面。

初始账号密码:admin/admin

2. SonarQube 安装插件

按照 SonarQube 后需要安装许多插件来完善这个工具,这里我们安装 Chinese 和 SonarJava 俩个插件,其中第一个插件为界面提供汉化,第二个插件是 Java 语言分析插件。当然,也可以选择你自己想安装的插件进行安装。

待安装插件列表:

Chinese
SonarJava

打开 Administration->Marktplace ,然后搜索栏输入 “Chinese” ,等待一段时间(国内访问国外地址比较慢)后弹出相关插件列表,选择 Chinese Pack 进行安装。

sonarqube-install-chinese

安装完成后会弹出重启 SonarQube 服务的窗口,点击一下进行容器,再次进入后可以看到界面已经汉化

sonarqube-install-1005

3. 安装sonar-mybatis插件

  • 手动下载

# 进入pod容器内 
kubectl exec -it sonarqube-5fc8858ddb-gg2vk -n nbsp -- /bin/bash# 进入目录
cd /opt/sonarqube/extensions/downloads# 下载插件
wget https://github.com/donhui/sonar-mybatis/releases/download/1.0.8/sonar-mybatis-plugin-1.0.8.jarwget https://github.com/donhui/sonar-mybatis/releases/download/1.0.7/sonar-mybatis-plugin-1.0.7.jar# 给所有插件赋权限
chown sonarqube.sonarqube sonar-*

注意事项:下载完后需要放入 /opt/sonarqube/extensions/downloads目录下,此时安装流程会继续执行,切勿放到/opt/sonarqube/extensions/plugins下,该目录为安装后的目录,会导致插件加载失败,无法启动sonarqube

  • 加载插件

页面Marketplace页面重启sonarqube server加载插件

重启服务加载插件


2024.05.28 08:13:02 ERROR web[][o.s.s.p.PlatformImpl] Web server startup failed: Plugin MyBatis Plugin for SonarQube [mybatis] requires at least SonarQube 9.0.0.45539

9.0.1-community + sonar-mybatis-plugin-1.0.7.jar 实测可行

样例演示

  • 样例说明

IDEA中使用插件sonarlint连接到SonarQube对代码质量进行管控

环境准备

  • sonarLint插件安装

File –> Setting -> Plugin 输入SonarLint搜索插件

  • 配置Token

登录sonarqube -> 创建项目 -> 创建令牌


mvn sonar:sonar \-Dsonar.projectKey=nbsp-demo-jar \-Dsonar.host.url=http://192.168.xxx.xx:30003 \-Dsonar.login=xxxxxxxx
  • 配置插件

File –> Setting -> Tools -> SonarLint

创建SonarQube连接

  • 绑定项目

File –> Setting -> Tools -> SonarLint -> Project Settings

绑定项目

配置项目规则

  • 设置XML默认配置规则

设置默认配置规则

  • 管理项目质量配置规则

项目配置规则

*配置全局 Stmt ID 排除

全局stmtId排除

  • 注意事项

SonarQube针对每个项目,每种语言的规则只能是一种,所以若原先由XML语言的规则,会被本规则覆盖。

实时数据收集与分析演示

  • 项目全局分析

Terminal中执行


mvn sonar:sonar \-Dsonar.projectKey=nbsp-demo-jar \-Dsonar.host.url=http://192.168.xxx.xx:30003 \-Dsonar.login=xxxxxxxx
  • 分析mybatis mapper文件

# 无法检测mybatis mapper
mvn clean compile -U -Dmaven.test.skip=true -Dmaven.javadoc.skip=true sonar:sonar -Dsonar.host.url=http://192.168.xxx.xx:30003/ -Dsonar.login=xxxxxxxx -Dsonar.projectKey=nbsp-demo-jar -Dsonar.projectName=nbsp-demo-jar -Dsonar.sourceEncoding=UTF-8 -Dsonar.sources=. -Dsonar.inclusions=src/main/ -Dsonar.exclusions==src/main/webapp/# Sonar fails with can't be indexed twice. Please check that inclusion/exclusion patterns produce disjoint sets for main and test files
mvn clean compile -U -Dmaven.test.skip=true -Dmaven.javadoc.skip=true sonar:sonar -Dsonar.host.url=http://192.168.xxx.xx:30003/ -Dsonar.login=xxxxxxxx -Dsonar.projectKey=nbsp-demo-jar -Dsonar.projectName=nbsp-demo-jar -Dsonar.sourceEncoding=UTF-8 -Dsonar.sources=. -Dsonar.inclusions=nbsp-demo-jar-server/src/main/** -Dsonar.exclusions==nbsp-demo-jar-server/src/main/webapp/**mvn clean compile -U -Dmaven.test.skip=true -Dmaven.javadoc.skip=true sonar:sonar -Dsonar.host.url=http://192.168.xxx.xx:30003/ -Dsonar.login=xxxxxxxx -Dsonar.projectKey=nbsp-demo-jar -Dsonar.projectName=nbsp-demo-jar -Dsonar.sourceEncoding=UTF-8 -Dsonar.inclusions=nbsp-demo-jar-server/src/main/** -Dsonar.exclusions==nbsp-demo-jar-server/src/main/webapp/**
  • 注意事项

sonarqube版本依赖的JDK要与项目实际编译的JDK版本保持一致


Failed to execute goal org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922:sonar (default-cli) on project nbsp-demo-jar: Execution default-cli of goal org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922:sonar failed: An API incompatibility was encountered while executing org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922:sonar: java.lang.UnsupportedClassVersionError: org/sonar/batch/bootstrapper/EnvironmentInformation has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0

报告生成与解读

登录SonarQube管理后台,查看质检效果

常见问题

java.lang.IllegalStateException: Fail to create or clean-up directory /opt/sonarqube/data/web/deploy

  • 日志明细
java.lang.IllegalStateException: Fail to create or clean-up directory /opt/sonarqube/data/web/deployat org.sonar.server.app.TomcatContexts.addStaticDir(TomcatContexts.java:85)at org.sonar.server.app.TomcatContexts.configure(TomcatContexts.java:60)at org.sonar.server.app.EmbeddedTomcat.start(EmbeddedTomcat.java:63)at org.sonar.server.app.WebServer.start(WebServer.java:52)at org.sonar.process.ProcessEntryPoint.launch(ProcessEntryPoint.java:97)at org.sonar.process.ProcessEntryPoint.launch(ProcessEntryPoint.java:81)at org.sonar.server.app.WebServer.main(WebServer.java:99)
Caused by: java.nio.file.AccessDeniedException: /opt/sonarqube/data/web/deploy/plugins/python/sonar-python-plugin-3.24.1.11916.jarat java.base/sun.nio.fs.UnixException.translateToIOException(Unknown Source)at java.base/sun.nio.fs.UnixException.rethrowAsIOException(Unknown Source)at java.base/sun.nio.fs.UnixException.rethrowAsIOException(Unknown Source)at java.base/sun.nio.fs.UnixFileSystemProvider.implDelete(Unknown Source)at java.base/sun.nio.fs.AbstractFileSystemProvider.delete(Unknown Source)at java.base/java.nio.file.Files.delete(Unknown Source)at org.sonar.core.util.FileUtils$DeleteRecursivelyFileVisitor.visitFile(FileUtils.java:204)at org.sonar.core.util.FileUtils$DeleteRecursivelyFileVisitor.visitFile(FileUtils.java:199)at java.base/java.nio.file.Files.walkFileTree(Unknown Source)at java.base/java.nio.file.Files.walkFileTree(Unknown Source)at org.sonar.core.util.FileUtils.deleteDirectoryImpl(FileUtils.java:159)at org.sonar.core.util.FileUtils.access$100(FileUtils.java:41)at org.sonar.core.util.FileUtils$CleanDirectoryFileVisitor.visitFile(FileUtils.java:183)at org.sonar.core.util.FileUtils$CleanDirectoryFileVisitor.visitFile(FileUtils.java:169)at java.base/java.nio.file.Files.walkFileTree(Unknown Source)at org.sonar.core.util.FileUtils.cleanDirectoryImpl(FileUtils.java:146)at org.sonar.core.util.FileUtils.cleanDirectory(FileUtils.java:86)at org.sonar.server.app.TomcatContexts$Fs.createOrCleanupDir(TomcatContexts.java:124)at org.sonar.server.app.TomcatContexts.addStaticDir(TomcatContexts.java:83)... 6 common frames omitted
2024.05.28 01:42:15 INFO  web[][o.s.p.ProcessEntryPoint] Hard stopping process
2024.05.28 01:42:16 INFO  app[][o.s.a.SchedulerImpl] Process[web] is stopped
2024.05.28 01:42:16 INFO  app[][o.s.a.SchedulerImpl] Process[es] is stopped
2024.05.28 01:42:16 WARN  app[][o.s.a.p.AbstractManagedProcess] Process exited with exit value [es]: 143
2024.05.28 01:42:16 INFO  app[][o.s.a.SchedulerImpl] SonarQube is stopped
  • 原因分析

不同版本的sonarqube可能

  • 解决方案

更换镜像版本为 sonarqube:7.9-community,或者在原启动命令里添加赋予权限的命令


command: ["sh", "-c", "sysctl -w vm.max_map_count=262144;sysctl -w fs.file-max=65536;ulimit -n 65536;ulimit -u 4096;chmod 777 -R /opt/sonarqube/"]

exited with exit value [es]

  • 日志明细
2019.07.04 02:40:53 WARN  app[][o.s.a.p.AbstractProcessMonitor] Process exited with exit value [es]: 1
  • 原因分析

Sonarqube 要求以非 root 用户启动,如果设置容器安全"runAsUser: 0"等参数,以 root 用户运行就会抛出以下错误,去掉 root 用户权限,设置镜像默认用户启动即可。

No plugin with key ‘mybatis’ or plugin ‘mybatis’ is already installed in latest version

  • 日志明细
ERROR web[AY+9GRjZgwsZBGNiAACx][o.s.s.p.UpdateCenterClient] Fail to connect to update center
org.sonar.api.utils.SonarException: Fail to download: https://update.sonarsource.org/update-center.properties (no proxy)
2024-05-28T03:17:07.974650944Z 	at org.sonar.core.util.DefaultHttpDownloader.failToDownload(DefaultHttpDownloader.java:155)at org.sonar.core.util.DefaultHttpDownloader.readString(DefaultHttpDownloader.java:113)at org.sonar.api.utils.UriReader.readString(UriReader.java:70)at org.sonar.server.plugins.UpdateCenterClient.init(UpdateCenterClient.java:99)
  • 原因分析

此错误是因为您没有设置代理,或者您应该通过sonar.updatecenter.activate禁用更新中心(又名 Marketplace)并将其设置为 false。

  • 解决方案

更好sonarqube版本号,采用高版本,自动下载失败,则进入pod里采用wget命令下载

参考链接

  • sqlmap

  • sqlfluff

  • sonarqube-mybatis-plugin

  • 手把手使用SonarQube分析、改善项目代码质量

  • kubernetes搭建SonarQube进行代码扫描

  • sonar.updatecenter.activate

  • Kubernetes 搭建 SonarQube代码检测工具

  • docker-compose安装SonarQube

  • SonarQube最全使用教程

  • 代码质量检测-SonarQube

  • 快速入門:在 Azure 上部署 SQL Server 容器叢集

这篇关于SonarQube一款更好用代码质量检测工具的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1039862

相关文章

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述:为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景:会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作?今天我要分享的Pyth... 目录一、项目概述:不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》:本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim

jupyter代码块没有运行图标的解决方案

《jupyter代码块没有运行图标的解决方案》:本文主要介绍jupyter代码块没有运行图标的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录jupyter代码块没有运行图标的解决1.找到Jupyter notebook的系统配置文件2.这时候一般会搜索到

Python通过模块化开发优化代码的技巧分享

《Python通过模块化开发优化代码的技巧分享》模块化开发就是把代码拆成一个个“零件”,该封装封装,该拆分拆分,下面小编就来和大家简单聊聊python如何用模块化开发进行代码优化吧... 目录什么是模块化开发如何拆分代码改进版:拆分成模块让模块更强大:使用 __init__.py你一定会遇到的问题模www.

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La