octodb_sqflite_common 是一个用于 Flutter 的数据库管理插件，它基于 sqflite 库，提供了更高级的抽象和功能，使得在 Flutter 应用中管理 SQLite 数据库变得更加简单和高效。以下是如何使用 octodb_sqflite_common 插件的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 octodb_sqflite_common 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  octodb_sqflite_common: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 初始化数据库

在使用 octodb_sqflite_common 之前，你需要初始化数据库。通常，你可以在应用的 main 函数中完成这个操作。

import 'package:octodb_sqflite_common/octodb_sqflite_common.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化数据库
  await OctoDB.initialize(
    databaseName: 'my_database.db',
    version: 1,
    onCreate: (db, version) async {
      // 创建表
      await db.execute('''
        CREATE TABLE users (
          id INTEGER PRIMARY KEY AUTOINCREMENT,
          name TEXT,
          age INTEGER
        )
      ''');
    },
    onUpgrade: (db, oldVersion, newVersion) async {
      // 数据库升级逻辑
    },
  );

  runApp(MyApp());
}

3. 使用数据库

初始化数据库后，你可以使用 OctoDB 类来执行各种数据库操作。

插入数据

Future<void> insertUser(User user) async {
  final db = await OctoDB.database;
  await db.insert(
    'users',
    user.toMap(),
    conflictAlgorithm: ConflictAlgorithm.replace,
  );
}

查询数据

Future<List<User>> getUsers() async {
  final db = await OctoDB.database;
  final List<Map<String, dynamic>> maps = await db.query('users');

  return List.generate(maps.length, (i) {
    return User.fromMap(maps[i]);
  });
}

更新数据

Future<void> updateUser(User user) async {
  final db = await OctoDB.database;
  await db.update(
    'users',
    user.toMap(),
    where: 'id = ?',
    whereArgs: [user.id],
  );
}

删除数据

Future<void> deleteUser(int id) async {
  final db = await OctoDB.database;
  await db.delete(
    'users',
    where: 'id = ?',
    whereArgs: [id],
  );
}

4. 关闭数据库

在应用退出时，你可以选择关闭数据库以释放资源。

Future<void> closeDatabase() async {
  final db = await OctoDB.database;
  await db.close();
}

5. 示例模型类

以下是一个简单的 User 模型类，用于映射数据库中的 users 表。

class User {
  int id;
  String name;
  int age;

  User({this.id, this.name, this.age});

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'name': name,
      'age': age,
    };
  }

  factory User.fromMap(Map<String, dynamic> map) {
    return User(
      id: map['id'],
      name: map['name'],
      age: map['age'],
    );
  }
}

6. 完整示例

以下是一个完整的示例，展示了如何使用 octodb_sqflite_common 插件进行数据库操作。

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  await OctoDB.initialize(
    databaseName: 'my_database.db',
    version: 1,
    onCreate: (db, version) async {
      await db.execute('''
        CREATE TABLE users (
          id INTEGER PRIMARY KEY AUTOINCREMENT,
          name TEXT,
          age INTEGER
        )
      ''');
    },
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  List<User> users = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    _loadUsers();
  }

  Future<void> _loadUsers() async {
    final List<User> userList = await getUsers();
    setState(() {
      users = userList;
    });
  }

  Future<void> _addUser() async {
    final user = User(name: 'John Doe', age: 30);
    await insertUser(user);
    _loadUsers();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('OctoDB Example'),
      ),
      body: ListView.builder(
        itemCount: users.length,
        itemBuilder: (context, index) {
          final user = users[index];
          return ListTile(
            title: Text(user.name),
            subtitle: Text('Age: ${user.age}'),
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _addUser,
        child: Icon(Icons.add),
      ),
    );
  }
}

class User {
  int id;
  String name;
  int age;

  User({this.id, this.name, this.age});

  Map<String, dynamic> toMap() {
    return {
      'id': id,
      'name': name,
      'age': age,
    };
  }

  factory User.fromMap(Map<String, dynamic> map) {
    return User(
      id: map['id'],
      name: map['name'],
      age: map['age'],
    );
  }
}

Future<void> insertUser(User user) async {
  final db = await OctoDB.database;
  await db.insert(
    'users',
    user.toMap(),
    conflictAlgorithm: ConflictAlgorithm.replace,
  );
}

Future<List<User>> getUsers() async {
  final db = await OctoDB.database;
  final List<Map<String, dynamic>> maps = await db.query('users');

  return List.generate(maps.length, (i) {
    return User.fromMap(maps[i]);
  });
}