微信交流群

老孟公众号

path_provider 是获取文件目录的官方插件。

pub 地址:https://pub.flutter-io.cn/packages/path_provider

Github 地址:https://github.com/flutter/plugins/tree/master/packages/path_provider/path_provider

# 添加依赖

在项目的 pubspec.yaml 文件中添加依赖:

dependencies:
  path_provider: ^1.6.11
1
2

执行命令:

flutter pub get
1

# 文件夹

# 创建

创建文件夹:

_createDir() async {
    Directory documentsDirectory = await getApplicationDocumentsDirectory();
    String path = '${documentsDirectory.path}${Platform.pathSeparator}dirName';
    var dir = Directory(path);
    var exist = dir.existsSync();
    if (exist) {
      print('当前文件夹已经存在');
    } else {
      var result = await dir.create();
      print('$result');
    }
  }
1
2
3
4
5
6
7
8
9
10
11
12

Platform.pathSeparator表示路径分隔符,对于Android和iOS来说表示‘/’。

create 中有一个可选参数 recursive ,默认值为 false,false 表示只能创建最后一级文件夹,如果创建 “dir1/dir2” 这种嵌套文件夹,recursive为 false 时将抛出异常,设置为 true 可以创建嵌套文件夹。下面在根目录创建“dir1/dir2”文件夹,代码如下:

var dir2 =await Directory('${documentsDirectory.path}${Platform.pathSeparator}dir1${Platform.pathSeparator}dir2${Platform.pathSeparator}')
    .create(recursive: true);
1
2

# 遍历

遍历文件夹下文件:

_dirList() async {
  Directory documentsDirectory = await getApplicationDocumentsDirectory();
  String path = '${documentsDirectory.path}${Platform.pathSeparator}dirName';

  Stream<FileSystemEntity> fileList = Directory(path).list();

  await for(FileSystemEntity fileSystemEntity in fileList){
    print('$fileSystemEntity');
  }
}
1
2
3
4
5
6
7
8
9
10

可选参数recursive,默认值为false,表示只遍历当前目录;设置为true时表示遍历当前目录及子目录。

判断文件的类型:

await for(FileSystemEntity fileSystemEntity in fileList){
  print('$fileSystemEntity');
  FileSystemEntityType type = FileSystemEntity.typeSync(fileSystemEntity.path);
}
1
2
3
4

文件的类型:

  • file:文件
  • directory:文件夹
  • link:链接文件
  • notFound:未知

# 重命名

重命名文件夹名称:

_dirRename() async{
  Directory documentsDirectory = await getApplicationDocumentsDirectory();
  String path = '${documentsDirectory.path}${Platform.pathSeparator}dirName';
  var dir = Directory(path);
  var dir3= await dir.rename('${dir.parent.absolute.path}${Platform.pathSeparator}dir3');
}
1
2
3
4
5
6

# 删除

删除文件夹:

_deleteDir() async {
  Directory documentsDirectory = await getApplicationDocumentsDirectory();
  String path = '${documentsDirectory.path}${Platform.pathSeparator}dir3';
  var dir = await Directory(path).delete();
}
1
2
3
4
5

create中有一个可选参数recursive,默认值为false,为false时如果删除的文件夹下还有内容将无法删除,抛出异常;设置为true时,删除当前文件夹及文件夹下所有内容。

# 文件

# 创建

创建一个 file.txt 文件:

_createFile() async {
  Directory documentsDirectory = await getApplicationDocumentsDirectory();
  String path = '${documentsDirectory.path}${Platform.pathSeparator}dirName${Platform.pathSeparator}file.txt';

  var file = await File(path).create(recursive: true);
}
1
2
3
4
5
6

create 中有一个可选参数 recursive,默认值为 false,为 false 时只创建文件,文件夹路径不存在抛出异常;设置为 true 时,创建文件及不存在的路径文件夹。

# 写入数据

向 file.txt 文件写入字符串:

file.writeAsString('老孟 Flutter');
1

向 file.txt 文件写入 bytes 数据:

file.writeAsBytes(Utf8Encoder().convert("老孟 Flutter bytes 格式"));
1

上面两种方法都是覆盖写入,向末尾追加内容:

file.openWrite(mode: FileMode.append).write('老孟 Flutter 追加到末尾');
1

# 读取数据

一行一行的读取数据:

List<String> lines = await file.readAsLines();
lines.forEach((element) {
  print('$element');
});
1
2
3
4

读取 bytes 并转换为String:

Utf8Decoder().convert(await file.readAsBytes());
1

# 删除

删除文件:

file.delete();
1

# 读取 asset 文件

读取项目中文件,比如 asset/json/data.json 文件,data.json 文件中为 json 格式数据,数据为:

[
  {
    "title":"致Flutter初学者",
    "desc":"很多东西的学习,尽快入坑学习、动手实践远比畏畏缩缩、进度停留了解阶段要好得多,这是一个很简单的道理,可是偏偏很多人不明白或者做不到。",
    "url":"http://laomengit.com/",
    "tags":""
  },
  {
    "title":"Flutter 学习路线图",
    "desc":"Flutter越来越火,学习Flutter的人越来越多,对于刚接触Flutter的人来说最重要的是如何学习Flutter,重点学习Flutter的哪些内容",
    "url":"http://laomengit.com/flutter/roadmap.html",
    "tags":""
  },
  {
    "title":"Flutter App 升级功能",
    "desc":"应用程序升级功能是App的基础功能之一,如果没有此功能会造成用户无法升级,应用程序的bug或者新功能老用户无法触达,甚至损失这部分用户。",
    "url":"http://laomengit.com/flutter/articles/app_upgrade.html",
    "tags":""
  },
  {
    "title":"Flutter绘制玫瑰",
    "desc":"Flutter绘制玫瑰",
    "url":"http://laomengit.com/flutter/articles/rose.html",
    "tags":""
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

读取数据并转换:

_loadAsset(BuildContext context) async{
  var jsonStr = await DefaultAssetBundle.of(context)
      .loadString('assets/json/data.json');
  var list = json.decode(jsonStr);
  list.forEach((element) {
    print('$element');
  });
}
1
2
3
4
5
6
7
8

在项目的 pubspec.yaml 文件中添加配置:

assets:
  - assets/json/
1
2