Flutter本地数据存储插件app_preference_shared_preferences的使用

简介

app_preference_shared_preferences 是一个基于 shared_preferences 的 Flutter 插件，用于在应用中实现简单的本地数据存储。它提供了对键值对数据的读写功能，并且可以轻松集成到现有的 Flutter 项目中。

以下是一个完整的示例，展示如何使用 app_preference_shared_preferences 插件来存储和读取本地数据。

安装插件

在项目的 pubspec.yaml 文件中添加依赖：

dependencies:
  app_preference_shared_preferences: ^1.0.0

然后运行以下命令以安装依赖：

flutter pub get

使用示例

1. 初始化插件

首先，确保在应用启动时初始化插件。通常可以在 main() 函数中完成：

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

void main() async {
  // 初始化插件
  await AppPreference.init();
  
  runApp(MyApp());
}

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

2. 存储数据

使用 AppPreference 类的静态方法来存储数据。例如，存储字符串、整数或布尔值：

// 存储字符串
await AppPreference.putString('username', 'JohnDoe');

// 存储整数
await AppPreference.putInt('age', 25);

// 存储布尔值
await AppPreference.putBool('isLoggedIn', true);

3. 读取数据

从本地存储中读取数据也非常简单：

// 读取字符串
String username = await AppPreference.getString('username');
print('Username: $username');

// 读取整数
int age = await AppPreference.getInt('age');
print('Age: $age');

// 读取布尔值
bool isLoggedIn = await AppPreference.getBool('isLoggedIn');
print('Is Logged In: $isLoggedIn');

4. 删除数据

如果需要删除某个键值对，可以使用 remove() 方法：

// 删除指定键值对
await AppPreference.remove('username');

// 清空所有数据
await AppPreference.clear();

完整示例代码

以下是一个完整的示例代码，展示了如何使用 app_preference_shared_preferences 插件进行本地数据存储和读取：

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

void main() async {
  // 初始化插件
  await AppPreference.init();

  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> {
  String _username = '';
  int _age = 0;
  bool _isLoggedIn = false;

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

  Future<void> _loadData() async {
    // 从本地存储中加载数据
    _username = await AppPreference.getString('username') ?? '';
    _age = await AppPreference.getInt('age') ?? 0;
    _isLoggedIn = await AppPreference.getBool('isLoggedIn') ?? false;

    setState(() {});
  }

  Future<void> _saveData() async {
    // 将数据保存到本地存储
    await AppPreference.putString('username', 'JohnDoe');
    await AppPreference.putInt('age', 25);
    await AppPreference.putBool('isLoggedIn', true);

    ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text('Data saved')));
  }

  Future<void> _clearData() async {
    // 清除本地存储中的数据
    await AppPreference.clear();
    _loadData();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('App Preference Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            TextField(
              decoration: InputDecoration(hintText: 'Enter Username'),
              onChanged: (value) {
                setState(() {
                  _username = value;
                });
              },
            ),
            SizedBox(height: 16),
            TextField(
              keyboardType: TextInputType.number,
              decoration: InputDecoration(hintText: 'Enter Age'),
              onChanged: (value) {
                setState(() {
                  _age = int.tryParse(value) ?? 0;
                });
              },
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: _saveData,
              child: Text('Save Data'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: _clearData,
              child: Text('Clear Data'),
            ),
            SizedBox(height: 16),
            Text('Username: $_username'),
            Text('Age: $_age'),
            Text('Is Logged In: $_isLoggedIn ?'),
          ],
        ),
      ),
    );
  }
}