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

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

awc_shared_pref 是一个用于在 Flutter 应用中进行本地数据存储的插件。通过此插件,开发者可以轻松地将数据保存到设备的共享偏好设置中,并在需要时检索这些数据。

获取开始

本项目是一个 Flutter 插件包的起点,它包含适用于 Android 和/或 iOS 的平台特定实现代码。

安装插件

首先,在你的 pubspec.yaml 文件中添加以下依赖项:

dependencies:
  awc_shared_pref: ^1.0.0

然后运行 flutter pub get 来获取新的依赖项。

示例代码

下面是一个完整的示例,展示了如何使用 awc_shared_pref 插件来存储和读取数据。

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

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

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

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

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _sharedPrefs = AwcSharedPref();

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

  // 初始化平台状态
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能是异步的,所以我们初始化在一个异步方法中
    try {
      platformVersion = await _sharedPrefs.getString('key') ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // 如果小部件从树中移除且异步平台消息仍在飞行中,我们希望丢弃回复而不是调用setState
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  // 存储数据
  Future<void> saveData() async {
    await _sharedPrefs.setString('key', 'Hello, World!');
  }

  // 读取数据
  Future<void> readData() async {
    String value = await _sharedPrefs.getString('key');
    setState(() {
      _platformVersion = value;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: saveData,
                child: Text('Save Data'),
              ),
              ElevatedButton(
                onPressed: readData,
                child: Text('Read Data'),
              ),
              Text('Stored Value: $_platformVersion\n'),
            ],
          ),
        ),
      ),
    );
  }
}

更多关于Flutter本地数据存储插件awc_shared_pref的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter本地数据存储插件awc_shared_pref的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


awc_shared_pref 是一个用于 Flutter 的本地数据存储插件,它基于 shared_preferences 封装,提供了更简洁的 API 来存储和读取数据。shared_preferences 是 Flutter 官方推荐的用于存储简单键值对的插件,而 awc_shared_pref 则在此基础上进行了进一步的封装,使得开发者能够更方便地使用。

安装 awc_shared_pref

首先,你需要在 pubspec.yaml 文件中添加 awc_shared_pref 依赖:

dependencies:
  flutter:
    sdk: flutter
  awc_shared_pref: ^1.0.0  # 请检查最新版本

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

基本用法

awc_shared_pref 提供了简洁的 API 来存储和读取数据。以下是一些常见的使用场景:

1. 初始化

在使用 awc_shared_pref 之前,通常需要先初始化它。你可以在应用的 main 函数中进行初始化:

import 'package:awc_shared_pref/awc_shared_pref.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await AwcSharedPref.init();
  runApp(MyApp());
}

2. 存储数据

你可以使用 AwcSharedPref 提供的 set 方法来存储数据:

AwcSharedPref.setString('key', 'value'); // 存储字符串
AwcSharedPref.setInt('key', 123);       // 存储整数
AwcSharedPref.setDouble('key', 123.45); // 存储浮点数
AwcSharedPref.setBool('key', true);     // 存储布尔值
AwcSharedPref.setStringList('key', ['value1', 'value2']); // 存储字符串列表

3. 读取数据

你可以使用 AwcSharedPref 提供的 get 方法来读取数据:

String stringValue = AwcSharedPref.getString('key');
int intValue = AwcSharedPref.getInt('key');
double doubleValue = AwcSharedPref.getDouble('key');
bool boolValue = AwcSharedPref.getBool('key');
List<String> stringListValue = AwcSharedPref.getStringList('key');

4. 删除数据

你可以使用 AwcSharedPref 提供的 remove 方法来删除某个键值对:

AwcSharedPref.remove('key');

5. 检查是否存在某个键

你可以使用 AwcSharedPref 提供的 containsKey 方法来检查某个键是否存在:

bool exists = AwcSharedPref.containsKey('key');

6. 清除所有数据

你可以使用 AwcSharedPref 提供的 clear 方法来清除所有存储的数据:

AwcSharedPref.clear();

示例代码

以下是一个完整的示例代码,展示了如何使用 awc_shared_pref 存储和读取数据:

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await AwcSharedPref.init();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('awc_shared_pref Example'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  await AwcSharedPref.setString('username', 'JohnDoe');
                  print('Username saved');
                },
                child: Text('Save Username'),
              ),
              ElevatedButton(
                onPressed: () {
                  String username = AwcSharedPref.getString('username') ?? 'No username saved';
                  print('Username: $username');
                },
                child: Text('Load Username'),
              ),
              ElevatedButton(
                onPressed: () async {
                  await AwcSharedPref.remove('username');
                  print('Username removed');
                },
                child: Text('Remove Username'),
              ),
              ElevatedButton(
                onPressed: () async {
                  await AwcSharedPref.clear();
                  print('All data cleared');
                },
                child: Text('Clear All Data'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}
回到顶部