Flutter远程配置管理插件simple_remote_config的使用

Flutter远程配置管理插件simple_remote_config的使用

插件介绍

simple_remote_config 是一个简单的的Flutter插件，用于帮助您在不更新应用的情况下通过网络JSON更改应用程序的行为和设置。

• 功能

  • 从网络JSON获取远程配置。
  • 缓存内存中的配置。
  • 提供通过键获取数据并返回默认值的功能，当数据不存在时。

• 开始使用 可以通过查看示例代码来开始使用：example/lib/example.dart

安装

1. Dart:

dart pub add simple_remote_config

1. Flutter:

flutter pub add simple_remote_config

第一步

Android

不要忘记在AndroidManifest.xml中添加网络权限。

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 ...
 <uses-permission android:name="android.permission.INTERNET" />
 ...
</manifest>

macOS

macOS应用程序必须允许网络访问相关的*.entitlements文件。

<key>com.apple.security.network.client</key>
<true/>

如何使用

初始化

创建您的SimpleRemoteConfig实例。

import 'package:simple_remote_config/simple_remote_config.dart';

final remoteConfig = SimpleRemoteConfig();

SimpleRemoteConfig有一个参数Client来自http包，您可以传递自定义的Client对象来创建SimpleRemoteConfig实例。

import 'package:simple_remote_config/simple_remote_config.dart';
import 'package:http/http.dart' as http;

final client = http.Client();

final remoteConfig = SimpleRemoteConfig(client: client);

获取远程配置数据

SimpleRemoteConfig提供了initilize函数，并且您需要传入一个URL来开始从网络获取远程配置数据。

注意：URL必须返回JSON格式。

import 'package:simple_remote_config/simple_remote_config.dart';

final remoteConfig = SimpleRemoteConfig();

const configUrl = "https://dungngminh.github.io/remote_config/test.json";

await remoteConfig.initilize(configUrl: configUrl);

从远程获取数据

SimpleRemoteConfig获取的数据是JSON格式，数据以键值对的形式返回，可以通过get函数通过键获取值。目前SimpleRemoteConfig支持String、int、double、bool、Map。

示例JSON格式:

{
    "key1": true, // boolean
    "key2": 10, // int
    "key3": "value from key 3", // string,
    "key4": {
        "key4_1": "value from key 4_1",
        "key4_2": 20
    }, // map
    "key5": 10.5 // double
}

获取数据:

final valueKey1 = remoteConfig.getBool('key1');
print(valueKey1); // true

final valueKey2 = remoteConfig.getInt('key2');
print(valueKey2); // 10

final valueKey3 = remoteConfig.getString('key3');
print(valueKey3); // value from key 3

final valueKey4 = remoteConfig.getMap('key4');
print(valueKey4); // {key4_1: value from key 4_1, key4_2: 20}

final valueKey5 = remoteConfig.getDouble('key5');
print(valueKey5); // 10.5

如果提供的key未找到或提供的T类型错误，get函数将返回null。

示例:

final valueKey7 = remoteConfig.getString('key7');
print(valueKey7); // null

可以传递defaultValue当get函数返回null时。

示例:

final valueKey7 = remoteConfig.getString('key7', defaultValue: 'this is default value');
print(valueKey7); // this is default value

获取所有远程数据

SimpleRemoteConfig提供了getAll函数来获取所有远程数据。

final allData = remoteConfig.getAll();
print(allData); /// {key1: true, key2: 10, key3: value from key 3, key4: {key4_1: value from key 4_1, key4_2: 20}, key5: 10.5}

快乐编码

这就是全部内容！想要新功能？发现了bug？请创建一个issue！

示例代码

import 'package:simple_remote_config/simple_remote_config.dart';
import 'package:version/version.dart';

Future<void> main() async {
  final remoteConfig = SimpleRemoteConfig();

  const configUrl = "https://dungngminh.github.io/remote_config/test.json";

  await remoteConfig.initilize(configUrl: configUrl);

  final maxQuota = remoteConfig.getInt("maxQuota");
  print("maxQuota: $maxQuota");

  final enableLog = remoteConfig.getBool("enableLog");

  if (enableLog ?? false) {
    print("Log is enabled");
  }

  final inAppVersion = Version.parse("1.0.0");

  final currentVersion = remoteConfig.getString("currentVersion");

  if (currentVersion != null && inAppVersion < Version.parse(currentVersion)) {
    print("Please update your app");
  } else {
    print("You are using the latest version");
  }
}