Flutter本地存储插件flutterx_preferences的使用

Flutter本地存储插件flutterx_preferences的使用

通过flutterx_preferences插件，你可以快速且可靠地持久化和查询共享数据，并集成LiveData来观察活动偏好设置的任何更改。

导入库

首先，你需要导入flutterx_preferences库：

import 'package:flutterx_preferences/flutterx_preferences.dart';

使用方法

以下是一个完整的示例，展示了如何使用flutterx_preferences插件。这个示例展示了一个简单的应用程序，用户可以更改颜色并记录点击次数。

import 'package:example/app_settings.dart'; // 引入应用设置类
import 'package:flutter/material.dart';
import 'package:flutterx_live_data/flutterx_live_data.dart'; // 引入LiveData库
import 'package:flutterx_material_tool/flutterx_material_tool.dart'; // 引入材料工具库
import 'package:flutterx_preferences/flutterx_preferences.dart'; // 引入flutterx_preferences库

Future<void> main() async {
  await Preferences.initialize(); // 初始化偏好设置
  runApp(const MyApp()); // 运行主应用
}

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

  [@override](/user/override)
  Widget build(BuildContext context) => LiveDataBuilder<AppSettings>(
        data: AppSettings.instance, // 获取应用设置实例
        builder: (context, settings) => MaterialApp(
            debugShowCheckedModeBanner: false, // 禁用调试标志
            title: 'Flutterx Preferences Demo', // 应用标题
            theme: ThemeData.from(
              colorScheme: generateScheme(
                primary: settings.appColor, // 设置主要颜色
                onLight: Colors.grey.shade600, // 设置亮色主题的颜色
                onDark: Colors.grey.shade400, // 设置暗色主题的颜色
              ),
            ),
            home: const PreferencesExample()), // 设置首页
      );
}

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

  [@override](/user/override)
  State<PreferencesExample> createState() => _PreferencesExampleState();
}

class _PreferencesExampleState extends State<PreferencesExample> {
  final List<Color> _colors = Colors.primaries; // 定义颜色列表
  final Preferences _preferences = Preferences.local('preferences'); // 创建本地偏好设置对象

  [@override](/user/override)
  Widget build(BuildContext context) => Scaffold(
      appBar: AppBar(
        title: const Text('Preferences example'), // 设置AppBar标题
        backgroundColor: Theme.of(context).primaryColor, // 设置AppBar背景颜色
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            SingleChildScrollView(
              scrollDirection: Axis.horizontal, // 水平滚动
              child: ToggleButtons(
                  isSelected: _colors.map((color) => AppSettings.instance.appColor == color).toList(), // 判断当前颜色是否被选中
                  onPressed: (value) => AppSettings.instance.appColor = _colors[value], // 更新应用颜色
                  renderBorder: false, // 不渲染边框
                  children: _colors
                      .map((color) => Material(
                          shape: const CircleBorder(), // 圆形按钮
                          elevation: 2,
                          color: color,
                          child: SizedBox.fromSize(size: const Size.square(40)))) // 设置按钮大小
                      .toList()),
            ),
            const SizedBox(height: 100), // 添加间距
            Text('pressed ${_preferences.getInt('counter')} times'), // 显示点击次数
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
          onPressed: () async { // 点击按钮时更新点击次数
            final counter = _preferences.getInt('counter');
            _preferences.setInt('counter', counter + 1); // 更新计数器
            setState(() {}); // 通知框架重建视图
          },
          child: const Icon(Icons.add))); // 设置图标
}