跨平台开发 / 系统课时

用 File 写入文本和 JSON

用 File 写入文本和 JSON

本节解决把应用中的字符串和结构化数据可靠写入本地文件的问题。你将使用 File.writeAsString 指定 UTF-8 编码,并把 Dart 对象先编码为 JSON,再落到应用文档目录中。

学习目标

  • 使用 File 将文本写入应用目录
  • 使用 jsonEncode 将数据编码后写入 JSON 文件
  • 理解覆盖写入、追加写入与 UTF-8 编码的关键差异

写入前先拿到可持久化目录

移动端不应把业务文件写到任意绝对路径。通常先通过 path_provider 获取应用文档目录,再用 File 组合文件名。下面示例假设项目已经加入 path_provider 依赖。

File 不会替你创建父目录;不过 getApplicationDocumentsDirectory() 返回的应用文档目录通常已经存在。如果还要创建子目录,应先对对应 Directory 调用 create(recursive: true)。

写入文本与 JSON

下面是一个可直接放进 Flutter 项目的完整示例。它先写入普通文本,再把一个 Map<String, dynamic> 编码为 JSON 文件,并把最终内容读回用于验证。

dart
import 'dart:convert';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final Directory directory = await getApplicationDocumentsDirectory();

  final File noteFile = File('${directory.path}/note.txt');
  await noteFile.writeAsString(
    'Flutter local file',
    encoding: utf8,
    flush: true,
  );

  final Map<String, dynamic> settings = <String, dynamic>{
    'theme': 'dark',
    'pageSize': 20,
    'offline': true,
  };

  final File jsonFile = File('${directory.path}/settings.json');
  await jsonFile.writeAsString(
    jsonEncode(settings),
    encoding: utf8,
    flush: true,
  );

  print(await noteFile.readAsString(encoding: utf8));
  print(await jsonFile.readAsString(encoding: utf8));
}

预期输出:

text
Flutter local file
{"theme":"dark","pageSize":20,"offline":true}

实际文件路径由平台和安装位置决定,因此示例只验证文件内容,不依赖固定路径。

控制覆盖、追加与编码

writeAsString 默认使用 FileMode.write,也就是从文件开头写入;已有文件会被截断后覆盖。日志、流水等确实需要追加的场景,可以显式使用 FileMode.append,但配置文件和缓存快照通常更适合整文件覆盖,以免留下旧数据。

片段示例:沿用上一个完整示例中已经创建的 noteFile,只展示追加写入这一处变化。

dart
await noteFile.writeAsString(
  '\nsecond line',
  mode: FileMode.append,
  encoding: utf8,
);

预期结果:

text
note.txt 原有内容后追加一行 second line

文本编码建议显式使用 utf8,这样包含中文、Emoji 或其他非 ASCII 字符时,读写两端的约定一致。JSON 也只是文本格式,所以同样应保持统一编码。

写 JSON 时注意可编码类型

jsonEncode 可以直接处理 null、布尔值、数字、字符串、列表和字符串键的映射。自定义对象不能直接写入 JSON,通常先实现 toJson(),再把结果交给 jsonEncode。

当数据重要到不能接受中途覆盖失败时,可进一步采用“先写临时文件,再重命名替换”的策略;普通设置、草稿和可重建缓存,则直接使用 writeAsString 往往已经足够。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 File 写入文本和 JSON

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通