Xamarin.Forms自定义配置文件如何实现Manage User Secrets密钥管理

核心逻辑 #

采用配置加载优先级策略：本地开发环境下，用户自定义密钥配置 > 项目内置的appsettings.json配置，发布阶段自动屏蔽本地密钥读取逻辑，和你现有Azure DevOps流水线替换配置的逻辑完全兼容，互不冲突。

具体实现步骤 #

• 第一步：约定本地密钥存储规则
  优先选择应用沙盒目录存储密钥，无需额外申请权限，也可以和.NET Web项目的User Secrets路径保持统一，方便统一管理：
  • 安卓模拟器：沙盒目录路径为/data/data/<你的应用包名>/files/secrets.json
  • iOS模拟器：沙盒目录路径为~/Library/Developer/CoreSimulator/Devices/<模拟器ID>/data/Containers/Data/Application/<应用ID>/Documents/secrets.json
  • 也可直接复用Web项目的用户密钥路径，Windows端为%APPDATA%\Microsoft\UserSecrets\<项目唯一标识ID>\secrets.json，Mac端为~/.microsoft/usersecrets/<项目唯一标识ID>\secrets.json
• 第二步：新增密钥加载逻辑
  在原有appsettings.json加载逻辑后，新增DEBUG模式下的本地密钥读取、合并逻辑：

public static AppSettings LoadAppSettings()
{
    // 你原有读取appsettings.json的逻辑
    var appSettings = ReadDefaultAppSettings();

#if DEBUG
    // 本地开发环境才加载用户密钥
    var secretsPath = GetUserSecretsFilePath(); // 按你约定的路径自行实现路径拼接方法
    if (File.Exists(secretsPath))
    {
        var secretsContent = File.ReadAllText(secretsPath);
        // 合并配置，用户密钥的同名key会覆盖默认配置
        JsonConvert.PopulateObject(secretsContent, appSettings);
    }
#endif
    return appSettings;
}

• 第三步：配置文件忽略规则
  在.gitignore文件中添加本地密钥文件的匹配规则，避免敏感信息误提交到代码仓库。
• 第四步：添加快捷操作入口（可选）
  可通过Visual Studio自定义项目右键菜单，实现一键打开本地密钥文件的功能，操作体验和Web项目的Manage User Secrets完全一致。

注意事项 #

• Release编译时会自动剔除DEBUG宏包裹的代码，不会影响线上版本逻辑，也不会泄露本地开发配置
• 原有Azure DevOps流水线替换appsettings.json敏感密钥的逻辑无需做任何调整

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