静态代码检查新利器

简介: 静态代码检查新利器

静态代码检查


静态测试是指不运行被测程序本身,通过分析或检查源程序的语法、结构、过程、接口等来检查程序的正确性。而动态测试是通过运行被测程序来检查运行结果与预期结果的差异,并分析运行效率和健壮性等指标。静态测试被测对象是各种与软件相关的有必要进行测试的产物,是对需求规格说明书、软件设计说明书、源程序做结构分析、流程图分析、符号执行来找错。静态测试可以手工进行,充分发挥人的思维的优势,并且不需要特别的条件,容易展开,但是静态测试对测试人员的要求较高,至少测试人员需要具有编程经验。静态测试主要包括各阶段的评审、代码检查、程序分析、软件质量度量等,用于对被测程序进行特性分析。其中评审通常有人来执行;代码检查程序分析、软件质量度量等即可人工完成,也可用工具来完成,但工具的作用和效果相对更大更好一些。


从上面我们可以了解到代码检查是静态测试中的关键一步,那么代码检查到底是个什么工作内容吗?


代码检查包括代码走查、桌面检查、代码审查等,主要检查代码和设计的一致性,代码对标准的遵循、可读性,代码的逻辑表达的正确性,代码结构的合理性等方面;可以发现违背程序编写标准的问题,程序中不安全、不明确和模糊的部分,找出程序中不可移植部分、违背程序编程风格的问题,包括变量检查、命名和类型审查、程序逻辑审查、程序语法检查和程序结构检查等内容。从代码检查的定义中我们可以看出代码检查不需要自动任何服务就可以通过代码扫描完成,全部过程都是按照预定义好的规则完成的,只要针对不同的编程语言设计好不同的规则就可以对其进行代码扫描,完成代码检查任务了。如果能将其放到一个工具中完成,那么人工可以完全不参与,是一个完全自动化的流程。这也就导致了通过代码扫描完成的代码检查工作只是一个代码预定规则的检查,并不能保障其编写逻辑符合预期设计,同时如果预定规则不合理那么代码扫描的结果的偏差就会很大。


新工具Qodana


从上面的内容可以看出,代码扫描虽然尤其优越性也有其弊端,但是如果有很好的开放性的工具完成,通过修订并选取合适的规则是可以达到质量保障的预期的。在代码扫描的工具上选择并不多,如果站在平台化、服务化的角度,并且兼顾CI流水线的需求。每次说到静态代码扫描,相信所有人第一个想到的就是SonarQube,除了SonarQube我今天给你介绍一款JetBrains Qodana,Qobana 是 JetBrains 系列工具的新代码质量平台。官方地址如下:https://www.jetbrains.com/qodana

image.png


使用方法

Qodana提供了Docker的运行方式,那么我们仅需要拉取对应的docker image就可以在呢运行了,具体步骤如下:

- 1、 拉取Qodana的linter 镜像

docker pull jetbrains/qodana-<linter>

其中,Qodana的linter目前提供的种类如下:

image.png


具体可以进入官网自己查看。但运行pull命令后,如下:

image.png


- 2、当下载结束后,可以通过如下命令,进行扫描了。

docker run --rm -it -v <project-root-directory>/:/data/project/  -p 8080:8080 jetbrains/qodana-<linter> --show-report

image.png



- 3、当分析结束后,进入 http://localhost:8080,就可以看到结果了。


image.png


在第一次运行期间,Qodana仅使用重要检查指标来分析被测试项目。非重要检查和包含非重要代码的文件夹(如 Tests 文件夹)将被忽略。Qodana还报告了任何可能影响结果真实性或完整性的情况。例如,如果项目依赖于外部资源或生成的代码,而这些资源或生成的代码在分析过程中不可用,则最终结果可能会受到影响,Qodana会通知此类可疑结果。


Qodana提供了建立技术债的baseline的功能,这样我们就可以在baseline之上完成技术债的偿还。(Qodana将baseline存入qodana.sarif.json文件中)。下次一检测我们就可以基于这个baseline进行分析。

