Flutter配置缓存插件configcat_preferences_cache的使用

ConfigCat Flutter Preferences Cache

ConfigCat Flutter Preferences Cache是为ConfigCat Dart (Flutter) SDK提供的缓存实现。它通过shared_preferences为Flutter应用程序在各种平台上提供缓存功能。

缓存存储位置

• Web: 浏览器 LocalStorage。
• iOS / macOS: NSUserDefaults。
• Android: SharedPreferences。
• Linux: 文件位于 XDG_DATA_HOME 目录中。
• Windows: 文件位于漫游 AppData 目录中。

开始使用

1. 安装包以及ConfigCat Dart (Flutter) SDK

flutter pub add configcat_preferences_cache
flutter pub add configcat_client

2. 在应用代码中导入configcat_client和configcat_cache包

import 'package:configcat_preferences_cache/configcat_preferences_cache.dart';
import 'package:configcat_client/configcat_client.dart';

3. 在ConfigCat SDK初始化时使用ConfigCatPreferencesCache

final client = ConfigCatClient.get(
    sdkKey: '#YOUR-SDK-KEY#',
    options: ConfigCatOptions(cache: ConfigCatPreferencesCache()));

示例代码

以下是一个完整的示例，展示了如何在Flutter应用中集成configcat_preferences_cache插件，并根据特征标记（feature flag）更新UI。

import 'package:configcat_client/configcat_client.dart';
import 'package:configcat_preferences_cache/configcat_preferences_cache.dart';
import 'package:flutter/material.dart';
import 'package:get_it/get_it.dart';

void main() {
  GetIt.I.registerSingleton<ConfigCatClient>(
      ConfigCatClient.get(
          sdkKey: 'PKDVCLf-Hq-h-kCzMp-L7Q/HhOWfwVtZ0mb30i9wi17GQ',
          options: ConfigCatOptions(
              // 使用ConfigCat的共享偏好设置缓存。
              cache: ConfigCatPreferencesCache(),
              logger: ConfigCatLogger(
                  // Info级别日志有助于检查特征标记评估过程。
                  // 使用默认警告级别以避免在应用中记录过多详细信息。
                  level: LogLevel.info))),
      dispose: (client) => client.close());
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ConfigCat Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.deepOrange,
      ),
      home: const MyHomePage(title: 'ConfigCat Flutter Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  bool _value = false;

  Future<void> _getFeatureFlagValue() async {
    final client = GetIt.I<ConfigCatClient>();
    final user = ConfigCatUser(
        identifier: '#SOME-USER-ID#', email: 'configcat@example.com');

    final value = await client.getValue(
        key: 'isPOCFeatureEnabled', defaultValue: false, user: user);
    setState(() {
      _value = value;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Padding(
              padding: EdgeInsets.all(20),
              child: Text(
                'Value of isPOCFeatureEnabled:',
                style: TextStyle(fontSize: 20),
              ),
            ),
            Text(
              '$_value',
              style: Theme.of(context).textTheme.headline4,
            ),
            Padding(
              padding: const EdgeInsets.all(50),
              child: TextButton(
                  onPressed: () async {
                    await _getFeatureFlagValue();
                  },
                  style: TextButton.styleFrom(
                      padding: const EdgeInsets.all(20),
                      textStyle: const TextStyle(fontSize: 30)),
                  child: const Text('Get Value')),
            ),
          ],
        ),
      ),
    );
  }
}

这个例子创建了一个简单的Flutter应用，当用户点击按钮时，会从ConfigCat获取一个名为isPOCFeatureEnabled的特征标记值，并更新页面上的文本显示该值。此过程利用了configcat_preferences_cache来缓存特征标记的状态，从而提高了性能并减少了不必要的网络请求。