Flutter数据库加密插件sqlcipher_library_windows的使用

Flutter数据库加密插件sqlcipher_library_windows的使用

SQLCipher(SQLite3) V4.5.0库 for Windows X64

这个包帮助你将SQLCipher(SQLite3)库打包到你的应用程序中。它最初是为与SQLite3 with SQLCipher一起使用而开发的。

依赖项

要使SQLCipher正常工作，需要与OpenSSL 64位库（libcrypto-1_1-x64.dll和libssl-1_1-x64.dll）一起使用。这些库会自动复制到主Flutter程序的附近，以便与sqlcipher.dll动态链接。

你也可以将这两个DLL文件复制到你选择的Windows PATH目录中。

如何与SQLite3包一起使用

在Windows上使用SQLCipher时，你需要覆盖默认的打开函数，并提供由该包提供的openSQLCipherOnWindows函数：

import 'package:sqlite3/open.dart';
import 'package:sqlcipher_library_windows/sqlcipher_library_windows.dart';

// 覆盖Windows上的默认打开函数
open.overrideFor(OperatingSystem.windows, openSQLCipherOnWindows);

错误处理

如果你在运行时遇到错误，请确保：

• 你正在使用64位Windows版本。
• 使用Process Monitor查找有关错误的详细信息（例如，找不到某个DLL文件）。

完整示例Demo

以下是一个完整的示例，展示了如何在Flutter应用程序中使用sqlcipher_library_windows插件来创建和操作加密的SQLite数据库。

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:sqlcipher_library_windows/sqlcipher_library_windows.dart';
import 'package:sqlite3/open.dart';
import 'package:sqlite3/sqlite3.dart' as sql;
import 'package:path_provider/path_provider.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late sql.Database _db;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            OutlinedButton(
              onPressed: testSQLCipherOnWindows, 
              child: Text("Test")
            )
          ],
        ),
      ),
    );
  }

  /// 创建加密数据库
  void testSQLCipherOnWindows() async {
    if (Platform.isWindows == false) {
      return;
    } else {
      // 覆盖Windows上的默认打开函数
      open.overrideFor(OperatingSystem.windows, openSQLCipherOnWindows);
    }

    // 设置数据库密码
    final String password = "test";

    // 获取应用文档目录路径
    Directory appDocDir = await getApplicationDocumentsDirectory();
    String appDocPath = appDocDir.path;
    String filename = "$appDocPath${Platform.pathSeparator}testDB.sqlite";

    // 打开或创建数据库
    _db = sql.sqlite3.open(filename, mode: sql.OpenMode.readWriteCreate);
    if (_db.handle.address > 0) {
      print("Database created here: $filename");
      _db.execute("PRAGMA key = '$password'"); // 设置数据库密码
      print("Database password set: $password");
    }

    // 获取SQLite和SQLCipher版本
    getVersion();

    // 创建表结构
    createSchema();

    // 插入数据
    insertRows();

    // 读取数据
    readRows();
  }

  /// 创建表结构
  void createSchema() {
    _db.execute('''
      CREATE TABLE IF NOT EXISTS artists (
        id INTEGER NOT NULL PRIMARY KEY,
        name TEXT NOT NULL
      );
    ''');
  }

  /// 插入数据
  void insertRows() {
    final dynamic stmt = _db.prepare('INSERT INTO artists (name) VALUES (?)');
    stmt
      ..execute(['The Beatles'])
      ..execute(['Led Zeppelin'])
      ..execute(['The Who'])
      ..execute(['Nirvana']);
    stmt.dispose(); // 释放资源
  }

  /// 读取数据
  void readRows() {
    final sql.ResultSet resultSet = _db.select('SELECT * FROM artists WHERE name LIKE ?', ['The %']);
    resultSet.forEach((element) {
      print(element);
    });
    for (final sql.Row row in resultSet) {
      print('Artist[id: ${row['id']}, name: ${row['name']}]');
    }
  }

  /// 获取SQLite和SQLCipher版本
  void getVersion() {
    final sql.ResultSet sqliteVersion = _db.select("SELECT sqlite_version()");
    sqliteVersion.forEach((element) {
      print("SQLite Version: $element");
    });

    final sql.ResultSet cipherVersion = _db.select("PRAGMA cipher_version");
    cipherVersion.forEach((element) {
      print("SQLCipher Version: $element");
    });
  }
}