反復型コード開発

モバイル デベロッパーは多くの場合、アプリの UI をすべて一度に開発するのではなく、段階的に開発します。Android Studio は Jetpack Compose でこのアプローチを採用しており、完全なビルドを必要としないツールを提供して、検査、値の変更、最終結果の検証を行うことができます。

ライブ編集

ライブ編集は、エミュレータと実機でコンポーザブルをリアルタイムに更新できる機能です。アプリの作成環境とビルド環境の切り替えが最小限に抑えられるため、コードの作成により長く集中できるようになります。

ライブ編集には次の 3 つのモードがあります。

  • 手動: Ctrl+\（macOS では Command+\）を使用して手動で push すると、コードの変更が適用されます。
  • 手動保存: Ctrl+S（macOS では Command+S）を使用して手動で保存する場合、コードの変更が適用されます。
  • 自動: コンポーザブル関数を更新すると、デバイスまたはエミュレータに変更が適用されます。

ライブ編集は、UI および UX 関連のコード変更に重点を置いています。メソッド シグネチャの更新、新しいメソッドの追加、クラス階層の変更などの変更はサポートしていません。詳しくは、ライブ編集の制限事項のリストをご覧ください。

この機能は、アプリの作成と実行や Apply Changes の代替ではなく、Compose UI の開発におけるビルド、デプロイ、反復のワークフローを最適化するためのものです。

ベスト プラクティスのワークフローは次のとおりです。

  1. アプリをセットアップして実行できるようにします。
  2. ライブ編集でサポートされない変更（アプリ実行中の新しいメソッドの追加など）を行う必要性が生じるまで、可能な限りの変更をライブ編集で行います。
  3. サポートされていない変更を行ったら、実行アイコン 実行アイコン をクリックしてアプリを再起動し、ライブ編集を再開します。

ライブ編集を使ってみる

まず、次の手順で空の Compose アクティビティを作成し、プロジェクトでライブ編集を有効にして、ライブ編集で変更を加えます。

新しいプロジェクトをセットアップする

  1. 始める前に、Android Studio Giraffe 以降がインストールされており、実機またはエミュレータの API レベルが 30 以上であることを確認してください。

  2. Android Studio を開き、[Welcome to Android Studio] ダイアログで [New Project] を選択します。すでにプロジェクトを開いている場合は、[File] > [New] > [New Project] に移動して新しいプロジェクトを作成できます。

  3. [Phone and Tablet] の [Empty Compose Activity] テンプレートを選択し、[Next] をクリックします。

    Android Studio でのテンプレートの選択
    図 1. テンプレートを選択できます。ライブ編集の場合は、[Empty Compose Activity] を選択します。

  4. [New Project] ダイアログで必要な情報をすべて入力します。具体的には、名前、パッケージ名、保存場所、最小 SDK、ビルド構成の言語です。

    Android Studio で入力されたステップ 4 のプロジェクト設定の例
    図 2. プロジェクト設定の例。

  5. [Finish] をクリックします。

ライブ編集を有効にする

  1. 設定に移動してライブ編集を有効にします。

    • Windows または Linux の場合、[File] > [Settings] > [Editor] > [Live Edit] に移動します。
    • macOS の場合、[Android Studio] > [Settings] > [Editor] > [Live Edit] に移動します。

  2. 設定で [Live Edit] オプションを選択し、実行するモードを選びます。

    手動モードでは、Ctrl+\（macOS では Command+\）を押すたびにコードの変更が push されます。手動保存モードでは、Ctrl+S（macOS では Command+S）を使用して手動で保存するたびに、コードの変更内容が適用されます。自動モードでは、変更を加えるとコードの変更がデバイスまたはエミュレータに適用されます。

    Android Studio 設定のライブ編集チェックボックス UI
    図 3. ライブ編集の設定。

  3. エディタで、アプリのエントリ ポイントである MainActivity ファイルを開きます。

  4. 実行アイコン UI ボタン をクリックしてアプリをデプロイします。

  5. ライブ編集を有効にすると、[Running Devices] ツール ウィンドウの右上に [Up-to-date]（最新）という緑色のチェックマークが表示されます。

    ライブ編集の緑色のチェックマークの UI

変更を加えて確認する

エディタでサポートされている変更を加えると、仮想テストデバイスまたは物理テストデバイスが自動的に更新されます。

たとえば、MainActivity の既存の Greeting メソッドを次のように編集します。

@Composable
fun Greeting(name: String) {
    Text(
        text = "Hello $name!",
        Modifier
            .padding(80.dp) // Outer padding; outside background
            .background(color = Color.Cyan) // Solid element background color
            .padding(16.dp) // Inner padding; inside background, around text)
    )
}
IterativeDevelopmentSnippets.kt

図 4 に示すように、変更はすぐにテストデバイスに表示されます。

デバイスで適用される Greeting メソッドの変更
図 4. ライブ編集による Greeting メソッドの変更を表示しているテストデバイス。

ライブ編集のトラブルシューティング

編集した内容がテストデバイスに表示されない場合、Android Studio が編集内容の更新に失敗した可能性があります。ライブ編集のインジケーターで、図 5 のようにコンパイル エラーを示す「Out Of Date」（要更新）が表示されているかどうかを確認します。エラーの詳細と解決方法の提案については、このインジケーターをクリックしてください。

ライブ編集の「Out Of Date」（要更新）アイコン
図 5. ライブ編集のステータス インジケーター。

