Flutter本地存储插件cross_local_storage的使用

cross_local_storage简介

cross_local_storage 是一个用于Flutter项目的插件，它包装了不同平台上的本地存储解决方案：

• iOS 和 macOS 上的 NSUserDefaults
• Android 上的 SharedPreferences
• Web 上的 LocalStorage
• Windows 和 Linux 上的 JSON 文件

这些存储方式为简单数据提供了持久化存储，并且数据会异步地写入磁盘。需要注意的是，由于平台限制，无法保证所有写操作都能成功持久化到磁盘，因此该插件不适合用来保存关键性数据。

开始使用

要在项目中使用此插件，请先在 pubspec.yaml 文件中添加依赖：

dependencies:
  cross_local_storage: ^1.1.0

或者通过Git直接引用最新版本：

dependencies:
  cross_local_storage:
    git:
      url: https://github.com/marchdev-tk/cross_local_storage

接着，在您的Dart文件顶部导入插件：

import 'package:cross_local_storage/cross_local_storage.dart';

示例代码

下面是一个完整的示例应用，展示了如何使用cross_local_storage进行基本的操作，如设置、获取和清除键值对。

// Copyright (c) 2023, Your Company. Please see the AUTHORS file for details. 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:cross_local_storage/cross_local_storage.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Local Storage Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _sharedPrefController = TextEditingController();

  late LocalStorageInterface _localStorage;
  String _prefStatus = '';

  void _initLocalStorage() async {
    _localStorage = await LocalStorage.getInstance();
  }

  @override
  void initState() {
    super.initState();
    _initLocalStorage();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Local Storage Example'),
      ),
      body: Column(
        crossAxisAlignment: CrossAxisAlignment.stretch,
        mainAxisAlignment: MainAxisAlignment.center,
        children: <Widget>[
          Center(
            child: ConstrainedBox(
              constraints: const BoxConstraints(maxWidth: 300),
              child: TextField(
                controller: _sharedPrefController,
                decoration: const InputDecoration(
                  border: OutlineInputBorder(),
                  hintText: 'Type something to store...',
                ),
              ),
            ),
          ),
          const SizedBox(height: 12),
          Center(
            child: ElevatedButton(
              onPressed: () async {
                final result = await _localStorage.setString('value', _sharedPrefController.text);
                setState(() => _prefStatus = result
                    ? 'Successfully added to the Shared Prefs'
                    : 'Error occurred while adding to the Shared Prefs');
              },
              child: const Text('Add to shared prefs'),
            ),
          ),
          const SizedBox(height: 12),
          Center(
            child: ElevatedButton(
              onPressed: () {
                final result = _localStorage.getString('value');
                setState(() =>
                    _prefStatus = 'Retrieved value from Shared Prefs: $result');
              },
              child: const Text('Get from shared prefs'),
            ),
          ),
          const SizedBox(height: 12),
          Center(
            child: ElevatedButton(
              onPressed: () {
                _localStorage.clear();
                setState(() => _prefStatus = 'Cleared Shared Prefs');
              },
              child: const Text('Clear shared prefs'),
            ),
          ),
          const SizedBox(height: 12),
          Center(child: Text(_prefStatus)),
        ],
      ),
    );
  }
}

这个应用程序提供了一个简单的界面，用户可以在其中输入文本并将其保存到本地存储中。此外，还可以从本地存储中检索已保存的文本或清除所有存储的数据。通过这种方式，您可以轻松测试cross_local_storage的功能。

如果您有任何问题或需要更多帮助，请随时查阅 GitHub仓库 中的文档或提交issue。