如何在VSTS发布定义中处理WebRole的配置转换

嘿，这个场景我太熟了！你已经搭好了Web.Staging.config和Web.Production.config的基础，接下来只需要在发布流程里做几个配置，就能实现用同一个构建工件给Staging和Production环境分别配置对应连接字符串了。给你几个实用的方案：

这是ASP.NET项目适配多环境配置的原生方案，刚好你已经创建了对应的变换文件，只需要在发布环节启用变换逻辑就行：

• 先确认你的Web.Staging.config和Web.Production.config是嵌套在Web.config下的变换文件（在Visual Studio里应该能看到它们缩进在Web.config下方），如果不是，右键Web.config选择“添加配置变换”重新生成也可以。
• 在你的发布定义中，找到Azure Cloud Service的发布任务：
  • 如果是Azure DevOps的经典发布管道，找到“配置变换”选项，勾选“XML变换”，系统会自动根据你选择的发布环境（Staging/Production）匹配对应的Web.{Environment}.config文件，替换Web.config里的内容。
  • 如果是YAML管道，添加FileTransform任务，指定变换规则，比如：

    - task: FileTransform@1
      inputs:
        folderPath: '$(System.DefaultWorkingDirectory)/**/*.zip'
        xmlTransformationRules: '-transform **/Web.Staging.config -xml **/Web.config'
      condition: eq(variables['Environment'], 'Staging')
    

• 举个变换文件的例子，Web.Staging.config里的连接字符串部分应该这么写（用xdt命名空间指定变换规则）：

  <configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
    <connectionStrings>
      <!-- 匹配name属性，替换对应的connectionString值 -->
      <add name="MyDatabaseConn" 
           connectionString="Server=staging-db01;Database=MyStagingDB;User Id=staging-user;Password=xxx;" 
           xdt:Transform="SetAttributes" xdt:Locator="Match(name)"/>
    </connectionStrings>
  </configuration>
  

如果你的团队更倾向于集中管理所有环境的变量，这个方案更灵活：

• 在Azure DevOps中创建两个变量组：Staging环境变量和Production环境变量，分别添加连接字符串变量，比如ConnectionStrings.MyDatabaseConn，值对应各自环境的连接字符串。
• 在构建定义里，把Web.config中的连接字符串替换成令牌占位符，比如：

  <connectionStrings>
    <add name="MyDatabaseConn" connectionString="#{ConnectionStrings.MyDatabaseConn}#" providerName="System.Data.SqlClient"/>
  </connectionStrings>
  

• 在发布定义中，给Staging环境关联Staging环境变量组，Production环境关联Production环境变量组，然后添加替换令牌任务，配置如下：

  - task: ReplaceTokens@4
    inputs:
      rootDirectory: '$(System.DefaultWorkingDirectory)/**'
      targetFiles: '**/Web.config'
      tokenPattern: 'default'
      tokenPrefix: '#{'
      tokenSuffix: '}#'
  

  这样发布时，系统会自动把令牌替换成对应环境变量组里的值。

因为你部署的是Cloud Service Web Role，也可以用Cloud Service自带的配置文件来管理环境变量：

• 创建ServiceConfiguration.Staging.cscfg和ServiceConfiguration.Production.cscfg，在<ConfigurationSettings>节点里添加连接字符串设置：

  <ServiceConfiguration serviceName="MyCloudService" xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration" osFamily="6" osVersion="*">
    <Role name="MyWebRole">
      <Instances count="1"/>
      <ConfigurationSettings>
        <Setting name="MyDatabaseConn" value="Server=staging-db01;Database=MyStagingDB;..."/>
      </ConfigurationSettings>
    </Role>
  </ServiceConfiguration>
  

• 在Web Role的代码里，通过Cloud Service的API获取配置值：

  using Microsoft.WindowsAzure.ServiceRuntime;
  // 获取连接字符串
  string connString = RoleEnvironment.GetConfigurationSettingValue("MyDatabaseConn");
  

• 在发布定义中，选择对应环境的ServiceConfiguration文件（发布Staging选Staging的cscfg，Production选Production的），发布时Cloud Service会自动加载对应的配置。

总结 #

如果是ASP.NET项目，优先用方案1，因为是原生支持的变换逻辑，配置简单；如果需要跨项目共享变量，或者更灵活的变量管理，选方案2；如果你的配置和Cloud Service角色强相关，方案3是最贴合Cloud Service生态的选择。

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