ライブ編集の制限事項

現在の制限事項は次のとおりです。

  • [Android Studio Giraffe 以降にのみ適用] ライブ編集には Compose Runtime 1.3.0 以降が必要です。プロジェクトでそれより前のバージョンの Compose を使用している場合、ライブ編集は無効になります。

  • [Android Studio Giraffe 以降にのみ適用] ライブ編集には AGP 8.1 以降が必要です。プロジェクトでそれより前のバージョンの AGP を使用している場合、ライブ編集は無効になります。

  • ライブ編集には、API レベル 30 以降を搭載している実機またはエミュレータが必要です。

  • ライブ編集は関数本体の編集のみをサポートします。関数名やシグネチャの変更、関数の追加または削除、関数以外のフィールドの変更はできません。

  • ファイル内の Compose 関数を初めて変更したときに、ライブ編集によってアプリの状態がリセットされます。これは最初のコード変更後にのみ行われます。そのファイル内の Compose 関数にその後コードを変更しても、アプリの状態がリセットされることはありません。

  • ライブ編集で変更したクラスは、パフォーマンスが低下することがあります。パフォーマンスを評価する場合は、アプリを実行し、クリーンなリリースビルドを使用します。

  • ライブ編集で変更したクラスを操作するには、デバッガをフル実行する必要があります。

  • 実行中のアプリをライブ編集で編集すると、クラッシュする可能性があります。その場合は、実行ボタン UI ボタン でアプリを再デプロイできます。

  • ライブ編集では、プロジェクトのビルドファイルで定義されているバイトコード操作は行われません。たとえば、[Build] メニューのオプションを使用するか、[Build] ボタンまたは [Run] ボタンをクリックして、プロジェクトのビルド時に適用されるバイトコード操作です。

  • コンポーズ可能な関数以外の関数は、デバイスまたはエミュレータでリアルタイムで更新され、完全な再コンポーズがトリガーされます。完全な再コンポーズでは、更新された関数が呼び出されない場合があります。コンポーズ可能な関数以外の関数については、新しく更新された関数をトリガーするか、アプリを再度実行する必要があります。

  • アプリを再起動してもライブ編集は再開されません。アプリを再度実行する必要があります。

  • ライブ編集はデバッグ可能なプロセスにのみ対応しています。

  • ライブ編集はビルド構成で kotlinOptions の moduleName にカスタム値を使用しているプロジェクトはサポートしていません。

  • マルチデプロイの導入では、ライブ編集は機能しません。つまり、あるデバイスにデプロイ後、別のデバイスにデプロイすることはできません。ライブ編集は、アプリがデプロイされた最後のデバイスセットでのみアクティブになります。

  • ライブ編集は、マルチデバイス デプロイ（対象デバイスのプルダウンの [Select Multiple Devices] から作成された複数デバイスへのデプロイ）で機能します。ただし、公式にはサポートされていないため、問題が発生する可能性があります。問題が発生した場合は、ご報告ください。

  • Apply Changes/Apply Code Changes はライブ編集と互換性がないため、実行中のアプリを再起動する必要があります。

ライブ編集に関するよくある質問

  • ライブ編集の現在のステータスはどのようになっていますか？

    ライブ編集は Android Studio Giraffe で利用できます。オンにするには、[File] > [Settings] > [Editor] > [Live Edit]（macOS では [Android Studio] > [Settings] > [Editor] > [Live Edit]）に移動します。

  • ライブ編集を使用するタイミング

    UX 要素の更新（修飾子の更新やアニメーションなど）がアプリ エクスペリエンス全体に与える影響をすぐに確認したい場合は、ライブ編集を使用します。

  • ライブ編集を使用しないほうがよいのはどのような場合ですか？

    ライブ編集は、UI および UX 関連のコード変更に重点を置いています。メソッド シグネチャの更新、新しいメソッドの追加、クラス階層の変更などの変更はサポートされていません。詳しくは、ライブ編集の制限事項をご覧ください。

  • Compose プレビューを使用すべき状況

    個々のコンポーザブルを開発する場合は、Compose プレビューを使用します。プレビューは Compose 要素を可視化し、自動的に更新してコード変更の効果を表示します。プレビュー版では、ダークモード、ロケール、フォント スケールなど、さまざまな構成や状態で UI 要素を表示することもできます。

リテラルのライブ編集（非推奨）

Android Studio は、プレビュー、エミュレータ、物理デバイス内のコンポーザブルで使用されている一部の定数リテラルを、リアルタイムで更新できます。サポートされている型は次のとおりです。

  • Int
  • String
  • Color
  • Dp
  • Boolean

ユーザーによるソースコード内のリテラルの変更と、動的に更新されるプレビューの動画

リテラルのライブ編集 UI インジケーターでリテラル装飾を有効にすると、コンパイル手順なしでリアルタイムの更新をトリガーする定数リテラルを表示できます。

リテラルのライブ編集を有効にする

Apply Changes

Apply Changes を使用すると、エミュレータや実機にアプリを再デプロイすることなく、コードとリソースを更新できます（いくつかの制限があります）。

コンポーザブルを追加、変更、削除した場合、[Apply Code Changes] ボタンをクリックすることで、再デプロイすることなくアプリを更新できます。

ユーザーが [変更を適用] ボタンをクリック

前へ
アニメーションのプレビューとデバッグ
次へ
エディタのアクション