Flutter安全存储插件saf的使用

Flutter安全存储插件saf的使用

Saf

Flutter插件，利用Storage Access Framework (SAF) API来获取文件和文件夹的操作权限。

目前支持的功能

• 使用操作系统默认的原生文件浏览器
• 访问隐藏文件夹和文件
• 访问目录
• 缓存文件到应用外部文件目录
• 同步某些目录的文件与缓存文件
• 不同类型的默认过滤（媒体、图像、视频、音频或任何类型）
• 支持Android平台

如果您希望在这个包中看到某个功能，请随时提出建议。🎉

示例应用

Android

使用方法

要使用此插件，在您的pubspec.yaml文件中添加saf作为依赖项。

dependencies:
  saf: ^x.x.x

初始化Saf实例

Saf saf = Saf("~/some/path");

请求目录权限

bool? isGranted = await saf.getDirectoryPermission(isDynamic: false);

if (isGranted != null && isGranted) {
  // 执行一些文件操作
} else {
  // 未能获取权限
}

获取已授予目录的所有路径

bool? directoriesPath = await saf.getPersistedPermissionDirectories();

获取当前目录的所有文件路径

List<String>? paths = await saf.getFilesPath(FileType.media);

缓存当前目录

bool? isCached = await saf.cache();

if (isCached != null && isCached) {
  // 执行一些文件操作
} else {
  // 缓存失败
}

获取当前目录的缓存文件路径

List<String>? cachedFilesPath = await saf.getCachedFilesPath();

清除当前目录的缓存

bool? isClear = await saf.clearCache();

同步当前目录与缓存目录

bool? isSynced = await saf.sync();

释放当前目录的持久化权限

bool? isReleased = await Saf.releasePersistedPermission();

释放所有已授予目录的持久化权限

await Saf.releasePersistedPermissions();

示例代码

import 'dart:io';

import 'package:permission_handler/permission_handler.dart';
import 'package:flutter/material.dart';
import 'package:saf/saf.dart';

/// 在这里手动编辑目录
const directory = "Android/media/matrix/.neo";

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late Saf saf;
  var _paths = [];

  [@override](/user/override)
  void initState() {
    Permission.storage.request();
    saf = Saf(directory);
    super.initState();
  }

  loadImage(paths, {String k = ""}) {
    var tempPaths = [];
    for (String path in paths) {
      if (path.endsWith(".jpg")) {
        tempPaths.add(path);
      }
    }
    if (k.isNotEmpty) tempPaths.add(k);
    _paths = tempPaths;
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Saf example app'),
        ),
        body: Center(
          child: SingleChildScrollView(
            child: Column(
              children: [
                if (_paths.isNotEmpty)
                  ..._paths.map(
                    (path) => Card(
                      child: Image.file(
                        File(path),
                      ),
                    ),
                  )
              ],
            ),
          ),
        ),
        bottomNavigationBar: Row(
          mainAxisAlignment: MainAxisAlignment.spaceAround,
          children: [
            ElevatedButton(
              style: ButtonStyle(
                backgroundColor: MaterialStateProperty.all(Colors.deepPurpleAccent),
              ),
              onPressed: () async {
                Saf.releasePersistedPermissions();
              },
              child: const Text("Release*"),
            ),
            ElevatedButton(
              style: ButtonStyle(
                backgroundColor: MaterialStateProperty.all(Colors.blueGrey.shade700),
              ),
              onPressed: () async {
                var cachedFilesPath = await saf.cache();
                if (cachedFilesPath != null) {
                  loadImage(cachedFilesPath);
                }
              },
              child: const Text("Cache"),
            ),
            ElevatedButton(
              style: ButtonStyle(
                backgroundColor: MaterialStateProperty.all(Colors.green),
              ),
              onPressed: () async {
                var isSync = await saf.sync();
                if (isSync as bool) {
                  var _paths = await saf.getCachedFilesPath();
                  loadImage(_paths);
                }
              },
              child: const Text("Sync"),
            ),
            ElevatedButton(
              style: ButtonStyle(
                backgroundColor: MaterialStateProperty.all(Colors.orange),
              ),
              onPressed: () async {
                var isClear = await saf.clearCache();
                if (isClear != null && isClear) {
                  loadImage([]);
                }
              },
              child: const Text("Clear"),
            ),
          ],
        ),
        floatingActionButtonLocation: FloatingActionButtonLocation.centerFloat,
        floatingActionButton: FloatingActionButton(
          elevation: 30.0,
          backgroundColor: Colors.black,
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: const [
              Text(
                "GRANT",
                style: TextStyle(fontSize: 13, color: Colors.red),
              ),
              Text(
                "Permission",
                style: TextStyle(fontSize: 7.8, color: Colors.red),
              )
            ],
          ),
          onPressed: () async {
            await saf.getDirectoryPermission(isDynamic: true);
          },
        ),
      ),
    );
  }
}