c++静态代码扫描工具clang-tidy详细介绍

这篇具有很好参考价值的文章主要介绍了c++静态代码扫描工具clang-tidy详细介绍。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

clang-tidy

c++静态代码扫描工具clang-tidy详细介绍,# C、C++,c++,开发语言

1. 什么是clang-tidy

Clang-Tidy是一个由LLVM项目提供的开源工具,是一个静态分析工具,用于进行静态代码分析和代码质量改进。它利用Clang编译器的强大功能,对C++代码进行静态分析,并提供了一系列的代码改进建议和警告。Clang-Tidy是基于Clang的AST(抽象语法树)进行分析,并能检测出许多常见的编码错误和代码风格问题。包括语法错误、逻辑错误、性能问题和风格问题。

2. clang-tidy可以解决什么问题

clang-tidy可以解决各种类型的代码问题,包括:

  1. 代码风格问题:例如缩进、空格、命名规范等。
  2. 可维护性问题:例如不必要的拷贝、错误的类型转换等。
  3. 潜在的编程错误:例如空指针引用、数组越界等。
  4. 性能问题:例如慢速算法、重复计算等。

clang-tidy可以帮助开发人员在编译时发现代码中的错误,这可以帮助开发人员提高代码质量和可靠性。clang-tidy还可以帮助开发人员提高代码风格,这可以使代码更易于阅读和维护。

3. 工作原理

Clang-tidy的工作原理是将源代码传递给Clang编译器,然后通过静态分析找到代码中的问题。Clang编译器是一个基于LLVM的项目,它提供了了一个强大的C++前端,能够解析、编译和优化C++代码。而Clang-tidy则利用了Clang编译器的这些功能,对源代码进行深度分析,并找出其中可能存在的问题。

具体来说,Clang-tidy使用了以下技术:

  1. 静态分析:Clang-tidy使用静态分析技术对源代码进行解析,从而构建出抽象语法树(Abstract Syntax Tree,AST)。通过AST,Clang-tidy能够深入理解代码的逻辑,找出其中可能存在的问题。
  2. 规则引擎:Clang-tidy还使用了一套规则引擎,用来检查代码是否符合特定的规则。这些规则可以是检查潜在的错误、风格问题或性能优化点等。
  3. 修复建议:对于发现的问题,Clang-tidy能够提供一些修复建议。例如,对于一个未初始化的变量,Clang-tidy可以建议将其初始化为零。

4. 如何使用clang-tidy

如何在mac上安装c lang-tidy

我是直接使用brew install llvm后,将工具直接软连接到系统路径下,因为mac本身自带clang编译器,如果将llvm放入系统路径,会对mac自身的环境造成影响。

# 安装指令:
brew install llvm
ln -s "/usr/local/opt/llvm/bin/clang-format" "/usr/local/bin/clang-format"
ln -s "/usr/local/opt/llvm/bin/clang-tidy" "/usr/local/bin/clang-tidy"
# 检查安装情况
(base) ➜  bin clang-format --version
clang-format version 16.0.6
(base) ➜  bin clang-tidy --version
Homebrew LLVM version 16.0.6
  Optimized build.
 find_program(CLANG_TIDY_BIN clang-tidy)
  find_program(RUN_CLANG_TIDY_BIN /usr/local/Cellar/llvm/10.0.0_3/share/clang/run-clang-tidy.py)
    list(APPEND RUN_CLANG_TIDY_BIN_ARGS
         -clang-tidy-binary ${CLANG_TIDY_BIN}
         -header-filter="\".*\\b(cpp-client/src)\""
         -checks=clan*,cert*,misc*,perf*,cppc*,read*,mode*,-cert-err58-cpp,-misc-noexcept-move-constructor,-cppcoreguidelines-*)

    add_custom_target(tidy
                      COMMAND ${RUN_CLANG_TIDY_BIN} ${RUN_CLANG_TIDY_BIN_ARGS}
                      COMMENT "running clang tidy")

