SonarQube

在给新项目接入扫描、迁移流水线、调整账号权限，还有令牌到期了以后，常常会碰到一类问题，那就是SonarQube的扫描令牌，到底应该怎么去配置它，还有，一旦那个令牌失效了，为什么项目就没法再继续分析了，SonarQube的扫描令牌，它可不是一串普普通通的字符串，这个东西，代表的是某一个用户，或者是某一个项目，它所拥有的分析权限，按照官方文档的说明，令牌是可以被拿来执行分析用的，用的时候，不需要把真实的账号密码给暴露出去；但是呢，在跑分析的时候，那个令牌所对应的用户，他必须得拥有，对这个项目的执行分析的权限。

如果不想让`target`、`dist`、`build`、`generated`、`node_modules`这类目录被当成手写的代码来分析，就得靠SonarQube的排除规则，它支持通过路径匹配的方式，去把那些文件给排除掉，这个设置，既可以在项目的页面上去完成，也可以写在CI/CD主机上的扫描参数里面；不过有一点要注意，要是同一个参数，在两个地方都设置了，那CI/CD里的参数，是会优先于页面上的设置的。

很多团队一上来就先往`.gitlab-ci.yml`里塞扫描命令，结果跑是能跑，后面要么MR不出结果，要么质量门禁没法拦合并，要么分支和MR参数还互相打架。SonarQube官方文档把这条链路拆得很清楚，GitLab CI集成至少有三步，先在SonarQube里把项目建好并和GitLab关联，再把分析任务接进GitLab CI/CD，最后再让MR分析和质量门禁结果回写到GitLab。真正稳的做法，不是先写脚本，而是先把项目绑定、扫描入口和MR触发条件摆顺。

部署SonarQube时，先不要急着选安装包，更关键的是先把运行方式想清楚。SonarSource官方文档现在把这条线写得很明确，服务端部署主线就是先检查服务器要求和Java版本，再准备数据库，然后按ZIP或Docker方式完成基础安装；如果只是测试，可以先用内置H2，但生产环境不建议这样做，而且官方明确建议生产库与SonarQube主机分离部署。

SonarQube质量门禁不通过，先别直接翻全量Issue列表，最快的办法是先确认失败条件属于新代码还是全量代码，再沿着失败条件跳转到对应的证据页。因为质量门禁的每个条件都绑定到新代码或全量代码，两者口径不同，定位路径也不同。

在一条流水线被长期接入之后，经常会出现一类问题，就是SonarQube里面的历史分析记录，该怎么样去清理一下，还有它的数据库体积，要是变得太大了，又该怎么去处理，项目每天都在那跑扫描、分支被反反复复地创建、版本号也在不停地变化，这么一来，数据库就会慢慢地变大，SonarQube它自己，其实是有一套后台维护机制的，它会在新的分析被执行完了以后，去清理掉一部分旧的数据、旧的历史快照、PR的分析，还有分支的记录，靠着这个，来减缓数据库的膨胀，官方的文档里也说明了，那些旧的分析，是不会被完完整整地一直保留着的，不然的话，数据库就会变得臃肿不堪。

做SonarQube扫描时，很多人一看到失败就先去改项目配置，结果改了半天，真正的问题其实可能在令牌、服务器地址、证书、代理，或者服务器后台任务本身。Sonar官方文档把这件事拆得很清楚：分析参数里有一批必须在CI/CD主机上设置的基础项，分析失败时又要分别看Scanner侧和Server侧的日志；如果网络链路里还有代理、HTTPS或自签名证书，排查顺序还会再往网络层延伸。把这些层次分开看，扫描失败这件事通常会比一上来就反复重跑更容易收住。

SonarQube里与安全相关的告警，既有Vulnerability这类可被利用的漏洞，也有Security Hotspot这类需要人工复核的安全敏感点。处理时如果不先分清类型与口径，很容易把热点当漏洞硬修，或把真实漏洞当成可忽略项拖延。下面按“先处理再排序”的顺序，把日常可复用的操作路径写清楚。

在团队落地SonarQube时，很多规则看起来够用，但一到具体代码风格与合规要求，就会出现想加严某个阈值、想把某类问题单独拎出来、想让不同团队用不同口径的需求。要把这件事做稳，思路是先用规则模板快速生成可维护的自定义规则，再用质量配置文件也称为Quality Profile把规则集合分发到项目，并用备份与回滚把变更变成可追溯动作。

sonarQube升级后出现登录失败，常见不是账号本身突然失效，而是数据库迁移未完成、反向代理与服务器地址不一致、或外部认证接入在新版本下触发了回调与权限问题。排查时先把实例是否已完成迁移与索引重建确认清楚，再把登录链路与认证配置逐段拆开看日志，通常能把问题收敛到一两处可操作的点。

