Flutter数据缓存插件save_to_cache的使用

本包用于缓存文件，可以单独保存文件或以文件夹形式保存文件。

开始使用

添加依赖

在pubspec.yaml文件中添加以下依赖：

dependencies:
  save_to_cache: ^1.0.1

然后运行 flutter pub get 来获取新的依赖。

导入库

在你的Dart文件中导入 save_to_cache 库：

import 'package:save_to_cache/save_to_cache.dart';

使用示例

单个文件保存

以下是如何将单个文件保存到缓存的示例：

File fileSelect = File('path/to/file/select.type');
String? name = 'newName';
File result = await SaveToCache.saveFile(file: fileSelect, name: name);

多个文件保存

以下是如何将多个文件保存到缓存的示例：

List<File> files = [File('path/to/file/select1.type')];
List<String>? names = ['newName1'];
var result = await SaveToCache.saveFiles(files: files, names: names);

文件与文件夹一起保存

以下是如何将文件保存到指定文件夹的示例：

File fileSelect = File('path/to/file/select.type');
String newFolder = 'newFolder';
var result = await SaveToCache.saveFileWithFolder(file: fileSelect, folderName: newFolder);

完整示例代码

以下是完整的示例代码，展示了如何使用 save_to_cache 插件来保存文件。

示例代码：main.dart

import 'dart:io';

import 'package:file_picker/file_picker.dart';
import 'package:flutter/material.dart';
import 'package:save_to_cache/save_to_cache.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Save To Cache Example',
      home: HomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  File fileSelect = File('');
  String nameFileSelect = 'file-select.example';
  String pathSave = '';

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Save To Cache Example'),
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          TextButton(
            onPressed: _onSelectFile,
            child: const Text('Select File'),
          ),
          Text(nameFileSelect),
          const Divider(),
          TextButton(
            onPressed: () => _onSaveFileToCache(),
            child: const Text('Save file to cache'),
          ),
          TextButton(
            onPressed: () => _onSaveFileToCache(name: 'save new'),
            child: const Text('Save file to cache with name'),
          ),
          TextButton(
            onPressed: () => _onSaveFileWithFolder(),
            child: const Text('Save file with folder'),
          ),
          TextButton(
            onPressed: () => _onSaveFiles(),
            child: const Text('Save files'),
          ),
          TextButton(
            onPressed: () => _onSaveFilesWithFolder(),
            child: const Text('Save files with folder'),
          ),
          Text(pathSave)
        ],
      ),
    );
  }

  Future<void> _onSelectFile() async {
    FilePickerResult? result = await FilePicker.platform.pickFiles();
    if (result != null) {
      fileSelect = File(result.files.single.path!);
      setState(() => nameFileSelect = result.files.single.name);
    }
  }

  void _showMessage(String message) {
    ScaffoldMessenger.of(context)
      ..hideCurrentSnackBar()
      ..showSnackBar(
        SnackBar(
          content: Text(message),
        ),
      );
  }

  Future<void> _onSaveFileToCache({String? name}) async {
    var result = await SaveToCache.saveFile(file: fileSelect, name: name);
    _showMessage('Successful! $result');
  }

  Future<void> _onSaveFileWithFolder() async {
    var result = await SaveToCache.saveFileWithFolder(
        file: fileSelect, folderName: 'test_folder');
    _showMessage('Successful! $result');
  }

  _onSaveFiles() async {
    var result = await SaveToCache.saveFiles(
      files: [fileSelect],
      //names: ['test1']
    );
    _showMessage('Successful! $result');
  }

  _onSaveFilesWithFolder() async {
    var result = await SaveToCache.saveFilesWithFolder(
      files: [fileSelect],
      folderName: 'test_files',
      //names: ["test1"],
    );
    _showMessage('Successful! $result');
  }
}