如何通过外部方式设置TeamCity SonarQube插件的模块列表？

当然有靠谱的方法解决这个问题！针对Maven多模块项目结合TeamCity与SonarQube插件的场景，我整理了几个实用方案，帮你摆脱手动编辑配置的麻烦：

1. 利用TeamCity构建参数 + 动态脚本生成模块列表 #

这是最灵活的方案，适合需要自定义扫描模块范围的场景：

• 步骤1：在TeamCity中定义构建参数
  在项目的「构建参数」里添加一个参数，比如sonar.modules.list，暂时留空或设个默认值。

• 步骤2：添加前置脚本步骤生成模块列表
  在SonarQube扫描步骤之前，新增一个「命令行」构建步骤，用脚本自动获取Maven项目的模块列表，并通过TeamCity服务消息设置参数值：

  • 如果你用Linux/macOS的bash：

    # 获取所有子模块（排除根模块），用逗号分隔
    MODULES=$(mvn reactor:list -Dfmt=plain | grep -v "Root" | tr '\n' ',')
    # 移除最后一个多余的逗号
    MODULES=${MODULES%,}
    # 通知TeamCity设置参数
    echo "##teamcity[setParameter name='sonar.modules.list' value='$MODULES']"
    

  • 如果你用Windows的PowerShell：

    # 获取模块列表并处理格式
    $modules = mvn reactor:list -Dfmt=plain | Where-Object { $_ -notmatch "Root" }
    $modulesStr = $modules -join ","
    # 通知TeamCity设置参数
    Write-Host "##teamcity[setParameter name='sonar.modules.list' value='$modulesStr']"
    

  注：如果你的Maven没有reactor插件，可执行mvn org.apache.maven.plugins:maven-reactor-plugin:list -Dfmt=plain，或者用解析pom.xml的方式（比如xmllint）提取modules节点内容。

• 步骤3：在SonarQube扫描步骤中引用参数
  无论是用Maven命令行执行sonar:sonar，还是用TeamCity的SonarQube插件，都能直接引用这个参数：

  • 用Maven命令行的话，在命令里添加：

    clean verify sonar:sonar -Dsonar.modules=%sonar.modules.list%
    

  • 用TeamCity SonarQube插件的话，在插件配置的「Modules」输入框中直接填写%sonar.modules.list%。

2. 让SonarQube自动识别Maven模块（推荐，零配置） #

如果你的需求是扫描所有Maven子模块，其实根本不需要手动设置Modules参数！SonarQube的Maven插件会自动识别根pom.xml中声明的<modules>节点，递归扫描所有子模块。

只要确保：

• 你的项目是标准的Maven多模块结构，根pom里正确声明了所有子模块
• 执行Sonar扫描时从根目录运行Maven命令（TeamCity的构建工作目录设为项目根目录）

这样新增模块后，只要在根pom里添加<module>节点，SonarQube就会自动扫描新模块，完全不用改TeamCity配置。

3. 通过TeamCity参数化插件配置 #

如果偏好直接在TeamSonarQube插件里配置，也可以利用TeamCity的参数化能力：

• 在TeamCity项目的「构建参数」中添加一个参数（比如sonar.target.modules），用脚本动态赋值（参考方案1的脚本逻辑）
• 打开SonarQube插件的配置页面，在「Modules」字段中输入%sonar.target.modules%
• 这样每次构建时，插件会自动读取这个参数的动态值，无需手动编辑

内容的提问来源于stack exchange，提问作者Andreas Spengler