11.1 文件操作
Dart的 IO 库包含了文件读写的相关类,它属于 Dart 语法标准的一部分,所以通过 Dart IO 库,无论是 Dart VM 下的脚本还是 Flutter,都是通过 Dart IO 库来操作文件的,不过和 Dart VM 相比,Flutter 有一个重要差异是文件系统路径不同,这是因为Dart VM 是运行在 PC 或服务器操作系统下,而 Flutter 是运行在移动操作系统中,他们的文件系统会有一些差异。
APP目录
Android 和 iOS 的应用存储目录不同,PathProvider (opens new window) 插件提供了一种平台透明的方式来访问设备文件系统上的常用位置。该类当前支持访问两个文件系统位置:
- 临时目录: 可以使用
getTemporaryDirectory()来获取临时目录; 系统可随时清除的临时目录(缓存)。在 iOS 上,这对应于NSTemporaryDirectory()(opens new window) 返回的值。在 Android上,这是getCacheDir()(opens new window)返回的值。 - 文档目录: 可以使用
getApplicationDocumentsDirectory()来获取应用程序的文档目录,该目录用于存储只有自己可以访问的文件。只有当应用程序被卸载时,系统才会清除该目录。在 iOS 上,这对应于NSDocumentDirectory。在 Android 上,这是AppData目录。 - 外部存储目录:可以使用
getExternalStorageDirectory()来获取外部存储目录,如 SD 卡;由于 iOS不支持外部目录,所以在 iOS 下调用该方法会抛出UnsupportedError异常,而在 Android 下结果是Android SDK 中getExternalStorageDirectory的返回值。
一旦你的 Flutter 应用程序有一个文件位置的引用,你可以使用 dart:io (opens new window)API来执行对文件系统的读/写操作。有关使用 Dart 处理文件和目录的详细内容可以参考 Dart 语言文档,下面我们看一个简单的例子。
示例
我们还是以计数器为例,实现在应用退出重启后可以恢复点击次数。 这里,我们使用文件来保存数据:
引入PathProvider插件;在
pubspec.yaml文件中添加如下声明:1path_provider: ^2.0.2添加后,执行
flutter packages get获取一下, 版本号可能随着时间推移会发生变化,读者可以使用最新版。实现:
1import 'dart:io'; 2import 'dart:async'; 3import 'package:flutter/material.dart'; 4import 'package:path_provider/path_provider.dart'; 5 6class FileOperationRoute extends StatefulWidget { 7 FileOperationRoute({Key? key}) : super(key: key); 8 9 10 _FileOperationRouteState createState() => _FileOperationRouteState(); 11} 12 13class _FileOperationRouteState extends State<FileOperationRoute> { 14 int _counter = 0; 15 16 17 void initState() { 18 super.initState(); 19 //从文件读取点击次数 20 _readCounter().then((int value) { 21 setState(() { 22 _counter = value; 23 }); 24 }); 25 } 26 27 Future<File> _getLocalFile() async { 28 // 获取应用目录 29 String dir = (await getApplicationDocumentsDirectory()).path; 30 return File('$dir/counter.txt'); 31 } 32 33 Future<int> _readCounter() async { 34 try { 35 File file = await _getLocalFile(); 36 // 读取点击次数(以字符串) 37 String contents = await file.readAsString(); 38 return int.parse(contents); 39 } on FileSystemException { 40 return 0; 41 } 42 } 43 44 _incrementCounter() async { 45 setState(() { 46 _counter++; 47 }); 48 // 将点击次数以字符串类型写到文件中 49 await (await _getLocalFile()).writeAsString('$_counter'); 50 } 51 52 53 Widget build(BuildContext context) { 54 return Scaffold( 55 appBar: AppBar(title: Text('文件操作')), 56 body: Center( 57 child: Text('点击了 $_counter 次'), 58 ), 59 floatingActionButton: FloatingActionButton( 60 onPressed: _incrementCounter, 61 tooltip: 'Increment', 62 child: Icon(Icons.add), 63 ), 64 ); 65 } 66}上面代码比较简单,不再赘述,需要说明的是,本示例只是为了演示文件读写,而在实际开发中,如果要存储一些简单的数据,使用shared_preferences插件会比较简单。
注意,Dart IO库操作文件的API非常丰富,但本书不是介绍Dart语言的,故不详细说明,读者需要的话可以自行学习。