如何通过TeamCity更新.NET Core项目中的appsettings.json文件

当然有替代方案啦！在.NET Core生态里，虽然没有像传统.NET那样直接提供XmlPeek/XmlPoke的MSBuild任务，但我们有好几种灵活的方式来更新appsettings.json里指定键的值，完美适配TeamCity的构建流程。下面给你分享几个实用的方案：

方案1：PowerShell脚本（最通用，无需额外工具） #

PowerShell原生支持JSON解析和修改，TeamCity又能直接运行PowerShell脚本，这绝对是最省心的方案。

你可以写一段这样的脚本：

# 读取appsettings.json的内容并转为JSON对象
$jsonContent = Get-Content -Path "./appsettings.json" -Raw | ConvertFrom-Json
# 更新指定键的取值（这里可以替换成TeamCity的参数）
$jsonContent.keyofjson = "%teamcity.custom.newValue%"
# 将修改后的内容写回文件，-Depth参数避免嵌套JSON被截断
$jsonContent | ConvertTo-Json -Depth 10 | Set-Content -Path "./appsettings.json"

在TeamCity中配置： #

• 添加一个PowerShell类型的构建步骤
• 选择“执行脚本文件”或者直接在“脚本内容”里粘贴上面的代码
• 把%teamcity.custom.newValue%替换成你在TeamCity中定义的参数（比如提前设置一个newValue参数，用来传入要更新的值）

这个方案还支持嵌套键的修改哦，比如要改Logging.LogLevel.Default，只需要把$jsonContent.keyofjson改成$jsonContent.Logging.LogLevel.Default就行。

方案2：TeamCity File Content Replacer插件（零代码） #

如果你不想写脚本，可以用TeamCity官方的File Content Replacer插件，直接通过界面配置文本替换规则。

配置步骤： #

1. 在TeamCity服务器上安装File Content Replacer插件（从TeamCity插件市场就能找到）
2. 添加一个File Content Replacer类型的构建步骤
3. 设置要修改的文件路径为appsettings.json
4. 配置替换规则：
   • 查找模式用正则表达式："keyofjson":"([^"]+)"
   • 替换为："keyofjson":"%newValue%"
5. 保存并运行构建

这个方案适合简单的顶级键替换，不需要处理复杂的JSON结构，零代码就能搞定。

方案3：自定义.NET工具（适合复杂场景） #

如果你的JSON结构特别复杂，或者需要更严谨的JSON处理逻辑，可以写一个简单的.NET控制台工具来专门处理更新操作。

比如写一个这样的小工具：

using System;
using System.IO;
using System.Text.Json;

namespace AppSettingsUpdater
{
    class Program
    {
        static void Main(string[] args)
        {
            if (args.Length != 3)
            {
                Console.WriteLine("用法: AppSettingsUpdater <文件路径> <键名> <新值>");
                return;
            }

            var filePath = args[0];
            var targetKey = args[1];
            var newValue = args[2];

            // 读取并解析JSON
            var jsonBytes = File.ReadAllBytes(filePath);
            using var doc = JsonDocument.Parse(jsonBytes);
            var root = doc.RootElement;

            // 创建修改后的JSON对象
            using var stream = new MemoryStream();
            using var writer = new Utf8JsonWriter(stream, new JsonWriterOptions { Indented = true });
            
            writer.WriteStartObject();
            foreach (var property in root.EnumerateObject())
            {
                if (property.Name.Equals(targetKey, StringComparison.OrdinalIgnoreCase))
                {
                    writer.WriteString(targetKey, newValue);
                }
                else
                {
                    property.WriteTo(writer);
                }
            }
            writer.WriteEndObject();
            writer.Flush();

            // 写回文件
            File.WriteAllBytes(filePath, stream.ToArray());
        }
    }
}

在TeamCity中使用： #

• 把这个工具打包成.NET控制台应用，上传到TeamCity或者作为项目的一部分构建
• 添加一个Command Line类型的构建步骤，执行命令：

  dotnet run --project ./AppSettingsUpdater/AppSettingsUpdater.csproj -- appsettings.json keyofjson %newValue%
  

这个方案适合需要严格校验JSON格式、处理嵌套键或者批量更新的场景，扩展性很强。

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