HTML代码质量把控:SonarQube自定义规则的编写

云婷同学_1674

云婷同学_1674

2026-07-05

468人浏览

原创

sonarqube 默认不检查 img 缺失 alt 属性,因其 html 插件仅做基础结构校验,可访问性规则被视为上下文强相关的自定义业务规则,需手动启用 xpath 规则 //img[not(@alt) or @alt = '']。

html代码质量把控:sonarqube自定义规则的编写

为什么 SonarQube 默认不检查 img 标签缺失 alt 属性

SonarQube 的 HTML 插件(sonar-html-plugin)默认只做基础结构校验,比如标签闭合、嵌套合法性,而语义可访问性规则(如 alt 必填)不在开箱即用范围内——它被归类为“自定义业务规则”,需手动启用或编写。

根本原因在于:SonarQube 将可访问性(a11y)视为上下文强相关的质量维度。例如内部管理后台可能允许图标用 alt="",而对外官网必须非空;默认规则无法安全假设你的业务意图。

  • 检查 img 是否有 alt 属性,属于 XPath 规则范畴,不是 JS/TS 那类 AST 分析
  • HTML 插件底层依赖 jsoup 解析,规则需以 XPath 1.0 表达式定义,不支持 CSS 选择器或正则
  • 若直接在 UI 中添加 XPath 规则但未勾选“Apply to HTML files”,规则会静默失效

如何用 XPath 编写一条强制 img 含非空 alt 的规则

登录 SonarQube 管理后台 → Quality Profiles → 选中目标 HTML 配置集 → Activate more rules → 搜索 “XPath” → 选择 “XPath rule” 并激活。

关键不是写对 XPath,而是写对“能被 jsoup 正确评估”的 XPath——它不支持 normalize-space() 或 string-length() 函数,只能靠属性存在性 + 字符串字面匹配。

html-to-pptx
html-to-pptx

将多页 HTML 演示文稿转换为美化的 PPTX 文件,便于分享和分发。

下载
  • ✅ 正确表达式://img[not(@alt) or @alt = ''](捕获无 alt 或值为空字符串的 img)
  • ❌ 错误写法://img[not(@alt) or normalize-space(@alt) = ''](normalize-space 在 jsoup 中不可用)
  • ⚠️ 注意:该规则会命中 <img alt="">,但不会命中 <img alt=" ">(含空格),后者需额外规则或前端 lint 工具补位
  • 规则参数中,“XPath expression” 填上述表达式,“Message” 建议写明修复方式,例如:“Add non-empty alt attribute for accessibility”

自定义规则上线后为什么没扫描出已知问题

常见原因不是规则写错,而是文件未被纳入 HTML 语言分析范围——SonarQube 默认只把 .html 和 .htm 当作 HTML 文件,而你项目里可能是 .vue、.erb、.njk 或内联 <template></template> 片段。

  • 检查 sonar.language 或 sonar.sources 配置,确认 HTML 插件实际生效的文件后缀列表
  • 若要扫描 .vue 中的 HTML 片段,必须启用 sonar.html.file.suffixes 并追加 .vue(SonarQube ≥ 9.9 支持)
  • 运行扫描时加 -X 参数看 debug 日志,搜索 HtmlVisitor 或 jsoup parsed 关键字,确认目标文件是否被解析
  • 规则仅作用于静态 HTML 文本,对 JS 动态插入的 img(如 document.createElement('img'))完全无感知

要不要把自定义 XPath 规则写进 sonar-project.properties

不要。SonarQube 的 XPath 规则必须在 Web UI 或通过 Web API 注册到 Quality Profile 中,sonar-project.properties 不支持声明式定义 HTML XPath 规则。

你能在配置文件里控制的,只有“是否启用某条已存在的规则”(用 sonar.rules.custom?不存在这个参数),或调整文件识别范围(如 sonar.html.file.suffixes)。

  • 自动化部署规则的唯一可靠方式是调用 SonarQube REST API:api/rules/create + api/qualityprofiles/activate_rule
  • 若团队多人维护,建议将 XPath 表达式和 Message 写入内部 Wiki,并截图保存 Quality Profile 的导出 JSON(api/qualityprofiles/export),避免 UI 误操作丢失
  • 注意:不同 SonarQube 版本对 XPath 函数支持有差异,7.9 和 9.9 的 jsoup 版本不同,同一表达式在旧版可能报 XPath evaluation error

真正难的从来不是写出那行 XPath,而是确认它跑在正确的文件上、被正确的插件加载、且团队知道它为什么对某些 case 失效。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

html

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

5375

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3092

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

2750

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

2779

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4679

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

2741

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2529

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2288

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2288

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习