インストールと初期化
このガイドでは、NetFUNNEL Flutterエージェントのインストールと初期化プロセスを説明します。
ステップ1: パッケージのインストール
依存関係の追加
NetFUNNEL Flutterエージェントはtar.gzパッケージファイルとして提供されます。公開リポジトリ（pub.dev）を使用せず、提供されたアーカイブファイルをプロジェクトに直接追加してインストールする必要があります。
tar.gzファイルをプロジェクトルートまたは希望の場所にコピーした後、pubspec.yamlに依存関係を追加します：
dependencies:
netfunnel_flutter:
path: ./netfunnel_flutter-{{latest}} # tar.gzファイルをコピーしたパス
インデントに注意
pubspec.yamlファイルはインデントに基づいて階層構造を認識するため、インデントに注意が必要です。
パッケージのインストール
プロジェクトルートパスから次のコマンドを実行します：
flutter pub get
ステップ2: ネットワーク権限の設定
Android
Androidの場合、NetFUNNELサーバーと通信するためにインターネット使用権限を追加する必要があります。
android/app/src/main/AndroidManifest.xmlファイルに次の権限を追加します：
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
<!-- インターネット権限設定 -->
<uses-permission android:name="android.permission.INTERNET" />
</manifest>
iOS
iOSはデフォルトでインターネット権限が有効になっています。追加設定は不要です。
ステップ3: Client IDの取得
- NetFUNNELコンソールに移動
- 右上のプロフィールアイコンをクリック
統合資格情報（Integration Credentials）メニューを選択Client IDをコピー
Client IDの確認場所
コンソール画面右上のプロフィールアイコンをクリックした後、統合資格情報メニューで確認できます。
ステップ4: エージェントの初期化
NetFUNNEL Flutterエージェントは、アプリ起動と同時に初期化する必要があります。
main.dartのmain()関数の開始時点で初期化作業を実行します：
import 'package:netfunnel_flutter/netfunnel_flutter.dart';
void main() async {
// NetFUNNELエージェント初期化
await Netfunnel.instance.initialize(
clientId: '{{CLIENT_ID}}', // ステップ3で取得したClient ID
serverUrl: '{{SERVER_URL}}', // オプション
errorUrl: '{{ERROR_URL}}', // オプション
networkTimeout: 3000,
retryCount: 0,
printLog: false,
errorBypass: false,
useNetfunnelTemplate: true,
userId: '{{USER_ID}}', // オプション
useNetworkRecoveryMode: true,
profile: 'prod_tokyo',
);
runApp(MyApp());
}
初期化パラメータ
| パラメータ | タイプ | 説明 | 条件 |
|---|---|---|---|
clientId | String | ユーザー固有識別子 | 空文字列不可 |
serverUrl | String | NetFUNNELサーバーアドレス | なし（デフォルトアドレスを使用） |
errorUrl | String | NetFUNNELエラーページのHTMLアドレス | なし（デフォルトアドレスを使用） |
networkTimeout | int | ネットワーク応答を待つ最大時間 | デフォルト（ms）: 3,000 最大（ms）: 10,000 最小（ms）: 100 |
retryCount | int | ネットワークリクエスト失敗時の再試行回数 | デフォルト（回）: 0 最大（回）: 10 最小（回）: 0 |
printLog | bool | デバッグ用のログ出力有無 | デフォルト: false |
errorBypass | bool | エラー発生時のバイパス有無 | デフォルト: false |
useNetfunnelTemplate | bool | コンソールでカスタマイズしたNetFUNNEL待機室の使用有無 | デフォルト: true |
userId | String | ブラックリスト、ホワイトリスト確認用のエンドユーザーの固有識別子 | デフォルト: null |
useNetworkRecoveryMode | bool | ネットワーク接続切断時に待機室を維持し、再接続を試みる機能の使用有無 | デフォルト: false |
profile | String | ユーザー環境設定（prod_tokyo, prod_us_east） | デフォルト: prod_tokyo |
初期化設定の詳細情報
すべての初期化パラメータの詳細情報については、初期化設定ドキュメントを参照してください。
ステップ5: インストール確認
エージェントが正しくインストールされているか確認するには、次を確認してください：
- 初期化成功: アプリ起動時にエラーが発生しないこと
- ログ確認:
printLog: trueに設定した場合、Flutterコンソールで[NF4]プレフィックスを持つログを確認できます
トラブルシューティング
パッケージインストール失敗:
- ネットワーク接続を確認
pubspec.yamlの依存関係パスを確認- tar.gzファイルが正しい場所にあるか確認
初期化失敗:
clientIdが正しく設定されているか確認- 空文字列でないか確認