プログラマーのメモ書き

伊勢在住のプログラマーが気になることを気ままにメモったブログです

flutter アプリを iPhone でデバッグ動作させた際に、ローカルネットワーク接続の確認ダイアログが表示された

こちらの記事に書いたように、 Mac 上の Flutter の開発環境を更新して、ビルドできるようにしました。で、実機をつないでデバッグビルドを動かすと、

という確認ダイアログが表示されました。

あれれ?以前はこんなの表示されていなかったと思うんだけどな?ということで、簡単に調べてみたので、まとめておきます。

なお、環境としては、

  • XCode 15.4
  • Mac mini (2018), MacOS Soxxxx 15.4
  • iPhone SE v2, iOS 16.7.2 (当初は iOS 15)

になります。後述する、エラー対応後のテスト時は、 iOS のアップデートがあったため、

  • iOS 17.5.1

になってます。

ダイアログの内容

改めてダイアログの内容を確認してみます。文章を読んでみると、

デバッグ時のみ Flutter アプリがローカルネットワーク上のデバイスの検索等を行うのでその許可を求める

という内容のようです。英文の最後に、リリースビルドではこのダイアログは表示されない、という旨の注記もあるように、どうも開発時のみに表示されるようです。 iOS 14 で導入された確認ダイアログになるそうです。

App がローカルネットワーク上のデバイスへの接続を求めてくる場合 - Apple サポート (日本)

ネットをググると、いくつか開発系の記事でこのダイアログが表示されることを述べています。

これって、 Flutter のバージョンに寄るのかな?と思い調べてみると、 Flutter 1.22 で iOS 14 対応があり、この時からデバッグ時にこの権限確認ダイアログが表示されるようになったっぽいです。

でも、 Flutter 1.22 より新しいバージョンで何度もデバッグビルドしてたはずなんだけど、なんでいまさら権限の確認ダイアログが表示されたんだろうか?それとも、以前も表示されていたけど、特に気にせずに許可してしまっていたんだろうか?

そのあたりは謎ですが、まあ、そういう権限の確認が求められたという話です。

デバッグビルド実行時のエラー

さて、権限の確認ダイアログについては上記の通りなんですが、 XCode でビルドして実機でデバッグビルドを動かした際に、ダイアログで『許可』を選択後も、ログに以下のエラーが表示されていました。

[ERROR:flutter/shell/platform/darwin/ios/framework/Source/FlutterDartVMServicePublisher.mm(126)] On iOS 14+, local network broadcast in apps need to be declared in the app's Info.plist. Debug and profile Flutter apps and modules host VM services on the local network to support debugging features such as hot reload and DevTools. To make your Flutter app or module attachable and debuggable, add a 'dartVmService.tcp' value to the 'NSBonjourServices' key in your Info.plist for the Debug/Profile configurations. For more information, see https://flutter.dev/docs/development/add-to-app/ios/project-setup#local-network-privacy-permissions

ああ、どうもローカルネットワークのデバイスとの通信を行うなら、 Info.plist にその旨宣言しておけ、ということのようです。

にしても、 iOS 14 対応で、権限の確認ダイアログ出すようにしたんだったら、 Flutter プロジェクト作成時にデフォルトでこの宣言も含めておいてほしいですね。昔作ったやつなので、抜けてるんだろうか?新しい Flutter SDK でプロジェクトを作ったら含まれているのかな?ちょっとそこまで検証してないのでわからないです。

あと、このエラーが出力されたままでも実機で動作できてるし、このままにしとこうかな?とも思ったのですが、やっぱり、エラーは潰しておくことにします。

ということで、エラーメッセージに出ている下記の参考 URL に従って、作業しておきます。

Integrate Flutter | Flutter

なお、公式の説明だけだと今一つわかりにくいところもあったので、下記の記事なども参考にしました。

[HowTo] enable Local Network Privacy Permissions on iOS14+ - DEV Community

新しい Info.plist の作成

参考 URL では、新規に Info.plist ファイルを作成するときの手順が載ってます。でも、すでに Info.plist があるので、ここは、ファイルのコピーを使って、複製してしまいます。

XCode のプロジェクトナビゲーターで Info.plist を選択した状態にして

メニューの File -> Duplicate を選択します。

ファイル名を聞かれるので、 Info-Debug.plist として、

『Save』ボタンを押します。これで、ファイルが追加されました。

