Flutter数据库管理插件fdatabase的使用

Flutter数据库管理插件fdatabase的使用

Getting Started（开始使用）

在你的Flutter项目中添加fdatabase插件。你可以通过以下命令将它添加到pubspec.yaml文件中：

flutter pub add fdatabase

或者直接在pubspec.yaml文件中添加依赖项：

dependencies:
  fdatabase: <any>

Usage（使用方法）

首先，你需要导入fdatabase包，并初始化数据库实例：

import 'package:fdatabase/fdatabase.dart';

void main() async {
  // 初始化数据库实例
  final db = await FDatabase.getInstance();

  // 注册Person类，使其可以保存到数据库中
  db.register<Person>(Person.new);

  // 创建一个Person对象
  final person = Person(
    id: 1,
    name: 'John',
    age: 30,
    weight: 75.5,
    married: true,
  );

  // 使用put方法保存数据
  db.put<Person>('person', person);

  db.put<String>('string', 'string');
  db.put<int>('int', 1);
  db.put<double>('double', 1.0);
  db.put<bool>('bool', true);
  db.put<DateTime>('dateTime', DateTime(2024, 4, 9));

  // 或者使用batch方法一次保存多个值
  db.batch((put) {
    put<Person>('person', person);
    put<String>('string', 'string');
    put<int>('int', 1);
    put<double>('double', 1.0);
    put<bool>('bool', true);
    put<DateTime>('dateTime', DateTime(2024, 4, 9));
  });

  // 从数据库获取数据
  db.get<Person>('person'); // 返回Person实例

  db.get<String>('string'); // 返回'string'
  db.get<int>('int'); // 返回1
  db.get<double>('double'); // 返回1.0
  db.get<bool>('bool'); // 返回true
  db.get<DateTime>('dateTime'); // 返回DateTime(2024, 4, 9)
}

Supported Data Types（支持的数据类型）

fdatabase支持以下数据类型：

• String
• int
• double
• bool
• DateTime
• Entity（继承自Entity的类）

所有支持的类型也支持以列表形式保存。

Under Development（开发中）

如果您有任何想法或建议，欢迎为项目贡献您的力量。

完整示例Demo

以下是完整的示例代码：

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

late FDatabase db;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  db = await FDatabase.getInstance()
    ..register<Person>(Person.new);
  runApp(const MainApp());
}

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

  [@override](/user/override)
  State<MainApp> createState() => _MainAppState();
}

class _MainAppState extends State<MainApp> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('Person: ${db.get<Person>('person')?.toMap()}'),
              Text('Name: ${db.get<String>('name')}'),
              Text('Age: ${db.get<int>('age')}'),
              Text('Weight: ${db.get<double>('weight')}'),
              Text('Married: ${db.get<bool>('married')}'),
              Text('Birthday: ${db.get<DateTime>('birthday')}'),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            final person = Person(
              id: 1,
              name: 'John',
              age: 30,
              weight: 75.5,
              married: true,
              birthday: DateTime(2000, 1, 1),
            );

            db.put<Person>('person', person);
            db.put<String>('name', 'John');
            db.put<int>('age', 30);
            db.put<double>('weight', 75.5);
            db.put<bool>('married', true);
            db.put<DateTime>('birthday', DateTime(2000, 1, 1));

            // 或者使用batch方法一次保存多个值
            db.batch(
              (put) {
                put<Person>('person', person);
                put<String>('name', 'John');
                put<int>('age', 30);
                put<double>('weight', 75.5);
                put<bool>('married', true);
                put<DateTime>('birthday', DateTime(2000, 1, 1));
              },
            );

            setState(() {});
          },
          child: const Icon(Icons.add),
        ),
      ),
    );
  }
}

class Person extends Entity {
  final int id;
  final String name;
  final int age;
  final double weight;
  final bool married;
  final DateTime birthday;

  const Person({
    required this.id,
    required this.name,
    required this.age,
    required this.weight,
    required this.married,
    required this.birthday,
  });

  [@override](/user/override)
  Map<Symbol, dynamic> get properties => {
        #id: id,
        #name: name,
        #age: age,
        #weight: weight,
        #married: married,
        #birthday: birthday,
      };
}