如何在Xamarin应用中使用JSON保存本地文本数据？

核心流程 #

整体逻辑很清晰：将需要保存的文本数据映射为实体类，序列化转为JSON字符串后写入本地文件；读取时反向操作——读取文件内容，反序列化为实体类即可离线使用。

1. 定义数据模型 #

先根据你的文本数据结构，创建对应的C#实体类，比如要保存带时间戳的文本内容：

public class SavedTextEntry
{
    public int Id { get; set; }
    public string TextContent { get; set; }
    public DateTime SaveTime { get; set; }
}

注：字段可以根据实际需求增减，比如添加分类标签等。

2. 获取跨平台本地存储路径 #

Xamarin提供了统一的API获取应用专属的本地存储目录，不用单独处理iOS/Android差异：

private string GetLocalJsonFilePath()
{
    // 获取应用专属本地存储目录
    string appDataFolder = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
    // 拼接JSON文件名
    return Path.Combine(appDataFolder, "OfflineTexts.json");
}

这个目录是应用私有目录，不会被其他应用访问，卸载应用时会被清除（符合常规数据存储需求）。

3. 序列化并保存数据 #

可以选择Newtonsoft.Json（NuGet包）或.NET内置的System.Text.Json来序列化数据，下面以Newtonsoft.Json为例：

// 保存单条文本数据（支持追加到已有数据）
public void SaveTextEntry(SavedTextEntry newEntry)
{
    string filePath = GetLocalJsonFilePath();
    // 先读取已有数据
    List<SavedTextEntry> existingEntries = LoadAllSavedTexts();
    
    // 添加新数据
    existingEntries.Add(newEntry);
    // 序列化为格式化的JSON字符串
    string jsonContent = JsonConvert.SerializeObject(existingEntries, Formatting.Indented);
    
    // 写入文件
    File.WriteAllText(filePath, jsonContent);
}

如果用System.Text.Json，替换序列化代码为：

string jsonContent = JsonSerializer.Serialize(existingEntries, new JsonSerializerOptions { WriteIndented = true });

4. 读取并反序列化数据 #

读取本地文件，将JSON转回实体类集合：

public List<SavedTextEntry> LoadAllSavedTexts()
{
    string filePath = GetLocalJsonFilePath();
    // 文件不存在时返回空列表
    if (!File.Exists(filePath))
    {
        return new List<SavedTextEntry>();
    }
    
    string jsonContent = File.ReadAllText(filePath);
    // 反序列化，失败时返回空列表
    return JsonConvert.DeserializeObject<List<SavedTextEntry>>(jsonContent) ?? new List<SavedTextEntry>();
}

5. 关键注意点 #

• 异步操作：如果在UI线程执行文件读写，建议用异步方法（File.WriteAllTextAsync、File.ReadAllTextAsync），避免卡顿UI。
• 依赖安装：使用Newtonsoft.Json需要在项目中安装Newtonsoft.Json NuGet包；System.Text.Json无需额外安装（Xamarin.Forms 5.0+/.NET MAUI兼容）。
• 数据兼容性：如果后续修改实体类结构，建议给字段添加[JsonProperty("字段名")]特性，指定固定的JSON字段名，避免结构变化导致反序列化失败。

内容的提问来源于stack exchange，提问作者Kostenetskiy Stanislav