Flutter怎么用ORM框架管理數據庫

Flutter怎么用ORM框架管理數據庫

在Flutter應用開發中，數據庫管理是一個非常重要的環節。隨著應用復雜度的增加，直接使用SQL語句來操作數據庫會變得繁瑣且容易出錯。為了簡化數據庫操作，ORM（Object-Relational Mapping）框架應運而生。ORM框架可以將數據庫表映射為對象，使得開發者可以通過操作對象來間接操作數據庫，從而提高開發效率和代碼的可維護性。

本文將介紹如何在Flutter中使用ORM框架來管理數據庫，重點介紹floor和moor兩個流行的ORM框架。

1. ORM框架簡介

ORM框架的主要作用是將數據庫中的表映射為編程語言中的對象，使得開發者可以通過操作對象來間接操作數據庫。ORM框架通常提供以下功能：

• 數據庫表的創建和更新：通過定義模型類，ORM框架可以自動生成數據庫表結構。
• CRUD操作：提供簡單易用的API來執行增刪改查操作。
• 查詢構建：支持復雜的查詢條件，避免手寫SQL語句。
• 事務管理：支持事務操作，確保數據的一致性。

在Flutter中，常用的ORM框架有floor和moor。接下來我們將詳細介紹這兩個框架的使用方法。

2. 使用floor框架管理數據庫

floor是一個輕量級的ORM框架，基于sqflite庫，提供了簡單的API來管理SQLite數據庫。

2.1 添加依賴

首先，在pubspec.yaml文件中添加floor和floor_generator依賴：

dependencies:
  flutter:
    sdk: flutter
  floor: ^1.4.0

dev_dependencies:
  floor_generator: ^1.4.0
  build_runner: ^2.1.0

2.2 定義實體類

實體類對應數據庫中的表。我們定義一個Person類，并使用@Entity注解標記：

import 'package:floor/floor.dart';

@Entity(tableName: 'person')
class Person {
  @PrimaryKey(autoGenerate: true)
  final int id;

  final String name;

  final int age;

  Person(this.id, this.name, this.age);
}

2.3 定義DAO接口

DAO（Data Access Object）接口用于定義數據庫操作的方法。我們定義一個PersonDao接口，并使用@dao注解標記：

import 'package:floor/floor.dart';
import 'person.dart';

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

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

  @insert
  Future<void> insertPerson(Person person);

  @update
  Future<void> updatePerson(Person person);

  @delete
  Future<void> deletePerson(Person person);
}

2.4 創建數據庫

我們創建一個AppDatabase類來管理數據庫連接，并使用@Database注解標記：

import 'package:floor/floor.dart';
import 'person_dao.dart';
import 'person.dart';

part 'app_database.g.dart'; // 生成的代碼文件

@Database(version: 1, entities: [Person])
abstract class AppDatabase extends FloorDatabase {
  PersonDao get personDao;
}

2.5 生成代碼

運行以下命令生成數據庫和DAO的實現代碼：

flutter pub run build_runner build

2.6 使用數據庫

在Flutter應用中使用floor框架操作數據庫的示例代碼如下：

import 'package:flutter/material.dart';
import 'app_database.dart';
import 'person.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

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

  runApp(MyApp(personDao: personDao));
}

class MyApp extends StatelessWidget {
  final PersonDao personDao;

  MyApp({required this.personDao});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Floor Example')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  final person = Person(null, 'Alice', 30);
                  await personDao.insertPerson(person);
                },
                child: Text('Insert Person'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final persons = await personDao.findAllPersons();
                  print(persons);
                },
                child: Text('Find All Persons'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

3. 使用moor框架管理數據庫

moor是另一個流行的ORM框架，提供了更強大的功能和更靈活的API。與floor不同，moor使用Dart語言來定義數據庫表和查詢。

3.1 添加依賴

在pubspec.yaml文件中添加moor和moor_generator依賴：

dependencies:
  flutter:
    sdk: flutter
  moor: ^4.4.0
  sqlite3_flutter_libs: ^0.5.0

dev_dependencies:
  moor_generator: ^4.4.0
  build_runner: ^2.1.0

3.2 定義表結構

我們使用Dart語言定義Person表：

import 'package:moor/moor.dart';

class Persons extends Table {
  IntColumn get id => integer().autoIncrement()();
  TextColumn get name => text()();
  IntColumn get age => integer()();
}

3.3 定義DAO

我們定義一個PersonDao類來管理Person表的操作：

import 'package:moor/moor.dart';

part 'database.g.dart'; // 生成的代碼文件

@UseMoor(tables: [Persons])
class AppDatabase extends _$AppDatabase {
  AppDatabase() : super(_openConnection());

  @override
  int get schemaVersion => 1;

  Future<List<Person>> getAllPersons() => select(persons).get();

  Future<Person?> getPersonById(int id) => (select(persons)..where((t) => t.id.equals(id))).getSingleOrNull();

  Future<void> insertPerson(Person person) => into(persons).insert(person);

  Future<void> updatePerson(Person person) => update(persons).replace(person);

  Future<void> deletePerson(Person person) => delete(persons).delete(person);
}

LazyDatabase _openConnection() {
  return LazyDatabase(() async {
    final dbFolder = await getApplicationDocumentsDirectory();
    final file = File(p.join(dbFolder.path, 'app_database.db'));
    return VmDatabase(file);
  });
}

3.4 生成代碼

運行以下命令生成數據庫和DAO的實現代碼：

flutter pub run build_runner build

3.5 使用數據庫

在Flutter應用中使用moor框架操作數據庫的示例代碼如下：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final database = AppDatabase();

  runApp(MyApp(database: database));
}

class MyApp extends StatelessWidget {
  final AppDatabase database;

  MyApp({required this.database});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Moor Example')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  final person = PersonsCompanion.insert(name: 'Bob', age: 25);
                  await database.insertPerson(person);
                },
                child: Text('Insert Person'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final persons = await database.getAllPersons();
                  print(persons);
                },
                child: Text('Find All Persons'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

4. 總結

在Flutter應用中使用ORM框架可以大大簡化數據庫操作，提高開發效率和代碼的可維護性。本文介紹了floor和moor兩個流行的ORM框架，并提供了詳細的使用示例。開發者可以根據項目需求選擇合適的ORM框架來管理數據庫。

無論是floor還是moor，它們都提供了強大的功能和靈活的API，能夠滿足大多數Flutter應用的數據庫管理需求。希望本文能夠幫助你在Flutter項目中更好地使用ORM框架來管理數據庫。