Flutter Windows平台存储插件shared_preferences_windows的使用

简介

shared_preferences_windows 是 shared_preferences 插件在Windows平台上的实现。由于它是官方推荐（endorsed）的插件，通常情况下你只需要直接使用 shared_preferences，这个插件就会自动包含到你的应用中。只有当你需要直接调用它的API时，才需要将其添加到项目的 pubspec.yaml 文件中。

使用方法

添加依赖

如果你不需要直接使用 shared_preferences_windows 的API，则无需显式地添加它到 pubspec.yaml。但是，如果你想直接使用它提供的功能，你应该将它添加到 dependencies 中：

dependencies:
  flutter:
    sdk: flutter
  shared_preferences: ^2.0.15 # 或者其他版本
  shared_preferences_windows: ^2.0.2 # 或者其他版本

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

示例代码

下面是一个完整的示例代码，演示了如何使用 shared_preferences_windows 在Flutter Windows应用程序中保存和读取数据。

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/material.dart';
import 'package:shared_preferences_platform_interface/shared_preferences_async_platform_interface.dart';
import 'package:shared_preferences_windows/shared_preferences_windows.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'SharedPreferences Demo',
      home: SharedPreferencesDemo(),
    );
  }
}

class SharedPreferencesDemo extends StatefulWidget {
  const SharedPreferencesDemo({super.key});

  @override
  SharedPreferencesDemoState createState() => SharedPreferencesDemoState();
}

class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
  final SharedPreferencesAsyncPlatform? _prefs =
      SharedPreferencesAsyncPlatform.instance;
  final SharedPreferencesWindowsOptions options =
      const SharedPreferencesWindowsOptions();
  static const String _counterKey = 'counter';
  late Future<int> _counter;

  Future<void> _incrementCounter() async {
    // Read the counter value from SharedPreferences, defaulting to 0 if not set
    final int? value = await _prefs!.getInt(_counterKey);
    final int counter = (value ?? 0) + 1;

    setState(() {
      // Update the counter value in SharedPreferences and refresh the UI
      _counter = _prefs.setInt(_counterKey, counter).then((_) {
        return counter;
      });
    });
  }

  Future<void> _getAndSetCounter() async {
    setState(() {
      // Fetch the current counter value or set it to 0 if it doesn't exist
      _counter = _prefs!.getInt(_counterKey).then((int? counter) {
        return counter ?? 0;
      });
    });
  }

  @override
  void initState() {
    super.initState();
    // Initialize the counter when the widget is first created
    _getAndSetCounter();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('SharedPreferences Demo'),
      ),
      body: Center(
          child: FutureBuilder<int>(
              future: _counter,
              builder: (BuildContext context, AsyncSnapshot<int> snapshot) {
                switch (snapshot.connectionState) {
                  case ConnectionState.none:
                  case ConnectionState.waiting:
                    return const CircularProgressIndicator();
                  case ConnectionState.active:
                  case ConnectionState.done:
                    if (snapshot.hasError) {
                      return Text('Error: ${snapshot.error}');
                    } else {
                      return Text(
                        'Button tapped ${snapshot.data} time${snapshot.data == 1 ? '' : 's'}.\n\n'
                        'This should persist across restarts.',
                      );
                    }
                }
              })),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

注意事项

• SharedPreferencesWindowsOptions 可以用来配置一些特定于Windows平台的行为，但在大多数情况下，默认配置就足够用了。
• 在实际开发中，建议对 SharedPreferences 的操作进行错误处理，确保应用程序的健壮性。
• SharedPreferences 适用于简单的键值对存储需求。对于更复杂的数据结构或大量数据的存储，请考虑使用SQLite、Hive等更适合的解决方案。

希望以上内容能帮助你在Windows平台上顺利使用 shared_preferences 插件！如果有任何问题或需要进一步的帮助，请随时提问。