Avalonia中读写JSON配置文件需用System.Text.Json操作本地文件,关键在于跨平台路径处理、结构匹配的序列化及线程安全保存。

在 Avalonia 中读写 JSON 配置文件,本质是使用 .NET 标准的 JSON 库(如 System.Text.Json)操作本地文件,Avalonia 本身不提供专属 JSON API,但可轻松集成。关键在于:路径处理要适配跨平台、序列化要匹配配置类结构、保存时注意线程安全(尤其从 UI 线程触发)。
定义配置模型类
先创建一个与 JSON 结构一致的 C# 类,推荐用 public 属性 + 默认构造函数,便于自动序列化:
public class AppConfig
{
public string Theme { get; set; } = "Light";
public int WindowWidth { get; set; } = 800;
public bool AutoSave { get; set; } = true;
public string[] RecentFiles { get; set; } = Array.Empty();
} 读取 JSON 配置文件(推荐异步)
使用 System.Text.Json 异步读取,避免阻塞 UI。路径建议放在用户数据目录(跨平台兼容):
- 用
AppDataDirectory获取可靠路径(如 Windows 的%APPDATA%,macOS 的~/Library/Application Support) - 检查文件是否存在,不存在则返回默认配置
- 捕获
JsonException防止格式错误导致崩溃
private static readonly string ConfigPath = Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
"MyApp", "config.json");
public static async Task LoadConfigAsync()
{
if (!File.Exists(ConfigPath))
return new AppConfig();
try
{
var json = await File.ReadAllTextAsync(ConfigPath);
return JsonSerializer.Deserialize(json) ?? new AppConfig();
}
catch (JsonException ex)
{
Console.WriteLine($"JSON 解析失败: {ex.Message}");
return new AppConfig();
} }
保存 JSON 配置到文件(带格式化和原子写入)
写入时建议启用缩进提升可读性,并用临时文件+重命名实现原子保存(避免写到一半崩溃导致配置损坏):
- 序列化到内存字符串或直接写入临时文件
- 写入临时文件后,用
File.Replace原子替换原文件 - 确保目录存在(
Directory.CreateDirectory)
public static async Task SaveConfigAsync(AppConfig config)
{
var tempPath = ConfigPath + ".tmp";
var dir = Path.GetDirectoryName(ConfigPath);
Directory.CreateDirectory(dir);
var options = new JsonSerializerOptions { WriteIndented = true };
var json = JsonSerializer.Serialize(config, options);
await File.WriteAllTextAsync(tempPath, json);
File.Replace(tempPath, ConfigPath, null); // 原子替换}
在 Avalonia ViewModel 中使用示例
在 ViewModel 中封装加载/保存逻辑,绑定到 UI 控件(如 CheckBox、TextBox):
- 初始化时调用
LoadConfigAsync并赋值给属性 - 属性 setter 中不立即保存,而是延迟或由“应用”按钮触发
- 若需实时保存,可用
Task.Run避免阻塞 UI 线程(但慎用高频场景)
private AppConfig _config = new();
public string Theme
{
get => _config.Theme;
set
{
_config.Theme = value;
OnPropertyChanged();
}
}
// 保存方法(例如绑定到 Button.Command)
public async void SaveSettings()
{
await SaveConfigAsync(_config);
}
不复杂但容易忽略:路径权限、JSON 字段名大小写匹配、null 值处理(JsonSerializerOptions.DefaultIgnoreCondition 可控)、以及首次运行时目录/文件的自动创建。用好 System.Text.Json + 合理路径策略,就能稳定支撑 Avalonia 应用的配置管理。










