Flutter加密共享偏好设置插件encrypted_shared_preferences的使用

此插件用于将共享偏好设置以加密的形式存储。读取时自动解密。你可以与常规的共享偏好设置并行使用。

使用

实例化类

EncryptedSharedPreferences encryptedSharedPreferences = EncryptedSharedPreferences();

保存值

encryptedSharedPreferences.setString('sample', 'Hello, World!').then((bool success) {
    if (success) {
        print('success');
    } else {
        print('fail');
    }
});

获取值

encryptedSharedPreferences.getString('sample').then((String value) {
    print(value); /// Prints Hello, World!
});

删除值

encryptedSharedPreferences.remove('sample').then((bool success) {
    if (success) {
        print('success');
    } else {
        print('fail');
    }
});

清除所有值

/// 清除所有值，包括你用常规共享偏好设置保存的值。
encryptedSharedPreferences.clear().then((bool success) {
    if (success) {
        print('success');
    } else {
        print('fail');
    }
});

重新加载

encryptedSharedPreferences.reload();

自定义SharedPreferences实例

/// 可以传递一个自定义的SharedPreferences实例（例如：更新版的SharedPreferences）
final prefs = await SharedPreferences.getInstance();
EncryptedSharedPreferences encryptedSharedPreferences = EncryptedSharedPreferences(prefs: prefs);

访问内部的SharedPreferences实例

// 可以访问内部的SharedPreferences实例来调用未被常规EncryptedSharedPreferences公开的方法
SharedPreferences instance = await encryptedSharedPreferences.getInstance();
int counter = 1;

/// 访问SharedPreferences的setInt方法
await instance.setInt('counter', counter);

加密模式

默认模式为SIC AESMode.sic，可以通过名为mode的参数覆盖它：

EncryptedSharedPreferences encryptedSharedPreferences = EncryptedSharedPreferences(mode: AESMode.cbc);

支持的模式有：

• CBC <code>AESMode.cbc</code>
• CFB-64 <code>AESMode.cfb64</code>
• CTR <code>AESMode.ctr</code>
• ECB <code>AESMode.ecb</code>
• OFB-64/GCTR <code>AESMode.ofb64Gctr</code>
• OFB-64 <code>AESMode.ofb64</code>
• SIC <code>AESMode.sic</code>

完整示例

以下是一个完整的示例代码，演示如何在Flutter应用中使用encrypted_shared_preferences插件。

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

void main() => runApp(MyApp());

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

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

class _MyHomePageState extends State<MyHomePage> {
  final EncryptedSharedPreferences encryptedSharedPreferences = EncryptedSharedPreferences();
  final _formKey = GlobalKey<FormState>();
  final myController = TextEditingController();
  String value = '';

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

  init() async {
    encryptedSharedPreferences.getString('sample').then((String _value) {
      setState(() {
        value = _value;
      });
    });
  }

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Encrypted Shared Preferences Demo Page'),
      ),
      body: Form(
          key: _formKey,
          child: Padding(
            padding: const EdgeInsets.all(8.0),
            child: Column(
              children: <Widget>[
                TextFormField(
                    decoration:
                        InputDecoration(hintText: 'Type text here and save'),
                    controller: myController,
                    validator: (value) {
                      if (value != null && value.isEmpty) {
                        return 'Please enter some text';
                      }
                      return null;
                    }),
                Text('Current value: $value')
              ],
            ),
          )),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          if (_formKey.currentState!.validate()) {
            encryptedSharedPreferences
                .setString('sample', myController.text)
                .then((bool success) {
              if (success) {
                print('success');
                encryptedSharedPreferences
                    .getString('sample')
                    .then((String _value) {
                  setState(() {
                    value = _value;
                  });
                });
              } else {
                print('fail');
              }
            });
          }
        },
        tooltip: 'Save',
        child: Icon(Icons.save),
      ),
    );
  }
}