Flutter远程配置插件flutter_rustore_remoteconfig的使用

Flutter远程配置插件flutter_rustore_remoteconfig的使用

准备所需参数

为了运行示例，你需要以下参数：

1. <code>app_id</code> - 你的AppId来自Remote Config控制台（https://remote-config.rustore.ru）。
2. 在控制台创建配置参数。

应用程序设置

1. 将文件flutter_rustore_remoteconfig/example/lib/main.dart中的app_id变量替换为你从控制台获取的app_id。
2. 将变量String? config = ""替换为控制台中的参数值。

实现示例

为了正确集成remote-config，建议查看应用示例。

项目集成

要将包添加到项目中，请执行以下命令：

flutter pub add flutter_rustore_remoteconfig

这将在pubspec.yaml文件中添加一行：

dependencies:
    flutter_rustore_remoteconfig: ^7.0.0

创建客户端

为了使用配置，我们需要通过方法create创建一个RemoteConfigClient：

FlutterRustoreRemoteconfig.create(
    appId,
    behavior,
    interval,
    Parameters(),
    onBackgroundJobErrors: (value) {
      
    }, 
    onFirstLoadComplete: (value) {
      
    },
    onMemoryCacheUpdated: (value) {
      
    }, 
    onInitComplete: (value) {
      
    }, 
    onPersistentStorageUpdated: (value) {
      
    }, 
    onRemoteConfigNetworkRequestFailure: (value) {
      
    });

• appId - 你的项目应用ID（Remote config）；

• behavior - SDK更新策略；

• interval - 更新策略的时间间隔；

• parameters - SDK静态参数；

• Function? onBackgroundJobErrors, Function? onFirstLoadComplete, Function? onMemoryCacheUpdated, Function? onInitComplete, Function? onPersistentStorageUpdated, Function? onRemoteConfigNetworkRequestFailure - SDK事件监听器。

获取Remote Config配置

FlutterRustoreRemoteconfig.getRemoteConfig().then(((value) {
      
    }), onError: (err) {
      debugPrint("err: $err");
    });

方法getRemoteConfig返回一个RemoteConfig实例，该实例包含了根据选定的更新策略初始化时获得的所有数据。实例包含所有从服务器传递的键，这些键取决于初始化时指定的参数。

RemoteConfig类具有获取数据并将其转换为特定类型的以下方法：

containsKey(String key);
getString(String key);
getBool(String key);
getNum(String key);

• key - 控制台Remote Config中创建的参数。

完整示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:flutter_rustore_remoteconfig/flutter_rustore_remoteconfig.dart';
import 'package:flutter_rustore_remoteconfig/rustore_remote_config.dart';

void main() {
  runApp(const MaterialApp(home: StartScreen()));
}

class Parameters extends StaticParameters {
  // [@override](/user/override)
  // String? get deviceId => "42";
}

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

  [@override](/user/override)
  State<StartScreen> createState() => _StartScreenState();
}

class _StartScreenState extends State<StartScreen> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: [
              const Text("Choose update behavior"),
              ElevatedButton(
                onPressed: () {
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                      builder: (BuildContext context) => const ConfigScreen(
                          behavior: PluginUpdateBehavior.actualBehavior),
                    ),
                  );
                },
                child: const Text('Actual'),
              ),
              ElevatedButton(
                onPressed: () {
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                      builder: (BuildContext context) => const ConfigScreen(
                          behavior: PluginUpdateBehavior.defaultBehavior),
                    ),
                  );
                },
                child: const Text('Default'),
              ),
              ElevatedButton(
                onPressed: () {
                  Navigator.push(
                    context,
                    MaterialPageRoute(
                      builder: (BuildContext context) => const ConfigScreen(
                        behavior: PluginUpdateBehavior.snapshotBehavior,
                      ),
                    ),
                  );
                },
                child: const Text('Snapshot'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

class ConfigScreen extends StatefulWidget {
  const ConfigScreen({super.key, required this.behavior});

  final PluginUpdateBehavior behavior;

  [@override](/user/override)
  State<ConfigScreen> createState() => _ConfigScreenState();
}

class _ConfigScreenState extends State<ConfigScreen> {
  List<String> stack = [];
  String? config = "";
  String appId = "ad46fa9e-8e7a-4efb-83c7-47019d327698";

  [@override](/user/override)
  void initState() {
    super.initState();
    remoteConfig();
  }

  void remoteConfig() {
    FlutterRustoreRemoteconfig.create(appId, widget.behavior, 15, Parameters(),
        onBackgroundJobErrors: (value) {
      final item = "onError: $value";
      setState(() {
        stack.add(item);
      });
    }, onFirstLoadComplete: (value) {
      debugPrint("First load complete");
      setState(() {
        stack.add("first load");
      });
    }, onMemoryCacheUpdated: (value) {
      debugPrint("memory cache updated");
      setState(() {
        stack.add("memory cache updated");
      });
    }, onInitComplete: (value) {
      debugPrint("init complete");
      setState(() {
        stack.add("init complete");
      });
    }, onPersistentStorageUpdated: (value) {
      debugPrint("onPersistentStorageUpdated");
      setState(() {
        stack.add("onPersistentStorageUpdated");
      });
    }, onRemoteConfigNetworkRequestFailure: (value) {
      final item = "request failure: $value";
      setState(() {
        stack.add(item);
      });
    });
  }

  void getRemoteConfig() {
    FlutterRustoreRemoteconfig.init();
    FlutterRustoreRemoteconfig.getRemoteConfig().then(((value) {
      setState(() {
        config = value.getString("SDK_auff_sample");
      });
    }), onError: (err) {
      debugPrint("err: $err");
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Receive config screen'),
        ),
        body: Center(
          child: Column(
            children: [
              Text("Update Behavior: ${widget.behavior}"),
              TextField(
                decoration: const InputDecoration(
                  border: OutlineInputBorder(),
                  hintText: '请输入account',
                ),
                onChanged: (text) {
                  FlutterRustoreRemoteconfig.setAccount(text);
                  debugPrint("输入的值: $text");
                },
              ),
              TextField(
                decoration: const InputDecoration(
                  border: OutlineInputBorder(),
                  hintText: '请输入language',
                ),
                onChanged: (text) {
                  FlutterRustoreRemoteconfig.setLanguage(text);
                  debugPrint("输入的语言: $text");
                },
              ),
              OutlinedButton(
                onPressed: () {
                  FlutterRustoreRemoteconfig.init();
                },
                child: const Text('init()'),
              ),
              OutlinedButton(
                onPressed: () {
                  getRemoteConfig();
                },
                child: const Text('getRemoteConfig()'),
              ),
              Text("收到的配置: $config"),
              const SizedBox(height: 8),
              for (final item in stack) ...[
                Text(item),
                const SizedBox(height: 4),
              ],
            ],
          ),
        ),
      ),
    );
  }
}