Flutter本地存储插件pro_shered_preference的使用

Flutter本地存储插件pro_shered_preference的使用

平台支持

pro_shered_preference 插件支持以下平台：

• Android
• iOS
• macOS
• Web
• Linux
• Windows

开始使用

1. 添加依赖
   在终端中运行以下命令来添加 pro_shered_preference 依赖：

   flutter pub add pro_shered_preference
   

   这将自动在 pubspec.yaml 文件中添加如下依赖，并执行 flutter pub get：

   dependencies:
     pro_shered_preference: ^0.0.7
   

2. 导入包
   在 Dart 代码中导入 pro_shered_preference 包：

   import 'package:pro_shered_preference/pro_shered_preference.dart';
   

使用方法

保存数据

pro_shered_preference 提供了多种方法来保存不同类型的数据。以下是一些常见的用法示例：

1. 保存单个字符串

   bool result = await sheredPrefHelper.setString("name", "Gautam Sheta");
   // 如果数据保存成功，返回 true
   

2. 保存多个字符串

   bool result = await sheredPrefHelper.setMultiString({
     "name": "Gautam Sheta",
     "email": "email@gmail.com",
     "address": "India",
   });
   // 如果所有数据保存成功，返回 true
   

3. 保存其他类型的数据

   • 保存整数：setInt
   • 保存浮点数：setDouble
   • 保存布尔值：setBool
   • 保存字符串列表：setStringList
   • 保存整数列表：setIntList
   • 保存浮点数列表：setDoubleList
   • 保存布尔值列表：setBoolList
   • 保存动态类型列表：setDynamicList
   • 保存映射（Map）：setMap
   • 保存任意类型的键值对：set

   示例：

   bool result = await sheredPrefHelper.setInt("age", 25);
   bool result = await sheredPrefHelper.setDouble("height", 175.5);
   bool result = await sheredPrefHelper.setBool("isStudent", true);
   bool result = await sheredPrefHelper.setStringList("cities", ["New York", "London", "Paris"]);
   

4. 批量保存数据

   • 批量保存字符串：setMultiString
   • 批量保存整数：setMultiInt
   • 批量保存浮点数：setMultiDouble
   • 批量保存布尔值：setMultiBool
   • 批量保存字符串列表：setMultiStringList
   • 批量保存整数列表：setMultiIntList
   • 批量保存浮点数列表：setMultiDoubleList
   • 批量保存布尔值列表：setMultiBoolList
   • 批量保存动态类型列表：setMultiDynamicList
   • 批量保存映射（Map）：setMultiMap
   • 批量保存任意类型的键值对：setMulti

   示例：

   bool result = await sheredPrefHelper.setMultiString({
     "name": "Gautam",
     "email": "gautam@example.com",
     "address": "India"
   });
   
   bool result = await sheredPrefHelper.setMultiInt({
     "age": 25,
     "score": 95
   });
   

获取数据

pro_shered_preference 提供了多种方法来获取不同类型的数据。以下是一些常见的用法示例：

1. 获取单个字符串

   String result = await sheredPrefHelper.getString("name");
   // 如果找不到键或数据类型不匹配，会抛出异常
   

2. 获取多个字符串

   Map<String, String> result = await sheredPrefHelper.getMultiString([
     "name",
     "email",
     "address"
   ]);
   // 如果找不到某个键或数据类型不匹配，会抛出异常
   

3. 获取其他类型的数据

   • 获取整数：getInt
   • 获取浮点数：getDouble
   • 获取布尔值：getBool
   • 获取字符串列表：getStringList
   • 获取整数列表：getIntList
   • 获取浮点数列表：getDoubleList
   • 获取布尔值列表：getBoolList
   • 获取动态类型列表：getDynamicList
   • 获取映射（Map）：getMap
   • 获取任意类型的键值对：get

   示例：

   int age = await sheredPrefHelper.getInt("age");
   double height = await sheredPrefHelper.getDouble("height");
   List<String> cities = await sheredPrefHelper.getStringList("cities");
   

4. 批量获取数据

   • 批量获取字符串：getMultiString
   • 批量获取整数：getMultiInt
   • 批量获取浮点数：getMultiDouble
   • 批量获取布尔值：getMultiBool
   • 批量获取字符串列表：getMultiStringList
   • 批量获取整数列表：getMultiIntList
   • 批量获取浮点数列表：getMultiDoubleList
   • 批量获取布尔值列表：getMultiBoolList
   • 批量获取动态类型列表：getMultiDynamicList
   • 批量获取映射（Map）：getMultiMap
   • 批量获取任意类型的键值对：getMulti

   示例：

   Map<String, String> result = await sheredPrefHelper.getMultiString([
     "name",
     "email",
     "address"
   ]);
   
   Map<String, int> result = await sheredPrefHelper.getMultiInt([
     "age",
     "score"
   ]);
   

完整示例Demo

以下是一个完整的 Flutter 示例，展示了如何使用 pro_shered_preference 插件进行本地存储操作。

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

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

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

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

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

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

class _MyHomePageState extends State<MyHomePage> {
  ProSheredPreference sheredPrefHelper = ProSheredPreference();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Pro Shared Preference Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            // 单个数据保存
            bool result = await sheredPrefHelper.setString("name", "Gautam Sheta");
            result = await sheredPrefHelper.setInt("age", 25);
            result = await sheredPrefHelper.setDouble("height", 175.5);
            result = await sheredPrefHelper.setBool("isStudent", true);
            result = await sheredPrefHelper.setStringList("cities", ["New York", "London", "Paris"]);

            // 批量数据保存
            result = await sheredPrefHelper.setMultiString({
              "name": "Gautam",
              "email": "gautam@example.com",
              "address": "India"
            });

            result = await sheredPrefHelper.setMultiInt({
              "age": 25,
              "score": 95
            });

            // 获取单个数据
            String name = await sheredPrefHelper.getString("name");
            int age = await sheredPrefHelper.getInt("age");
            double height = await sheredPrefHelper.getDouble("height");
            bool isStudent = await sheredPrefHelper.getBool("isStudent");
            List<String> cities = await sheredPrefHelper.getStringList("cities");

            // 批量获取数据
            Map<String, String> multiStringResult = await sheredPrefHelper.getMultiString([
              "name",
              "email",
              "address"
            ]);

            Map<String, int> multiIntResult = await sheredPrefHelper.getMultiInt([
              "age",
              "score"
            ]);

            // 打印结果
            print("Name: $name");
            print("Age: $age");
            print("Height: $height");
            print("Is Student: $isStudent");
            print("Cities: $cities");
            print("Multi String Result: $multiStringResult");
            print("Multi Int Result: $multiIntResult");
          },
          child: const Text("Save and Get Data"),
        ),
      ),
    );
  }
}