在企业想要统一账号体系的时候，有两件事是需要处理的，一件是怎么把SonarQube接入到LDAP的登录里去，另一件是用户和组的映射关系，又要怎么去配置好，SonarQube是可以把认证这件事，委托给LDAP或者是Active Directory去做的，当一个用户第一次登录成功了以后，SonarQube里面就会自动地给他建好一个账号，等到后面他再登录的时候，也都会去同步他的用户名、邮箱，还有一些可以选择的组的关系，按照官方文档给出的说明，去接入LDAP这件事，主要是靠在安装目录下面，去修改conf文件夹里面的配置文件来完成的，等改完了以后再去重启一下服务，然后通过看日志，来确认跟LDAP的连接是不是真的通了。

SonarQube的质量配置文件，它本质上就是决定了，某一种语言在跑代码分析的时候，到底会启用哪些规则，一个项目扫描出来的那些问题，也会受到它当前绑定的那个配置文件的影响，按照SonarQube的文档说明，质量配置文件，就是用来定义在分析代码的时候，要应用的那一套规则集合的，而且每一种语言，都可以有它自己专属的配置文件。

SonarQube扫描慢，很多时候不是服务器本身有问题，而是把三类事情混在了一起，一类是分析范围太大，一类是缓存没有真正用起来，还有一类是并发开法和语言插件本身的机制没对上。SonarSource官方文档写得很清楚，增量分析里的analysis cache是按分支管理的，扫描前会先下载缓存，扫描后再按规则回写；但并发并不是一个所有语言通用的总开关，而是由不同语言分析器分别控制。也就是说，先分清你慢在范围、缓存，还是线程，后面才调得准。

很多团队把安全热点当成漏洞去清单式消灭，结果要么误修一堆本来就安全的写法，要么把真正的漏洞淹没在噪声里。围绕SonarQube安全热点怎么用，SonarQube安全热点与漏洞问题怎么区分，抓住一个原则就够了：热点先人工复核再定性，漏洞确认即刻修复并纳入门禁。

SonarQube的规则生效载体不是单条规则开关，而是质量配置文件也叫Quality Profile，按语言维度生效，再由项目绑定决定最终用哪一套。你要把规则配置做稳，顺序应当是先建规则集载体，再分配到项目，最后做变更后的生效核对与回滚预案，否则很容易出现改了规则但项目不生效的错觉。

在代码扫描刚刚落地的时候，有两个问题是挺常碰到的，一个是SonarQube扫出来的问题，到底要怎么去分配给具体的人来处理，另一个是，这些问题它的状态变来变去，又要怎么去管，扫描出来的结果一多，要是没有个明确的负责人，那些问题就会长时间地挂在列表里面；可要是大家随便地就把状态给改成了已接受，或者是误报，那到了后面，再去搞质量门禁、版本复盘，还有审计说明的时候，就会很难说得清楚了。SonarQube在分析的时候，它会试着把新发现的问题，自动分配给，最后改过那一行代码的人，但这有个前提，就是代码提交时候用的那个账号，得能跟SonarQube里面的用户，关联得上；要是关联不上，那它就会去用项目里设好的那个默认处理人。

做SonarQube权限管理时，最容易乱的地方，不是按钮找不到，而是把全局权限、项目权限和令牌管理混成了一层。SonarSource官方文档把这条线分得很清楚，全局权限在【Administration】【Security】【Global Permissions】里管理，项目相关权限更多通过权限模板和项目级权限页来落地；而Token又是另一条独立链路，既有用户自己生成和轮换的分析令牌，也有管理员代用户生成或撤销的用户令牌。换句话说，权限和Token虽然都在安全域里，但真正稳的做法是分层治理。

很多人装SonarQube时，前面把压缩包解开了，后面一启动就报错，于是第一反应是怀疑安装包有问题。其实SonarQube官方文档把安装链路写得很清楚，真正高频的失败点通常集中在三层，也就是Java版本不对、数据库配置没接好，以及Linux主机没有满足Elasticsearch启动前置条件。只要把这三层顺着排下来，大多数安装问题都能比较快收住。

SonarQube在网页里看趋势很方便，但到了里程碑评审、对外交付、审计留档，就需要把同一时间点的报告与数据“固化”为文件，并且能说清楚分支口径、筛选条件与拉取时间。否则很容易出现今天导出的数据和下周再看不一致，最后只能靠截图解释，证据强度不够。下面按导出与归档两条线，把操作路径与常见坑一次讲透。

同一套代码在sonarQube里突然“满屏告警”，多数不是代码质量一夜变差，而是规则口径、扫描范围、分支与新代码基线没有对齐，导致历史债与噪声一起涌进来。要把命中数量压到可治理的水平，关键是先把问题分层，只让团队当下要管的东西进入门禁，再把规则集按语言与团队成熟度分配到位，最后用一套例外管理把误报与可接受偏差收口。