主要有二种使用方式:

  1. 使用命令行

    可以直接使用命令行: clang-tidy -checks=all -p my_project my_file.cpp

    但是一般会配合githook同步使用, 在用户add或者commit的时候,触发githook,触发脚本,从而扫描用户修改的文件,达到代码静态扫描的目的。

  2. 使用cmake

    推荐参考项目: github-cmake-cpp-project-template

# 该命令会生成
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
find_program(CLANG_TIDY_BIN NAMES "clang-tidy")
if(CLANG_TIDY_BIN)
  set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_BIN}" "-checks=*")
endif()
  1. 使用脚本

clang-tidy官方脚本

4. 总结

Clang-tidy是一种强大的源代码自动检查与修复工具,它能够帮助开发人员发现并修复代码中的各种问题。通过使用Clang-tidy,我们可以提高开发效率,确保代码的质量和可维护性。在未来,我们期待看到Clang-tidy在更多领域的应用,以及其进一步的改进和优化。

5. 举例说明:

在没有任何特定命令行参数的情况下运行该工具将运行该实用程序启用的默认检查器集。让我们检查一下它还提供了哪些其他检查器(通过传递–checks='*'来查看所有检查器),特别是 grep 查找名称中带有现代化的检查器。这些检查器提倡使用现代语言结构:

$ clang-tidy --list-checks -checks='*' | grep "modernize"
    modernize-avoid-bind
    modernize-deprecated-headers
    modernize-loop-convert
    modernize-make-shared
    modernize-make-unique
    modernize-pass-by-value
    modernize-raw-string-literal
    modernize-redundant-void-arg
    modernize-replace-auto-ptr
    modernize-shrink-to-fit
    modernize-use-auto
    modernize-use-bool-literals
    modernize-use-default
    modernize-use-emplace
    modernize-use-nullptr
    modernize-use-override
    modernize-use-using

选项列表已经令人印象深刻,不是吗?Clang-Tidy 确实开箱即用地提供了一些有趣的检查器(从 Clang/LLVM 3.9 开始),并且列表随着版本的不同而不断增长。

检查器的名称几乎是不言自明的(例如,modernize-use-auto将在适用的情况下使用auto),但如果您想探索每个检查器的含义,请查阅clang-tidy 主页上的检查器列表:

为了展示该工具的使用方式,让我们重点关注现代化使用覆盖检查器,因为它是最适用且最无争议的检查器。

% clang-tidy-3.9 -checks='modernize-use-override' test.cpp -- -std=c++11
1 warning generated.
/home/kfunk/test.cpp:5:18: warning: prefer using 'override' or (rarely) 'final' instead of 'virtual' [modernize-use-override]
    virtual void reimplementMe(int a) {}
                 ^
                                      override

好吧。所以它注意到Derived::reimplementMe(int) 重写了基类方法但缺少override说明符!现在我们可以手动添加…或者只是让该工具通过传递*-fix来为我们完成它!在示例上运行它(启用现代化使用覆盖*检查器和修复功能):

有几件事值得一提:

  • 并非所有clang-tidy 的检查器实际上都带有修复功能,但以现代化开头的检查器都带有修复功能。
  • 您可以同时使用多个检查器中的修复程序(考虑*-checks=‘modernize-use-override,modernize-use-auto’ -fix)*
  • 运行 clang-tidy 会调用完整的 Clang 编译器前端,因此需要一些时间才能完成
  • clang-tidy 的重构结果非常准确,因为它得到了成熟的 C++ 解析器的支持

注意:强烈建议使用run-clang-tidy.py在整个项目上运行 clang-tidy,因为它将并行运行该工具多次并确保并发执行不会相互干扰(例如通过避免并行修改共享标头并进而生成损坏的代码)。

  • 参考:

clang-tidy 官网文章来源地址https://www.toymoban.com/news/detail-617274.html

