【Flutter】Katana Storage

// main.dart
import 'package:flutter/material.dart';
import 'package:katana_storage/katana_storage.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return StorageAdapterScope(
      adapter: const LocalStorageAdapter(),
      child: MaterialApp(
        home: const StoragePage(),
        title: "Flutter Demo",
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
      ),
    );
  }
}

ストレージオブジェクトの作成

まず、ファイル１つにつき１つのStorageオブジェクトを作成します。

作成時にリモート側の相対パスを記述したStorageQueryを渡します。

StorageオブジェクトはChangeNotifierを継承しているので、addListenerやriverpodのChangeNotifierProviderなどを合わせて利用し状態を監視することができます。

Copy

final storage = Storage(const StorageQuery("test/file"));

Copy

class StoragePage extends StatefulWidget {
  const StoragePage({super.key});

  @override
  State<StatefulWidget> createState() => StoragePageState();
}

class StoragePageState extends State<StoragePage> {
  final storage = Storage(const StorageQuery("test/file"));
  final controller = TextEditingController();

  @override
  void initState() {
    super.initState();
    storage.addListener(_handledOnUpdate);
  }

  void _handledOnUpdate() {
    setState(() {});
  }

  @override
  void dispose() {
    super.dispose();
    storage.removeListener(_handledOnUpdate);
    storage.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text("App Demo")),
      body: TextField(
        controller: controller,
        expands: true,
        textAlignVertical: TextAlignVertical.top,
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () async {
          final text = controller.text;
          final bytes = Uint8List.fromList(text.codeUnits);
          await storage.uploadWithBytes(bytes);
        },
        child: const Icon(Icons.upload_file),
      ),
    );
  }
}

アップロード

アップロードを行うには下記のメソッドが利用可能です。

upload：ローカルにあるファイルパスを指定してアップロード。
uploadWithBytes：バイトデータを渡して直接アップロード。

戻り値にStorageValueが渡されます。ここにアップロードしたファイルのリモートのフルパスが格納されています。

Copy

final bytes = Uint8List.fromList(text.codeUnits);
final storageValue = await storage.uploadWithBytes(bytes);
print("Remote path is: ${storageValue.remote.path}");

ダウンロード

すでにストレージにアップロードされているファイルをダウンロードするにはdownloadのメソッドを利用します。

引数にローカルに保存するファイルの相対パスを指定することも可能です。

戻り値にStorageValueが渡され、ここにダウンロードしたファイルのローカルのフルパスやファイルの実データが格納されています。

ローカルファイルへの保存はWebでは対応していません。

Copy

final bytes = Uint8List.fromList(text.codeUnits);
final storageValue = await storage.download("file.jpg");
print("Local path is: ${storageValue.local.path}");
print("Local data is: ${storageValue.local.bytes}");

StorageAdapter

StorageAdapterScopeを定義する際に渡すことでストレージのシステムを変更することが可能です。

RuntimeStorageAdapter：アプリのメモリ上のみにデータがアップロードされます。実際には保存されません。テスト時に利用してください。
LocalStorageAdapter：端末のローカルにファイルを保存するためのストレージアダプター。downloadやuploadにおけるローカルとリモートはどちらも端末内にあることに注意してください。画面モックを実装する際に便利です。Webでは利用できません。
FirebaseStorageAdapter：Cloud Storage for Firebaseを利用するストレージアダプター。アプリ間で利用可能です。Firebaseの初期設定が必要です。