Flutter自动获取存储目录插件condora_automatic_getter_storage_directory的使用

condora_automatic_getter_storage_directory

一个为Flutter提供的包，它提供了一种自动且平台感知的方式来管理跨Web和非Web平台的存储目录，并高效地处理调试和发布环境。

特性

• 智能的平台特定存储路径，遵循最佳实践：
  • iOS/macOS: 遵循Apple指南的Library目录。
  • Android: 如果可用，优先使用外部存储目录；否则回退到应用支持目录。
  • Windows: 使用AppData/Roaming（可选配置为Local）。
  • Linux: 遵循XDG规范的~/.local/share/[app_name]。
  • Web: 可配置的存储目录。
• 支持调试模式开发，方便访问项目目录存储。
• 提供全面的错误处理和验证。
• 跨平台支持（Android、iOS、Windows、macOS、Linux、Web）。

开始使用

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

dependencies:
  condora_automatic_getter_storage_directory: ^1.0.1

然后运行flutter pub get以安装该包。

使用方法

不使用Hydrated BLoC

以下是一个不使用Hydrated BLoC的简单示例：

import 'package:flutter/material.dart';
import 'package:condora_automatic_getter_storage_directory/condora_automatic_getter_storage_directory.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 获取存储目录
  final storageDir = await condoraAutomaticGetterStorageDirectory(
    webStorageDirectory: Directory('your_web_storage_path'), // Web专用路径
    windowsUseLocalStorage: false, // 是否使用Windows本地存储（默认为Roaming）
  );

  // 打印存储目录路径
  print('Storage directory: ${storageDir.path}');
}

使用Hydrated BLoC

以下是与Hydrated BLoC结合使用的示例：

import 'package:flutter/material.dart';
import 'package:hydrated_bloc/hydrated_bloc.dart';
import 'package:condora_automatic_getter_storage_directory/condora_automatic_getter_storage_directory.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化Hydrated BLoC的存储位置
  HydratedBloc.storage = await HydratedStorage.build(
    storageDirectory: await condoraAutomaticGetterStorageDirectory(
      webStorageDirectory: HydratedStorage.webStorageDirectory, // Web专用路径
    ),
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
        body: Placeholder(),
      ),
    );
  }
}

存储目录行为

不同平台的存储目录行为如下：

• iOS/macOS: Library目录（遵循Apple指南）。
• Android: 如果外部存储可用，则使用外部存储目录；否则回退到应用支持目录。
• Windows: 默认使用AppData/Roaming，可配置为Local存储。
• Linux: ~/.local/share/[app_name]（遵循XDG规范）。
• Web: 可配置的自定义目录。
• 调试模式: 在项目目录中创建一个明确标记的调试文件夹。

其他信息

此包特别适用于以下场景：

• 开发跨多个平台的Flutter应用。
• 需要符合平台特定存储位置的应用。
• 希望在调试时轻松访问存储的开发人员。
• 使用如hydrated_bloc等需要Web兼容存储的库。
• 需要遵循平台特定存储指南的开发者。

贡献

欢迎在GitHub仓库提交问题、PR或建议。

许可证

MIT许可证 - 详见LICENSE文件。

示例代码

以下是完整的示例代码，包含主入口和Hydrated BLoC集成：

import 'package:flutter/material.dart';
import 'package:hydrated_bloc/hydrated_bloc.dart';
import 'package:condora_automatic_getter_storage_directory/condora_automatic_getter_storage_directory.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化Hydrated BLoC的存储位置
  HydratedBloc.storage = await HydratedStorage.build(
    storageDirectory: await condoraAutomaticGetterStorageDirectory(
      webStorageDirectory: HydratedStorage.webStorageDirectory, // Web专用路径
    ),
  );

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
        body: Placeholder(),
      ),
    );
  }
}