パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.5.0

floor

Flutter アプリケーション向けの型安全でリアクティブかつ軽量な SQLite 抽象。このライブラリは実行時依存です。

30日間ダウンロード
3.2万
いいね数
1000
Pub ポイント
110

パッケージをインストール

flutter pub add floor

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Floor は、Flutter アプリケーション向けに設計された型安全でリアクティブかつ軽量な SQLite 抽象レイヤーです。アノテーションとコード生成を使用して、コンパイル時に安全な方法で SQLite データベースとやり取りできます。Floor は使いやすい DAO(データアクセスオブジェクト)を提供し、ストリームを通じたリアクティブなクエリをサポートします。パフォーマンスと開発者体験を重視しており、手動での SQL 書き込みなしに Flutter プロジェクトにシームレスに統合されます。ライブラリはコンパイル時にデータベーススキーマを検証することで、型安全を保ち、ランタイムエラーを減らします。

用途

  • モバイルアプリにおけるオフラインデータストレージ
  • ローカルデータベースとのリアルタイムデータ同期
  • ユーザープロファイルや設定などの構造化アプリデータの管理
  • オフライン優先のアプリケーションの構築
  • キャッシュされたAPI応答を保存する
  • ユーザー活動ログの追跡

主な機能

  • 型安全なデータベーススキーマ定義
  • ストリームを介したリアクティブなクエリ
  • DAO のコード生成
  • データベース構造のコンパイル時検証
  • 軽量で高速なパフォーマンス
  • Flutterの状態管理との簡単な統合

適している対象

  • オフライン対応のFlutterアプリを開発する開発者
  • 型の安全性と保守性を重視するチーム
  • 効率的なローカルデータ永続化を必要とするプロジェクト
  • ローカルデータからのリアルタイム更新を必要とするアプリ
  • 最小限のボイラープレートを求めるFlutter開発者

注意事項

  • コード生成のセットアップが必要です
  • 下位データベースとしてSQLiteに限定
  • 複雑な結合や生のSQLに対する組み込みサポートなし
  • 移行処理には慎重な計画が必要です
  • 大規模なサーバーサイドデータベースには適していません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Floor

See the project's website for the full documentation.

Floor provides a neat SQLite abstraction for your Flutter applications inspired by the Room persistence library. It comes with automatic mapping between in-memory objects and database rows while still offering full control of the database with the use of SQL. As a consequence, it's necessary to have an understanding of SQL and SQLite in order to harvest Floor's full potential.

  • null-safe
  • typesafe
  • reactive
  • lightweight
  • SQL centric
  • no hidden magic
  • no hidden costs
  • iOS, Android, Linux, macOS, Windows

⚠️ The library is open to contributions! Refer to GitHub Discussions for questions, ideas, and discussions.

pub package build status codecov

Getting Started

1. Setup Dependencies

Add the runtime dependency floor as well as the generator floor_generator to your pubspec.yaml. The third dependency is build_runner which has to be included as a dev dependency just like the generator.

  • floor holds all the code you are going to use in your application.
  • floor_generator includes the code for generating the database classes.
  • build_runner enables a concrete way of generating source code files.
dependencies:
  flutter:
    sdk: flutter
  floor: ^1.4.2

dev_dependencies:
  floor_generator: ^1.4.2
  build_runner: ^2.1.2
2. Create an Entity

It will represent a database table as well as the scaffold of your business object. @entity marks the class as a persistent class. It's required to add a primary key to your table. You can do so by adding the @primaryKey annotation to an int property. There is no restriction on where you put the file containing the entity.

// entity/person.dart

import 'package:floor/floor.dart';

@entity
class Person {
  @primaryKey
  final int id;

  final String name;

  Person(this.id, this.name);
}
3. Create a DAO (Data Access Object)

This component is responsible for managing access to the underlying SQLite database. The abstract class contains the method signatures for querying the database which have to return a Future or Stream.

  • You can define queries by adding the @Query annotation to a method. The SQL statement has to get added in parenthesis. The method must return a Future or Stream of the Entity you're querying for.
  • @insert marks a method as an insertion method.
// dao/person_dao.dart

import 'package:floor/floor.dart';

@dao
abstract class PersonDao {
  @Query('SELECT * FROM Person')
  Future<List<Person>> findAllPeople();

  @Query('SELECT name FROM Person')
  Stream<List<String>> findAllPeopleName();

  @Query('SELECT * FROM Person WHERE id = :id')
  Stream<Person?> findPersonById(int id);

  @insert
  Future<void> insertPerson(Person person);
}
4. Create the Database

It has to be an abstract class which extends FloorDatabase. Furthermore, it's required to add @Database() to the signature of the class. Make sure to add the created entity to the entities attribute of the @Database annotation. In order to make the generated code work, it's required to also add the listed imports.

Make sure to add part 'database.g.dart'; beneath the imports of this file. It's important to note that 'database' has to get exchanged with the filename of the database definition. In this case, the file is named database.dart.

// database.dart

// required package imports
import 'dart:async';
import 'package:floor/floor.dart';
import 'package:sqflite/sqflite.dart' as sqflite;

import 'dao/person_dao.dart';
import 'entity/person.dart';

part 'database.g.dart'; // the generated code will be there

@Database(version: 1, entities: [Person])
abstract class AppDatabase extends FloorDatabase {
  PersonDao get personDao;
}
5. Run the Code Generator

Run the generator with flutter packages pub run build_runner build. To automatically run it, whenever a file changes, use flutter packages pub run build_runner watch.

6. Use the Generated Code

For obtaining an instance of the database, use the generated $FloorAppDatabase class, which allows access to a database builder. The name is being composed by $Floor and the database class name. The string passed to databaseBuilder() will be the database file name. For initializing the database, call build() and make sure to await the result.

In order to retrieve the PersonDao instance, invoking the persoDao getter on the database instance is enough. Its functions can be used as shown in the following snippet.

final database = await $FloorAppDatabase.databaseBuilder('app_database.db').build();

final personDao = database.personDao;
final person = Person(1, 'Frank');

await personDao.insertPerson(person);
final result = await personDao.findPersonById(1);

For further examples take a look at the example and test directories.

Naming

The library's name derives from the following. Floor as the bottom layer of a Room which points to the analogy of the database layer being the bottom and foundation layer of most applications. Where fl also gives a pointer that the library is used in the Flutter context.

Bugs, Ideas, and Feedback

For bugs please use GitHub Issues. For questions, ideas, and discussions use GitHub Discussions.

License

Copyright 2023 The Floor Project Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

カテゴリー

依存関係

依存関係一覧 9 件

ソースリポジトリ

このパッケージを使用しているプロジェクト