如何在Xamarin iOS/Android流水线构建任务前替换JSON配置值

我之前做Xamarin.Forms项目时也碰到过类似需求，毕竟Xamarin的项目结构和.NET Core不太一样，Azure Pipeline的File Transform任务确实没法直接套用。这里给你三个可行的方案，你可以根据自己的偏好选择：

方案一：用PowerShell脚本直接修改JSON文件 #

这个方法最直接，不需要依赖特殊任务，直接定位到共享项目里的appsettings.json文件，用脚本替换指定键的值。

步骤： #

1. 在Azure Pipeline的YML中，根据不同的构建阶段定义对应的配置变量：

   stages:
   - stage: DebugBuild
     variables:
       ApiUrl: 'http://google.com'
     jobs:
     - job: BuildDebug
       steps:
       # 先执行脚本修改配置，再执行构建任务
       - task: PowerShell@2
         inputs:
           targetType: 'inline'
           script: |
             # 替换成你实际的共享项目文件夹路径
             $jsonPath = "$(Build.SourcesDirectory)/YourSharedProjectName/appsettings.json"
             # 读取并解析JSON内容
             $jsonContent = Get-Content $jsonPath -Raw | ConvertFrom-Json
             # 替换url字段的值
             $jsonContent.url = "$(ApiUrl)"
             # 将修改后的内容写回文件
             $jsonContent | ConvertTo-Json -Depth 10 | Set-Content $jsonPath
       # 后续添加你的Xamarin构建任务（比如XamarinAndroid@1或XamariniOS@1）
   
   - stage: ReleaseBuild
     variables:
       ApiUrl: 'http://amazon.com'
     jobs:
     - job: BuildRelease
       steps:
       - task: PowerShell@2
         inputs:
           targetType: 'inline'
           script: |
             $jsonPath = "$(Build.SourcesDirectory)/YourSharedProjectName/appsettings.json"
             $jsonContent = Get-Content $jsonPath -Raw | ConvertFrom-Json
             $jsonContent.url = "$(ApiUrl)"
             $jsonContent | ConvertTo-Json -Depth 10 | Set-Content $jsonPath
       # 同样添加对应的构建任务
   

2. 记得把脚本里的YourSharedProjectName替换成你实际的共享项目文件夹名称，确保路径正确。

方案二：利用编译常量直接在代码中赋值（更简洁） #

如果不想折腾文件操作，这个方法更省心——直接在代码里根据构建配置（Debug/Release）返回对应的URL，完全不需要修改appsettings.json。

步骤： #

1. 在共享项目中创建一个静态配置类：

   public static class AppConfiguration
   {
       public static string ApiUrl { get; }
   
       static AppConfiguration()
       {
   #if DEBUG
           ApiUrl = "http://google.com";
   #else
           ApiUrl = "http://amazon.com";
   #endif
       }
   }
   

2. 在应用代码里直接使用AppConfiguration.ApiUrl即可，不需要再读取appsettings.json。
3. 在Azure Pipeline的构建任务中，确保BuildConfiguration参数设置为对应的Debug或Release：

   # 以Android构建为例
   - task: XamarinAndroid@1
     inputs:
       projectFile: '**/*droid*.csproj'
       outputDirectory: '$(Build.BinariesDirectory)/Android'
       configuration: '$(BuildConfiguration)' # 该变量在Debug阶段设为Debug，Release阶段设为Release
   

方案三：调整文件结构适配File Transform任务 #

如果你一定要用Azure Pipeline内置的File Transform任务，可以通过临时复制文件的方式来满足它的路径要求：

步骤： #

1. 提前在项目根目录创建transforms文件夹，里面放两个转换文件：
   • appsettings.Debug.json：

     {
       "url": "http://google.com"
     }
     

   • appsettings.Release.json：

     {
       "url": "http://amazon.com"
     }
     

2. 在Pipeline YML中添加以下步骤（放在构建任务之前）：

   # 1. 把共享项目的appsettings.json复制到临时目录
   - task: CopyFiles@2
     inputs:
       SourceFolder: '$(Build.SourcesDirectory)/YourSharedProjectName'
       Contents: 'appsettings.json'
       TargetFolder: '$(Build.ArtifactStagingDirectory)/tempConfig'
   
   # 2. 用File Transform任务执行配置替换
   - task: FileTransform@2
     inputs:
       folderPath: '$(Build.ArtifactStagingDirectory)/tempConfig'
       fileType: 'json'
       targetFiles: 'appsettings.json'
       transformFiles: '$(Build.SourcesDirectory)/transforms/appsettings.$(BuildConfiguration).json'
   
   # 3. 把修改后的文件复制回共享项目目录
   - task: CopyFiles@2
     inputs:
       SourceFolder: '$(Build.ArtifactStagingDirectory)/tempConfig'
       Contents: 'appsettings.json'
       TargetFolder: '$(Build.SourcesDirectory)/YourSharedProjectName'
       OverWrite: true
   

3. 同样要确保BuildConfiguration变量在不同阶段设置为Debug或Release，这样会自动匹配对应的转换文件。

我个人更推荐方案一或方案二，方案一适合需要保留JSON配置文件的场景，方案二则更简洁，减少文件操作的潜在问题。

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