Flutter密钥管理插件flutter_keystore的使用

Flutter密钥管理插件flutter_keystore的使用

安装

在pubspec.yaml文件中添加以下依赖：

dependencies:
  flutter_keystore:
    git:
      url: https://github.com/TimothyGCY/flutter_keystore.git

然后运行 flutter pub get 来安装该插件。

使用

首先，我们需要实例化插件对象：

// 实例化插件
final FlutterKeyStore keyStore = FlutterKeyStore();

接下来，我们可以进行数据的读取、写入和删除操作：

// 向密钥库写入数据
await keyStore.write('key', 'value');

// 从密钥库通过键读取数据
await keyStore.read('key');

// 从密钥库通过键删除数据
await keyStore.delete('key');

以下是完整的示例代码：

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

import 'package:flutter/services.dart';
import 'package:flutter_keystore/flutter_keystore.dart';

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _storeValue = '';
  final _flutterKeystorePlugin = FlutterKeyStore();
  final String myDataKey = 'hello';
  final TextEditingController _valueController = TextEditingController();

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

  [@override](/user/override)
  void dispose() {
    _valueController.dispose();
    super.dispose();
  }

  Future<void> _loadStoreData() async {
    String value;
    try {
      // 从密钥库读取数据
      value = await _flutterKeystorePlugin.read(myDataKey) ?? '(Empty)';
    } on PlatformException {
      // 处理平台异常
      value = 'Failed to read store value';
    }

    if (!mounted) return;

    // 更新UI
    setState(() {
      _storeValue = value;
    });
  }

  Future<void> _onSave() async {
    final String value = _valueController.text.trim();
    if (value.isEmpty) {
      // 如果输入为空，则删除数据
      await _onDelete();
    } else {
      // 向密钥库写入数据
      await _flutterKeystorePlugin.write(myDataKey, value);
    }
    // 清空输入框并重新加载数据
    _valueController.clear();
    _loadStoreData();
  }

  Future<void> _onDelete() async {
    // 从密钥库删除数据
    await _flutterKeystorePlugin.delete(myDataKey);
    _loadStoreData();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Column(
          children: [
            Expanded(
              child: Center(
                child: Text('密钥库中的值: $_storeValue'),
              ),
            ),
            Expanded(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  Padding(
                    padding: const EdgeInsets.symmetric(horizontal: 28.0),
                    child: TextField(
                      controller: _valueController,
                      decoration: const InputDecoration(
                        border: OutlineInputBorder(),
                        label: Text('存储中的值'),
                      ),
                    ),
                  ),
                  const SizedBox(height: 24),
                  Row(
                    mainAxisAlignment: MainAxisAlignment.center,
                    children: [
                      ElevatedButton(
                        onPressed: _onSave,
                        child: const Text('保存'),
                      ),
                      const SizedBox(width: 24),
                      ElevatedButton(
                        onPressed: _onDelete,
                        child: const Text('删除'),
                      ),
                    ],
                  )
                ],
              ),
            ),
          ],
        ),
      ),
    );
  }
}