パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v2.0.2

flutter_config

FlutterのDartコードおよびiOSおよびAndroidのネイティブコードに環境変数を公開するプラグイン。Flutterアプリに12ファクター愛をもたらします

AndroidiOS
30日間ダウンロード
2690
いいね数
211
Pub ポイント
140

パッケージをインストール

flutter pub add flutter_config

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

flutter_config は、Android および iOS の Dart およびネイティブコードで環境変数にスムーズにアクセスできるようにする Flutter プラグインです。開発、ステージング、本番など、さまざまな環境でのセキュリティと柔軟性を向上させるために、構成を外部で管理できるようにすることで、Flutter に 12 要素アプリの原則をもたらします。このパッケージは、プラットフォーム固有のファイル(iOS では info.plist、Android では build.gradle)から構成を読み取り、Dart で定数として公開します。これにより、機密値をハードコードするのを避け、デプロイワークフローを簡素化できます。

用途

  • 環境ごとの API エンドポイントの管理
  • APIキーを安全に保存する
  • 開発/ステージング/プロダクションの構成間を切り替える
  • 環境に応じたアプリ動作のカスタマイズ
  • 構成を介して機能フラグを有効化する
  • ネイティブコードとの構成の共有

主な機能

  • Android および iOS プラットフォームをサポートしています
  • ネイティブプロジェクトファイルから設定を読み込む
  • Dart およびネイティブコードに変数を公開する
  • 12ファクター・アプリ手法に従う
  • pub add を通じた簡単な統合
  • 実行時オーバーヘッドなし

適している対象

  • 複数の環境を使用する開発者
  • セキュアな構成管理を必要とするチーム
  • 構成にネイティブコードアクセスが必要なアプリ
  • 12ファクターの原則に従うプロジェクト
  • 環境固有の設定を持つ CI/CD パイプライン
  • 動的機能トグルを持つアプリ

注意事項

  • アプリの起動前に設定を指定する必要があります
  • 機密データはバージョン管理にコミットしてはならない
  • ネイティブプロジェクトでは手動でのセットアップが必要です
  • 実行時設定の変更には適していません
  • ビルド時における静的値に限定
  • チームオンボーディング用の適切なドキュメントが必要です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Config Variables for your Flutter apps

Plugin that exposes environment variables to your Dart code in Flutter as well as to your native code in iOS and Android.

Inspired by react-native-config

Basic Usage

Create a new file .env in the root of your Flutter app:

API_URL=https://myapi.com
FABRIC_ID=abcdefgh

load all environment varibles in main.dart

import 'package:flutter_config/flutter_config.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized(); // Required by FlutterConfig
  await FlutterConfig.loadEnvVariables();

  runApp(MyApp());
}

Now you can access your environment varibles anywhere in your app.

import 'package:flutter_config/flutter_config.dart';

FlutterConfig.get('FABRIC_ID') // returns 'abcdefgh'

Keep in mind this module doesn't obfuscate or encrypt secrets for packaging, so do not store sensitive keys in .env. It's basically impossible to prevent users from reverse engineering mobile app secrets, so design your app (and APIs) with that in mind.


Load Environment Varibles in Swift

First import the plugin

import flutter_config

Then you can use the .env Variable, replace ENV_API_KEY with yours.

flutter_config.FlutterConfigPlugin.env(for: "ENV_API_KEY")

Getting Started

Install the latest version of the plugin

Refer to Android Setup Guide for initial setup and advanced options

No additional setup is required for iOS, however, for advanced usage refer to the iOS Setup Guide

Testing

Whenever you need to use FlutterConfig in your tests, simply use the method loadValueForTesting

import 'package:flutter_config/flutter_config.dart';

void main() {
  FlutterConfig.loadValueForTesting({'BASE_URL': 'https://www.mockurl.com'});
  
  test('mock http client test', () {
    final client = HttpClient(
      baseUrl: FlutterConfig.get('BASE_URL')
    );
  });
}

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト