搜索插件、代码仓与 APP 分类

插件详情v1.2.0

azure_app_config

一个用于与 Microsoft Azure 应用配置通信的 Dart 包。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
4940
喜欢数
19
Pub 分数
160

安装插件

flutter pub add azure_app_config

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个 Dart 包,可实现与 Microsoft Azure 应用配置的无缝集成,使应用程序能够动态地从 Azure 检索和管理配置设置。它支持跨多个环境的安全实时访问键值对,非常适合在云原生环境中管理应用程序配置。该包与所有主要平台兼容,包括 Android、iOS、Web、macOS、Windows 和 Linux,适用于需要集中式配置管理的跨平台应用。

适合场景

  • 动态配置管理
  • 环境特定的设置
  • 云原生应用部署
  • 实时配置更新
  • 集中式应用设置存储

主要特点

  • 与 Azure 应用配置的受保护连接
  • 对多平台的支持
  • 实时配置同步
  • 环境感知的配置获取
  • 轻松集成到Flutter应用

适合对象

  • 使用 Azure 的 Flutter 应用
  • 需要配置管理的后端服务
  • 跨平台应用程序
  • 使用 Azure 进行基础设施的团队
  • 需要动态配置更新的开发者

使用建议

  • 需要 Azure 应用配置实例
  • 需要进行身份验证设置(例如,SAS令牌或托管标识)
  • 仅限 Azure 托管配置
  • 需要网络连接
  • 可能需要缓存以供离线使用

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

style: very good analysis

Azure App Configuration

This package makes it easier to communicate with Microsoft Azure App Configuration KeyValue and FeatureFlag resources.

Installation

To use this plugin, add azure_app_config to your pubspec.yaml file.

Authentication

There are two methods of authenticating Azure App Configuration:

  1. (simple) Use the connection string which can be obtained from the App Configuration Dashboard under 'Access keys'. If the connection string is invalid or not specified, an ArgumentError will occur.

  2. (complex) Use the factory constructor AzureAppConfig.customAuthentication() which enables you to provide a custom way of signing requests.

Example

Example 1: Creating an instance of AzureAppConfig

import 'package:azure_app_config/azure_app_config.dart';

void main() {
  // Creating an instance needs a connection String. This can be
  // obtained through the Azure Portal, under "Access Keys".
  final service = AzureAppConfig(connectionString: '<CONNECTION_STRING>');

  // Use the service instance to interact with Azure App Configuration.
  // ...
}

Example 2: Retrieving a key value from Azure App Configuration

import 'package:azure_app_config/azure_app_config.dart';

void main() async {
  const exampleKey = 'example_key';
  const exampleLabel = 'example_label';

  final service = AzureAppConfig(connectionString: '<CONNECTION_STRING>');

  // Getting a key value.
  try {
    final keyValue = await service.getKeyValue(key: exampleKey, label: exampleLabel);
    // Use the keyValue instance to retrieve any property of the key value.
    // ...
  } catch (err) {
    // Handle any exceptions that might occur when interacting with the Azure
    // service.
  }
}

Example 3: Retrieving a feature flag from Azure App Configuration

import 'dart:developer' as developer;

import 'package:azure_app_config/azure_app_config.dart';

void main() async {
  const exampleKey = 'example_key';
  const exampleLabel = 'example_label';

  final service = AzureAppConfig(connectionString: '<CONNECTION_STRING>');
  
  final keyValue = await service.getKeyValue(key: exampleKey, label: exampleLabel);

  // If the KeyValue is a FeatureFlag, you can use .asFeatureFlag()
  // to get the properties of the FeatureFlag
  final featureFlag = keyValue.asFeatureFlag();

  // .asFeatureFlag() will return null if it's unable to parse.
  if (featureFlag != null) {
    // To check if the featureflag is enabled, use
    developer.log('${featureFlag.enabled}');
  }
} 

Example 4: Retrieving a feature flag with feature filters from Azure App Configuration

import 'dart:developer' as developer;

import 'package:azure_app_config/azure_app_config.dart';

void main() async {
  const exampleKey = 'example_key';
  const exampleLabel = 'example_label';

  final service = AzureAppConfig(connectionString: '<CONNECTION_STRING>');

  // Register a FeatureFilter before using it.
  service.registerFeatureFilter(
    FeatureFilter.targeting(
      user: 'test.user@company.com',
    ),
  );
  
  try {
    // getFeatureEnabled() will take the feature filters into account when evaluating. 
    final isFeatureEnabled = await service.getFeatureEnabled(key: exampleKey, label: exampleLabel);

    developer.log('$isFeatureEnabled');
  } catch (err) {
    // Handle any exceptions that might occur when interacting with the Azure
    // service.
  }
}

Example 5: Finding key values based on a key and label filter

import 'dart:developer' as developer;

import 'package:azure_app_config/azure_app_config.dart';

void main() async {
  final service = AzureAppConfig(connectionString: '<CONNECTION_STRING>');

  try {
    // Find key values based on a key and label filter.
    // This example searches for the keyValues that start with '.appconfig.'
    // without a label.
    final keyValues = await service.findKeyValuesBy(
      key: '.appconfig.*',
      label: AzureFilters.noLabel,
    );

    // Loop through the values.
    for (final keyValue in keyValues) {
      developer.log(keyValue.value);
      // Use the keyValue instance to retrieve any property of the key value.
      // ...
    }
  } on AzureFilterValidationException catch (e) {
    // When an invalid filter has been provided, for example, '.appconfig.**',
    // an [AzureFilterValidationException] is thrown.
    developer.log(e.errorResponse.detail ?? 'Error occurred!');
  } catch (err) {
    // Handle any exceptions that might occur when interacting with the Azure
    // service.
  }
}

Complex Types

You are able to register types with their associated encode and decode functions. After registering the types, the library will automatically use those functions to retrieve/set values in the database.

class TimeRange {
    String start;
    String end;
    TimeRange(this.start, this.end);
    factory TimeRange.fromJson(Map<String, dynamic>)
    Map<String, dynamic> toMap() => {'start': start, 'end': end}
}

...

// Register a type, so that the library knows how to encode and decode the model
service.registerType<TimeRange>(
  decode: (jsonData) => TimeRange.fromJson(jsonData),
  encode: (timeRange) => timeRange.toMap(),
);

// Uses the passed-in [encode] method to know the json structure to use.
await service.setTyped(
    TimeRange('Monday', 'Friday'),
    key: 'time_range',
    label: 'some_label',
);

// Uses the passed-in [decode] method to know how to serialize [TimeRange]
final timeRange = await service.getTyped<TimeRange>(
    key: 'time_range',
    label: 'some_label',
); 

FeatureFilters

This package currently has 2 built-in FeatureFilters based on the defaults which can be found in the App Configuration dashboard:

Microsoft.Targeting -> Enable a flag based on some Targeting parameters which can be found in the Azure dashboard.

Microsoft.TimeWindow -> Enable a feature flag during a specified window of time.

Make sure to register the FeatureFilter before retrieving a feature's value.
service.registerFeatureFilter(FeatureFilter.timeWindow()) or
service.registerFeatureFilter(FeatureFilter.targeting()).

Implement your own FeatureFilter

This package enables you to create custom FeatureFilters by extending the FeatureFilter class. An example of this can be found by looking at how the built-in FeatureFilters are implemented here.

More Information

For more information about Azure App Configuration, take a look at the following resources.

Feel free to submit any pull requests!

所属分类

依赖

依赖清单 6 项

源码仓库

使用此插件的项目

暂无相关数据。