Flutter 之 文件操作（二十九）

Dart的 IO 庫(kù)包含了文件讀寫(xiě)的相關(guān)類，它屬于 Dart 語(yǔ)法標(biāo)準(zhǔn)的一部分，所以通過(guò) Dart IO 庫(kù)，無(wú)論是 Dart VM 下的腳本還是 Flutter，都是通過(guò) Dart IO 庫(kù)來(lái)操作文件的，不過(guò)和 Dart VM 相比，F(xiàn)lutter 有一個(gè)重要差異是文件系統(tǒng)路徑不同，這是因?yàn)镈art VM 是運(yùn)行在 PC 或服務(wù)器操作系統(tǒng)下，而 Flutter 是運(yùn)行在移動(dòng)操作系統(tǒng)中，他們的文件系統(tǒng)會(huì)有一些差異。

1. APP目錄

Android 和 iOS 的應(yīng)用存儲(chǔ)目錄不同，PathProvider插件提供了一種平臺(tái)透明的方式來(lái)訪問(wèn)設(shè)備文件系統(tǒng)上的常用位置。該類當(dāng)前支持訪問(wèn)兩個(gè)文件系統(tǒng)位置：

  • 臨時(shí)目錄: 可以使用 getTemporaryDirectory() 來(lái)獲取臨時(shí)目錄； 系統(tǒng)可隨時(shí)清除的臨時(shí)目錄（緩存）。在 iOS 上，這對(duì)應(yīng)于NSTemporaryDirectory()返回的值。在 Android上，這是getCacheDir()返回的值。

  • 文檔目錄: 可以使用getApplicationDocumentsDirectory()來(lái)獲取應(yīng)用程序的文檔目錄，該目錄用于存儲(chǔ)只有自己可以訪問(wèn)的文件。只有當(dāng)應(yīng)用程序被卸載時(shí)，系統(tǒng)才會(huì)清除該目錄。在 iOS 上，這對(duì)應(yīng)于NSDocumentDirectory。在 Android 上，這是AppData目錄。

  • 外部存儲(chǔ)目錄：可以使用getExternalStorageDirectory()來(lái)獲取外部存儲(chǔ)目錄，如 SD 卡；由于 iOS不支持外部目錄，所以在 iOS 下調(diào)用該方法會(huì)拋出UnsupportedError異常，而在 Android 下結(jié)果是Android SDK 中getExternalStorageDirectory的返回值。

2. 文件操作基本使用

2.1 獲取文件操作對(duì)象File

File代表一個(gè)整體的文件,他有三個(gè)構(gòu)造函數(shù)，分別是：

factory File(String path) 
factory File.fromUri(Uri uri)
factory File.fromRawPath(Uint8List rawPath)

var file = File('file.txt');

2.2 讀取文件所有內(nèi)容

文件讀取本身有兩種形式，一種是文本，一種是二進(jìn)制。

2.2.1 讀取文本內(nèi)容

如果是文本文件，F(xiàn)ile提供了readAsString、readAsLines、readAsStringSync、readAsLinesSync方法，讀取文本內(nèi)容

readAsString 一次性讀取所有文本

 Future<String> readAsString({Encoding encoding: utf8});

var stringContents = await file.readAsString();

readAsLines 一行行的讀取文本

Future<List<String>> readAsLines({Encoding encoding: utf8});

結(jié)果返回的是一個(gè)List，list中表示文件每行的內(nèi)容

var lines = await file.readAsLines();

readAsStringSync、readAsLinesSync同步讀取文本

String readAsStringSync({Encoding encoding: utf8});

List<String> readAsLinesSync({Encoding encoding: utf8});

2.2.2 讀取二進(jìn)制內(nèi)容
如果文件是二進(jìn)制，那么可以使用readAsBytes或者同步的方法readAsBytesSync:

Future<Uint8List> readAsBytes();

Uint8List readAsBytesSync();

dart中表示二進(jìn)制有一個(gè)專門(mén)的類型叫做Uint8List,他實(shí)際上表示的是一個(gè)int的List。

2.3 以流的形式讀取文件

上面提到的讀取方式，都是一次性讀取整個(gè)文件，缺點(diǎn)就是如果文件太大的話，可能造成內(nèi)存空間的壓力。
所以File為我們提供了另外一種讀取文件的方法，流的形式來(lái)讀取文件.

 Stream<List<int>> openRead([int? start, int? end]);

示例

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

Future<void> main() async {
  var file = File('file.txt');
  Stream<List<int>> inputStream = file.openRead();

  var lines = utf8.decoder
      .bind(inputStream)
      .transform(const LineSplitter());
  try {
    await for (final line in lines) {
      print('Got ${line.length} characters from stream');
    }
    print('file is now closed');
  } catch (e) {
    print(e);
  }
}

2.4 隨機(jī)訪問(wèn)

