Flutter自动缓存插件flutter_auto_cache的使用

Introduction

Flutter Auto Cache 是一个为 Flutter 设计的高级缓存管理器，旨在优化移动应用中的缓存管理。它提供了强大的缓存替换策略、加密方法和高效的磁盘空间管理。通过利用 shared_preferences，我们的平台为缓存数据管理提供了全面的解决方案。

使用 Flutter Auto Cache，您可以无缝集成高级缓存管理功能，让您专注于应用程序的核心功能，而我们将处理数据缓存的复杂性。用户友好的界面和强大的功能使 Flutter Auto Cache 成为希望在应用程序中实现高性能和安全性的 Flutter 开发者的首选。

体验无与伦比的缓存管理效率和可靠性。

Installation

开始使用 Flutter Auto Cache 非常简单，可以通过以下几种方式将其添加到您的项目中。

Adding via pub.dev

要通过 pub.dev 添加 Flutter Auto Cache，运行以下命令：

flutter pub add flutter_auto_cache

Installing Locally

如果您希望本地安装 Flutter Auto Cache，请按照以下步骤操作：

1. 克隆 FlutterAutoCache 仓库：

   git clone https://github.com/luizgasparetto/flutter_auto_cache.git
   

2. 导航到项目的 pubspec.yaml 文件并添加以下依赖项：

   dependencies:
     flutter_auto_cache:
       path: ../path_to_flutter_auto_cache
   

3. 安装依赖项：

   flutter pub get
   

安装完成后，您可以在 Flutter 项目中使用 Flutter Auto Cache 来增强应用程序的缓存管理，包括加密和高效的磁盘空间管理。

Usage

使用 Flutter Auto Cache 时，需要在调用 runApp 之前初始化缓存管理器。这确保了所有缓存配置都正确设置。您还可以传递自定义的初始化配置。

import 'package:flutter_auto_cache/flutter_auto_cache.dart';

Future<void> main() async {
  /// 可选：如果需要，可以传递自定义的 CacheConfiguration
  await AutoCacheInitializer.initialize(configuration: yourCustomConfiguration);

  runApp(MyApp());
}

初始化后，您可以直接从 AutoCache 类中使用缓存管理方法。以下是如何访问偏好设置缓存管理器的示例：

await AutoCache.prefs.getString(key: "my_string_cached");

通过此设置，您可以轻松地使用 AutoCache 提供的方法来管理应用程序的缓存。

注意 CacheConfiguration 的每个属性都会对缓存的行为产生不同的影响。了解这些属性对于优化应用程序的性能和可靠性非常重要。

Example

以下是一个完整的示例代码，展示了如何在 Flutter 应用程序中使用 Flutter Auto Cache。

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

import 'src/constants/cache_constants.dart';

Future<void> main() async {
  await AutoCacheInitializer.initialize();

  runApp(const AppWidget());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData.dark(useMaterial3: true),
      debugShowCheckedModeBanner: false,
      home: const HomePage(),
    );
  }
}

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

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  final store = CounterStore();

  @override
  void initState() {
    super.initState();
    store.getCount();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Flutter Auto Cache')),
      body: Center(
        child: ValueListenableBuilder<int>(
          valueListenable: store,
          builder: (context, count, _) {
            return Row(
              mainAxisAlignment: MainAxisAlignment.spaceBetween,
              mainAxisSize: MainAxisSize.min,
              children: [
                IconButton(onPressed: store.decrement, icon: const Icon(Icons.remove)),
                Text(count.toString(), style: const TextStyle(fontSize: 24)),
                IconButton(onPressed: store.increment, icon: const Icon(Icons.add)),
              ],
            );
          },
        ),
      ),
    );
  }
}

class CounterStore extends ValueNotifier<int> {
  CounterStore() : super(0);

  Future<void> increment() => _updateCount(() => value += 1);

  Future<void> decrement() => _updateCount(() => value -= 1);

  Future<void> getCount() async {
    final response = await AutoCache.data.getInt(key: CacheConstants.countKey);
    value = response.data ?? 0;
  }

  Future<void> _updateCount(VoidCallback action) async {
    action.call();
    await AutoCache.data.saveInt(key: CacheConstants.countKey, data: value);
  }
}

在这个示例中，我们创建了一个简单的计数器应用，并使用 Flutter Auto Cache 来管理计数器的缓存。CounterStore 类使用 ValueNotifier 来监听计数器的变化，并通过 AutoCache 方法来读取和保存计数器的值。

Contributing

Flutter Auto Cache 的大部分代码是开源的。我们致力于透明的开发过程，并非常欢迎任何贡献。无论是帮助我们修复错误、提出新功能还是改进文档，我们都非常感谢。

• Bug Report: 如果您在使用此包时遇到错误消息或问题，请创建一个 bug report。
• Feature Request: 如果您有想法或缺少某个功能，可以使开发更简单和更强大，请提交一个 feature request。

License

Flutter Auto Cache 采用 BSD-3-Clause 许可证。该许可证允许以源代码和二进制形式重新分发和使用软件，无论是否进行修改，前提是满足许可证中规定的条款和条件。通过使用 Flutter Auto Cache，您同意遵守这些条款和条件，以确保软件的保护和正确使用。