如何为MAUI应用部署初始默认偏好设置？

下面是几种实用的方案，比单纯用XML初始化更优雅，且能实现部署时自带默认设置的需求：

方案1：嵌入默认配置文件，首次启动同步到Preferences #

将默认设置存为嵌入的JSON文件，应用首次启动时读取并写入Preferences，后续直接从Preferences读取即可。

步骤： #

1. 在项目中添加DefaultSettings.json文件，设置其生成操作为「嵌入的资源」。文件内容示例：

{
  "Theme": "Light",
  "NotificationEnabled": true,
  "FontSize": 14
}

2. 在App.xaml.cs的启动逻辑中初始化：

protected override void OnStart()
{
    // 检查是否已完成默认设置初始化
    if (!Preferences.ContainsKey("SettingsInitialized"))
    {
        // 读取嵌入的配置文件
        var assembly = typeof(App).Assembly;
        var resourceName = $"{assembly.GetName().Name}.DefaultSettings.json";
        
        using var stream = assembly.GetManifestResourceStream(resourceName);
        using var reader = new StreamReader(stream);
        var json = reader.ReadToEnd();
        var defaultSettings = System.Text.Json.JsonSerializer.Deserialize<Dictionary<string, object>>(json);

        // 将默认值写入Preferences
        foreach (var setting in defaultSettings)
        {
            switch (setting.Value)
            {
                case bool boolVal:
                    Preferences.Set(setting.Key, boolVal);
                    break;
                case int intVal:
                    Preferences.Set(setting.Key, intVal);
                    break;
                case string strVal:
                    Preferences.Set(setting.Key, strVal);
                    break;
                // 按需支持更多数据类型
            }
        }

        // 标记初始化完成，避免重复执行
        Preferences.Set("SettingsInitialized", true);
    }
}

方案2：利用MAUI配置系统（appsettings.json） #

借助.NET的配置系统，将默认设置放在appsettings.json中，启动时同步到Preferences，还能支持不同环境的配置差异。

步骤： #

1. 添加appsettings.json文件，设置生成操作为「内容」，复制到输出目录为「如果较新则复制」。内容示例：

{
  "DefaultSettings": {
    "Theme": "Light",
    "NotificationEnabled": true,
    "FontSize": 14
  }
}

2. 在App.xaml.cs中读取配置并初始化：

public App()
{
    InitializeComponent();

    // 构建配置对象
    var config = new Microsoft.Extensions.Configuration.ConfigurationBuilder()
        .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
        .Build();

    var defaultSettings = config.GetSection("DefaultSettings");

    if (!Preferences.ContainsKey("SettingsInitialized"))
    {
        Preferences.Set("Theme", defaultSettings["Theme"]);
        Preferences.Set("NotificationEnabled", bool.Parse(defaultSettings["NotificationEnabled"]));
        Preferences.Set("FontSize", int.Parse(defaultSettings["FontSize"]));
        Preferences.Set("SettingsInitialized", true);
    }
}

方案3：自定义设置服务（封装默认值逻辑） #

创建一个单例服务封装设置的读写逻辑，默认值直接硬编码在服务中，首次读取时自动写入Preferences，代码更整洁且易于维护。

步骤： #

1. 实现SettingsService类：

public class SettingsService
{
    // 定义默认设置
    private readonly Dictionary<string, object> _defaultSettings = new()
    {
        { "Theme", "Light" },
        { "NotificationEnabled", true },
        { "FontSize", 14 }
    };

    public T GetSetting<T>(string key)
    {
        if (!Preferences.ContainsKey(key))
        {
            // 若不存在则写入默认值
            var defaultValue = (T)_defaultSettings[key];
            SetSetting(key, defaultValue);
            return defaultValue;
        }

        // 读取已有值，无则返回类型默认值
        return Preferences.Get<T>(key, default);
    }

    public void SetSetting<T>(string key, T value)
    {
        Preferences.Set(key, value);
    }
}

2. 在MauiProgram.cs中注册为单例：

builder.Services.AddSingleton<SettingsService>();

3. 在设置页面的ViewModel中注入使用：

public class SettingsViewModel
{
    private readonly SettingsService _settingsService;

    public string Theme
    {
        get => _settingsService.GetSetting<string>("Theme");
        set => _settingsService.SetSetting("Theme", value);
    }

    public bool NotificationEnabled
    {
        get => _settingsService.GetSetting<bool>("NotificationEnabled");
        set => _settingsService.SetSetting("NotificationEnabled", value);
    }

    public int FontSize
    {
        get => _settingsService.GetSetting<int>("FontSize");
        set => _settingsService.SetSetting("FontSize", value);
    }

    public SettingsViewModel(SettingsService settingsService)
    {
        _settingsService = settingsService;
    }
}

方案对比 #

• 嵌入JSON文件：适合默认值较多、需要灵活修改默认值（无需修改代码）的场景，缺点是修改后需重新打包应用。
• Appsettings.json：和.NET生态一致，支持环境配置（如开发/生产环境不同默认值），适合熟悉ASP.NET配置系统的开发者。
• 自定义设置服务：代码封装性好，逻辑清晰，适合设置逻辑复杂、默认值无需频繁修改的场景。

内容的提问来源于stack exchange，提问作者Álvaro García