dart提供了open和openSync兩個(gè)方法來(lái)進(jìn)行隨機(jī)文件讀寫(xiě)：

  Future<RandomAccessFile> open({FileMode mode: FileMode.read});
  RandomAccessFile openSync({FileMode mode: FileMode.read});
  • FileMode.read 只讀
  • FileMode.write 可讀可寫(xiě)，如果文件存在覆蓋，如果文件不存在創(chuàng)建
  • FileMode.append 可讀可寫(xiě)，如果文件存在在末尾追加，如果文件不存在創(chuàng)建
  • FileMode.writeOnly 只寫(xiě)，如果文件存在覆蓋，如果文件不存在創(chuàng)建
  • FileModel.writeOnlyAppend 只寫(xiě)，如果文件存在在末尾追加，如果文件不存在創(chuàng)建

2.5 文件的寫(xiě)入

寫(xiě)入和文件讀取一樣，可以一次性寫(xiě)入或者獲得一個(gè)寫(xiě)入句柄，然后再寫(xiě)入。
一次性寫(xiě)入的方法有四種，分別對(duì)應(yīng)字符串和二進(jìn)制

 Future<File> writeAsBytes(List<int> bytes,
      {FileMode mode: FileMode.write, bool flush: false});

void writeAsBytesSync(List<int> bytes,
      {FileMode mode: FileMode.write, bool flush: false});

Future<File> writeAsString(String contents,
      {FileMode mode: FileMode.write,
      Encoding encoding: utf8,
      bool flush: false});

void writeAsStringSync(String contents,
      {FileMode mode: FileMode.write,
      Encoding encoding: utf8,
      bool flush: false});

句柄形式可以調(diào)用openWrite方法，返回一個(gè)IOSink對(duì)象，然后通過(guò)這個(gè)對(duì)象進(jìn)行寫(xiě)入：

IOSink openWrite({FileMode mode: FileMode.write, Encoding encoding: utf8});

var logFile = File('log.txt');
var sink = logFile.openWrite();
sink.write('FILE ACCESSED ${DateTime.now()}\n');
await sink.flush();
await sink.close();

默認(rèn)情況下寫(xiě)入是會(huì)覆蓋整個(gè)文件的，但是可以通過(guò)下面的方式來(lái)更改寫(xiě)入模式：

var sink = logFile.openWrite(mode: FileMode.append);

2.6 處理異常

雖然dart中所有的異常都是運(yùn)行時(shí)異常，但是和java一樣，要想手動(dòng)處理文件讀寫(xiě)中的異常，則可以使用try,catch:

Future<void> main() async {
  var config = File('config.txt');
  try {
    var contents = await config.readAsString();
    print(contents);
  } catch (e) {
    print(e);
  }
}

3. 示例

我們還是以計(jì)數(shù)器為例，實(shí)現(xiàn)在應(yīng)用退出重啟后可以恢復(fù)點(diǎn)擊次數(shù)。 這里，我們使用文件來(lái)保存數(shù)據(jù)：

1.引入PathProvider插件；在pubspec.yaml文件中添加如下聲明：
執(zhí)行 flutter pub get

2.實(shí)現(xiàn)如下


class MSFileDemo extends StatefulWidget {
  const MSFileDemo({
    Key? key,
  }) : super(key: key);

  @override
  State<MSFileDemo> createState() => _MSFileDemoState();
}

class _MSFileDemoState extends State<MSFileDemo> {
  var _counter = 0;
  @override
  void initState() {
    super.initState();
    //從文件讀取點(diǎn)擊次數(shù)
    _readCounter().then((value) {
      setState(() {
        _counter = value;
      });
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Text(
          "$_counter",
          style: TextStyle(
              fontSize: 20, color: Colors.red, fontWeight: FontWeight.bold),
        ),
      ),
      floatingActionButton: FloatingActionButton(
        child: Icon(Icons.add),
        onPressed: () {
          setState(() {
            _counter++;
          });
          _writeCounter();
        },
      ),
    );
  }

  // 獲取本地文件路徑
  Future<String> _getLocalFileDir() async {
    Directory tempDir = await getTemporaryDirectory();
    return tempDir.path;
  }

  // 獲取文件
  Future<File> _getLocalFile() async {
    String dir = await _getLocalFileDir();
    return File("$dir/counter.txt");
  }

  // 讀取內(nèi)容
  Future<int> _readCounter() async {
    try {
      File file = await _getLocalFile();
      // 讀取文本內(nèi)容
      String counterString = file.readAsStringSync();
      return int.parse(counterString);
    } on FileSystemException {
      return 0;
    }
  }

  // 寫(xiě)入內(nèi)容
  void _writeCounter() async {
    File file = await _getLocalFile();
    file.writeAsString("$_counter"); // 覆蓋寫(xiě)入
  }
}

參考：http://www.itdecent.cn/p/92b09aaecf17
https://book.flutterchina.club/chapter11/file_operation.html

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容