次に、元のファイルのファイル名を Info-Release.plist に変更します。プロジェクトナビゲーターで既存の Info.plist を選択して、画面右端の Identity and Type の Name に新しい名前(今回は Info-Release.plist )を入力します。

設定が完了すると、下記のように、2つの Info.plist ファイルが作成された状態になります。

Info-Debug.plist の変更

次に、作成した Info-Debug.plist の内容を編集します。プロジェクトナビゲーターで Info-Debug.plist を選択して、中央のエディタ部分で、 Information Property List にカーソルを合わせると、+ボタンが表示されるので、クリックします。

ドロップダウンリストが表示されるので、『Bonjour Services』を選択します。次に、配列の値として『dartVmService.tcp』を入力します。

これで、 OK です。

Build Settings を変更

デバッグ・リリースなどの各ビルドでどの Info.plist を利用するかの設定を変更します。

プロジェクトナビゲーターから、プロジェクトを選択し、 TARGETS で Runner を選択し、 Build Settings タブを選択し、 Packaging を開きます。

ここで、参考 URL では、Info.plist File を選択して、値として Info-$(CONFIGURATION).plist と入力するようになっています。これで設定すると、

のように、それぞれの Configuration に対応した Info.plist が自動的に設定されます。

でも、今回は Info-Profile.plist を作っていませんし、作る気も今のところありません。なので、この方法ではなく、各 Configuration ごとにファイル名を個別に指定することにします。

なお、 Profile に対しても、 ローカルネットワークの宣言が必要になるので、 Info-Debug.plist を指定しておきます。

(参考)XCode のビルドの指定方法について

今回ビルド周りの設定を見ていて、単純に、デバッグとリリースの2種類があるというわけではないということがわかりました。

これらの記事にあるように、 Target, Scheme, Configuration の3つの設定により定義されるということのようです。

Target というのはいわゆるビルドフレーバーというのに該当するっぽくて、作成するアプリの内容そのものを切り替えるためのものですね。Configuration というのが、いわゆるビルド設定に該当するもののようで、ビルドオプションや環境変数などの各種設定値を切り替えるための設定になるようです。

で、 Scheme が、 Target と Configuration をまとめたものになり、XCode のメニューからコマンドを実行した際に、選択している Scheme の内容に応じて実行されるというもののようです。なので、実際、 Scheme の編集画面をみてみると、

のように、メニューのコマンドに対応した設定内容になっています。

現在の Flutter プロジェクトの場合、

  • Schemeとして Runner というものが1つだけ定義
  • Target として Runner というものが1つだけ定義
  • Configuration として Debug / Profile / Release というものが3つ定義

されています。

なお、今後、環境設定を色々と触るなら、下記の記事なども参考になりそうです。

XcodeでDevelop/Staging/Release環境を上手に切り分ける方法 #Xcode - Qiita

(参考2)ビルドの種類について

上記でも触れていますが、 Configuration として、 Profile というのがあるということに改めて気がつきました。これなんだろうか?と思って調べてみると、下記の記事にわかりやすくまとめてくれていました。

【Flutter】アプリの動かし方とビルドモード(Debug / Profile / Release)について | ヒヨコ プログラミング(ヒヨプロ)

なるほど、リリースと同様にビルドするけど、デバッグも一部有効になっているモードというわけね。パフォーマンスが重要になるアプリでデバッグしたい時に使う感じなんでしょうね。

一つ勉強になりました。

Build Phases を修正

参考 URL では、Info-Release.plist が追加されている場合がある、となっていたのですが、手元の環境の場合は、デバッグの方が追加されていました。これって、削除した方がいいのか?と思って修正前のものを確認すると、

のように、 Info.plist は含まれていませんでした。それに、

Xcodeエラー覚書 The Copy Bundle Resources build phase contains this target's Info.plist file: Cocoa日曜プログラム日誌 ここぶろ

のような記事があったので、削除しておいた方が無難かな?と考えて、 Info-Release.plist の指示と同様に削除しておきました。

ビルド&実機デバッグ

さて、ここまでできたら、一応設定は完了のはずです。なので、一度 Xcode でビルドして、実機で動かしてみます。すると、今回は最初に出ていたエラーが出なくなりました。

これで、一応解決したようです。

まとめ

Mac と Xcode による開発環境に慣れていないため、ちょっとエラーが出てくると、色々と調べないといけないため、なかなか手間取りますね。

ま、エラーがなくなったので、よしとしましょう。