到了这里,关于c++静态代码扫描工具clang-tidy详细介绍的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • IP扫描工具

    高级 IP 扫描程序是网络中必不可少的工具,使管理员能够跟踪网络地址空间。在提供要扫描的 IP 地址范围时,高级 IP 扫描程序会借助网络扫描协议按顺序检查该范围内的每个 IP,扫描后,高级 IP 扫描程序工具可查看网络 IP 的网络方面,例如 IP 保留状态、关联的 MAC 地址及

    2024年02月16日
    浏览(48)
  • 网络安全工具——AWVS漏洞扫描工具

    请勿乱扫目标,该扫描工具在没有授权的情况下使用是违法的 仅个人使用,不用于商业用途,使用的是15.2版本的破解版 1.下载Acunetix破解版安装包,解压安装包 2.双击允许acunetix_15.2.221208162.exe 3.双击安装包出现下面界面,安装路径可以修改 4.点击下一步填写邮箱、密码。设置

    2024年02月13日
    浏览(50)
  • Nmap扫描工具的使用

    本实验可以在虚拟机中搭建windows系列系统进行操作,建议选择老旧的windows xp,windows 7,windows sever2012等系统,这样可以扫描出很多的漏洞,也方便后面做入侵实验。攻击机可以使用kali linux,被攻击机还有肉鸡使用windows系列系统比较好。 主机探测:Nmap可査找目标网络中的在

    2024年02月13日
    浏览(43)
  • Nmap开源网络扫描工具

    Nmap的官方网站是https://nmap.org/。 在该网站上,您可以找到有关Nmap的详细信息,包括下载最新版本的Nmap软件、文档、教程和其他资源。 更多信息也可以咨询GPT ^^ Nmap是一个开源的网络扫描工具,它用于探测和分析网络上的主机和服务。它可以帮助管理员识别网络上的漏洞和安

    2024年02月16日
    浏览(42)
  • 网络安全:namp扫描工具

      -sP可以扫描一个网段ip以及状态和基本信息,10.1.1.2-3就是扫描2和3这两个ip的主机 -p可以扫描指定ip对应主机的端口号,可以是一个范围 nmap简单扫描:nmap 地址 检查地址是否在线以及open的端口号 在端口开放,不一定可以与对方正常连接或通信。-sT就可以检测是否可以连接

    2024年02月02日
    浏览(42)
  • 常用Web安全扫描工具合集

      漏洞扫描是一种安全检测行为,更是一类重要的网络安全技术,它能够有效提高网络的安全性,而且漏洞扫描属于主动的防范措施,可以很好地避免黑客攻击行为,做到防患于未然。那么好用的漏洞扫描工具有哪些? 答案就在本文! 1、AWVS Acunetix Web Vulnerability Scanner(简称

    2024年04月13日
    浏览(39)
  • 基于python开发端口扫描工具

    本人仍然还在学习阶段,有问题欢迎大佬指正,希望我的文章能够帮助到你.以后我很多东西都会在博客更新,和大家一起进步,加油. 本次博客主要是开发一个端口扫描工具,用python语言,要求要能指定ip,指定c段,指定端口号和端口范围,还有多线程或者线程池实现,提高端口扫描效率

    2024年02月04日
    浏览(40)
  • 域名扫描工具subDomainBrute源码分析

    ​ SubDomainsBrute是一款目标域名收集工具 ,用小字典递归地发现三级域名、四级域名、五级域名等不容易被探测到的域名。字典较为全面,小字典就包括3万多条,大字典多达8万条。默认使用114DNS、百度DNS、阿里DNS这几个快速又可靠的公共DNS进行查询,可随时修改配置文件添加

    2024年02月09日
    浏览(43)
  • Nuclei漏洞扫描工具

    Nuclei漏洞扫描工具:          Nuclei 是一款基于YAML语法模板的开发的定制化快速漏洞扫描器。它使用Go语言开发,具有很强的可配置性、可扩展性和易用性。 提供 TCP、DNS、HTTP、FILE 等各类协议的扫描,通过强大且灵活的模板,可以使用 Nuclei 模拟各种安全检查。 Nucl

    2024年02月15日
    浏览(49)
  • 御剑高速TCP端口扫描工具

    鉴于CSDN平台想恰钱想疯了,连下载个软件也要付费/VIP  那我在这里就无私贡献出珍藏的——御剑高速TCP端口扫描工具 网址:百度网盘 请输入提取码 提取码:7fk6  

    2024年02月13日
    浏览(53)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包