docker run -p 8080:8080 -v <project-root-directory>:/data/project jetbrains/qodana-<linter> --show-report --baseline=baseline.sarif.json


image.png


具体Qodana好不好用,你可以在自己的项目中试一下。


目录
相关文章
|
索引 存储 数据库
数据库设计规范
基于阿里数据库设计规范扩展而来
48916 4
|
关系型数据库 MySQL Linux
SonarQube启动不了的问题解决
SonarQube启动不了的问题解决
SonarQube启动不了的问题解决
|
缓存 Linux 开发工具
CentOS 7- 配置阿里镜像源
阿里镜像官方地址http://mirrors.aliyun.com/ 1、点击官方提供的相应系统的帮助 :2、查看不同版本的系统操作: 下载源1、安装wget yum install -y wget2、下载CentOS 7的repo文件wget -O /etc/yum.
251987 0
|
5月前
|
人工智能 搜索推荐 程序员
用 Go 语言轻松构建 MCP 客户端与服务器
本文介绍了如何使用 mcp-go 构建一个完整的 MCP 应用,包括服务端和客户端两部分。 - 服务端支持注册工具(Tool)、资源(Resource)和提示词(Prompt),并可通过 stdio 或 sse 模式对外提供服务; - 客户端通过 stdio 连接服务器,支持初始化、列出服务内容、调用远程工具等操作。
1351 4
|
编解码
FFmpeg开发笔记(三十三)分析ZLMediaKit对H.264流的插帧操作
《FFmpeg开发实战》书中3.4.3节讲解如何将H.264流封装成MP4。H.264流通常以SPS→PPS→IDR帧开始,这一说法通过雷霄骅的H264分析器得到验证。分析器能解析H.264文件但不支持MP4。ZLMediaKit服务器在遇到I帧时会自动插入SPS和PPS配置帧,确保流符合标准格式。若缺少这些帧,客户端拉流时会报错。FFmpeg开发实战:从零基础到短视频上线》书中提供了更多FFmpeg开发细节。
372 0
FFmpeg开发笔记(三十三)分析ZLMediaKit对H.264流的插帧操作
|
安全 Linux 网络安全
【工具使用】几款优秀的SSH连接客户端软件工具推荐FinalShell、Xshell、MobaXterm、OpenSSH、PUTTY、Terminus、mRemoteNG、Terminals等
【工具使用】几款优秀的SSH连接客户端软件工具推荐FinalShell、Xshell、MobaXterm、OpenSSH、PUTTY、Terminus、mRemoteNG、Terminals等
113681 0
|
JavaScript 前端开发 API
组合API:掌握Vue的组合式API(Composition API)
【4月更文挑战第24天】Vue.js的组合式API是Vue 3中的新特性,旨在提供更灵活的组件逻辑组织方式。它允许开发者像React Hooks一样定义和复用逻辑单元——组合函数。通过组合函数,可以跨组件共享和管理状态,提升代码复用和维护性。本文介绍了如何开始使用组合式API,包括安装Vue CLI、引入API、使用组合函数以及组织和复用逻辑。掌握组合式API能增强开发复杂应用的能力,改善代码结构和可读性。
337 2
|
存储 监控 数据可视化
Golang链路追踪:实现高效可靠的分布式系统监控
Golang链路追踪:实现高效可靠的分布式系统监控
|
缓存 算法 Oracle
一文解读业务平台升级JDK11的适配之路
业务平台升级JDK11,基于两个出发点:一、jdk8于2019年1月停止维护,springboot2.1之后的版本已经兼容JDK11,springboot3.0完全放弃对JDK8的支持,未来属于更高版本的JDK;二、在试点国产化芯片的过程中,由于JDK8对Arm架构的优化不足,导致国产化芯片无法发挥自身的性能优势,为了更好的适配国产化,务必要求对JDK版本进行升级。基于上述两个出发点,业务平台于21年12月启动了对JDK版本升级的适配之路。这里回顾整个升级过程,对升级过程中的问题做一下记录
19535 13
一文解读业务平台升级JDK11的适配之路