如何在Azure DevOps构建管道中为.NET Core应用强制执行StyleCop？

要在现有管道中强制执行StyleCop代码规范检查，需要完成项目侧规则配置和管道侧任务添加两部分工作：

一、项目侧配置（本地完成后提交代码） #

1. 安装StyleCop分析器包
   给所有需要检查的业务项目（如Tenant.Api、核心类库等）安装StyleCop.Analyzers NuGet包，可通过命令行执行：

   dotnet add package StyleCop.Analyzers
   

2. 添加并配置StyleCop规则文件
   在解决方案根目录或项目根目录创建stylecop.json文件，将所有规则的严重性设为error（违规时直接导致编译失败），示例配置：

   {
     "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
     "settings": {
       "documentationRules": {
         "xmlDocumentation": {
           "requiredForPublicMembers": true
         }
       },
       "namingRules": {
         "allowHungarianPrefixes": false
       },
       "orderingRules": {
         "usingDirectivesPlacement": "outsideNamespace"
       },
       "severity": {
         "all": "error"
       }
     }
   }
   

   随后在对应项目的.csproj文件中添加引用，确保项目能读取该配置：

   <ItemGroup>
     <AdditionalFiles Include="stylecop.json" />
   </ItemGroup>
   

二、Azure DevOps管道YAML修改 #

在现有管道的单元测试任务之前添加一个dotnet build任务，这样编译阶段就能触发StyleCop检查，一旦有违规会直接终止管道，避免后续的镜像构建和部署操作。

修改后的完整YAML如下：

trigger:
  branches:
    include:
      - main

stages:
  - stage: build_and_deploy_to_dev
    jobs:
      - deployment: DeployToDev
        displayName: Deploy to dev
        pool:
          vmImage: "ubuntu-latest"
        environment: tenant-service-dev
        strategy:
          runOnce:
            deploy:
              steps:
                - checkout: self
                # 新增：执行带StyleCop分析的编译任务
                - task: DotNetCoreCLI@2
                  displayName: Build with StyleCop Analysis
                  inputs:
                    command: build
                    projects: "**/src/**/*.csproj"
                    arguments: "--configuration Release"
                - task: DotNetCoreCLI@2
                  displayName: Execute Unit Tests
                  inputs:
                    command: test
                    projects: "**/UnitTests/**/*.UnitTests.csproj"
                - task: Docker@2
                  displayName: Build And Push Image to Container Registry
                  inputs:
                    containerRegistry: $(DOCKER_REGISTRY_SERVICE_CONNECTION)
                    repository: $(IMAGE_REPOSITORY)
                    command: "buildAndPush"
                    buildContext: "./"
                    Dockerfile: "**/src/Tenant.Api/Dockerfile"
                    tags: |
                      $(TAG)
                      latest  
                - task: Kubernetes@1
                  displayName: Deploy to Dev Kubernetes Cluster
                  inputs:
                    connectionType: Azure Resource Manager
                    azureSubscriptionEndpoint: $(SERVICE_CONNECTION_DEV_)
                    azureResourceGroup: $(RESOURCE_GROUP_DEV)
                    kubernetesCluster: $(K8S_CLUSTER_DEV)
                    command: set
                    arguments: image deployment/$(APP_NAME_DEV) $(K8S_CONTAINER_NAME)=$(CONTAINER_REGISTRY_)/$(IMAGE_REPOSITORY):$(TAG)  --namespace=$(K8S_NAMESPACE)

说明 #

• 由于StyleCop.Analyzers是Roslyn分析器，编译时会自动执行规则检查，只要项目配置中将违规级别设为error，编译失败就会直接终止管道，达到强制执行的效果。
• 提前执行dotnet build任务能在单元测试和镜像构建前就发现代码规范问题，避免无效的后续操作。

内容的提问来源于stack exchange，提问作者One Developer