Android デベロッパー Codelab

世界で最も広くインストールされているオペレーティングシステムの開発を、デベロッパーの皆さんの手でサポートできます。ここから、Android プラットフォームのエンジニアになるための第一歩を踏み出すことができます。

その道のりは平坦ではありませんが、Android チームはリリースごとに道を整備して学習が容易になるように努めています。また、Android オープンソースプロジェクト（AOSP）での直接的な取り組みを通じて、日々改善を行っています。

それでは席に着いてターミナルを起動し、学習の旅に出発しましょう。

目標

このコードラボの目的は次の 2 つです。

プラットフォーム（オペレーティングシステム）の開発に取り組む Android エンジニアのデベロッパーワークフローとはどのようなものかを簡単に紹介する。
Android のツール、ドキュメント、デベロッパーワークフローに関するフィードバックを集める。

要件

この Codelab の要件のリストは、一般的なプラットフォーム（AOSP）開発向けの要件をベースとしています。この Codelab を受講するには、以下の設定が必要です。

すべての要件を満たした物理的な Linux ワークステーション
Android コードベースの編集に必要な Repo および Git の設定

環境

通常、ユーザーはワークステーション上で直接ビルドと開発を行います。さまざまなターミナルで作業する可能性があること、および使用するコマンドの多くはターミナル固有であることから、それぞれのターミナルセッションでそうしたコマンドの再実行が必要となります。具体的には、source build/envsetup.sh コマンドや lunch コマンドを使用します。

ワークステーションの設定

ワークステーションに必要なパッケージをインストールします。
引き続き、ターミナルで Repo をインストールし、すべての Git リポジトリにアクセスするための認証情報を取得します。

コードを初期化して同期する

ホームディレクトリに移動します。
```
cd ~
```
ローカルの作業用サブディレクトリを作成します。
```
mkdir aosp
```
そのディレクトリに移動します。
```
cd aosp
```
AOSP リポジトリのソースコードの master ブランチ（デフォルト）を初期化します。
```
repo init -u https://android.googlesource.com/platform/manifest
```
Git の認証情報（名前、メールアドレス）を入力するか、受け入れます。
ソースコードを同期します。
```
repo sync -j8
```

初回の同期には 1 時間以上かかることがあります。待っている間、関連する詳細情報についてダウンロード手順をご覧ください。

各 Repo チェックアウトは、それぞれ 1 つのマニフェストファイルで示されます。各 Repo チェックアウトをそれぞれ個別のディレクトリ内に配置している場合に限り、一度に複数の Repo チェックアウトを持つことができます。ただし、各チェックアウトとビルドの使用量は概算で 300 GB に達する（または超える）ことがあるため、Repo チェックアウトを 2 つまでに制限するか、システムにセカンダリドライブを増設してください。

ヒント: 空き容量を増やすには、ブランチディレクトリを削除して新たにディレクトリを作成します。例: rm -rf aosp2.

コードをビルドする

Android をビルドするには、lunch コマンドで、ビルドするターゲットデバイスのタイプを選択する必要があります。ターゲットとは、特定のモデルやフォームファクタなど、特定のバージョンのデバイスです。

下記で指定されているデバイスターゲット（aosp_cf_x86_64_phone-userdebug）の場合、実機なしでテストを行うための Cuttlefish 仮想 Android デバイスをビルドできます。

実機のビルドや更新を行う場合は、それに対応した別のターゲットを選択します。手順については、デバイスをフラッシュするをご覧ください。

Android デバイスのビルド環境をセットアップするには、ソースコードチェックアウトのルートから、以下のコマンドを実行します。
```
source build/envsetup.sh
```
ビルドターゲットを次のように lunch コマンドに指定します。
```
lunch aosp_cf_x86_64_phone-userdebug
```
チェックアウト内の任意の場所から、以下のコマンドを使用してコードをビルドします。
```
m
```

初回のビルドが完了するまでには時間がかかります。その後のビルドでは、所要時間は大幅に短縮されます。

Acloud インスタンスを作成する

Acloud は AOSP 内のコマンドラインツールで、ユーザーによる仮想 Android デバイス（この例では Cuttlefish）の作成を支援します。

コードのビルドと同じターミナルセッションの場合は、そのまま手順を進めてください。それ以外の場合は、まず、envsetup.sh スクリプトと、コードのビルドで使用したのと同じ lunch コマンドを再実行してください。次の手順

次のコマンドを実行して Acloud ローカルインスタンスを作成します。
```
acloud create --local-image --local-instance
```
必須パッケージの更新を受け入れます。
プロンプトが表示されたら、すべての変更内容を有効化するために、ワークステーションを再起動します。
Cuttlefish デバイスを選択します。

Android デバイスを含んだ VNC セッションの初期画面が表示されます。

ワークステーションでマウスやキーボードを使用して、仮想デバイスを操作できます。次のように、Android Debug Bridge（adb）の logcat コマンドを使用して、デバイスの使用中にログ内のアクティビティを追跡することもできます。

adb logcat

変更を加える

このサンプルの変更リストに沿って、ソースコードを更新します。

チェックアウトのルート（aosp/ ディレクトリ）から frameworks/native Git プロジェクトに移動します。
```
cd frameworks/native
```
次のコマンドを実行して、一時的なプロジェクトを開始します。
```
repo start <some-name> .
```
次の場所にある SurfaceFlinger.cpp を編集して、変更リストにある更新を含めます。
```
aosp/frameworks/native/services/surfaceflinger/SurfaceFlinger.cpp
```
次の 2 行を見つけます。
```
postFrame();
postComposition();
```

この 2 行を次のように置き換えます。

postFrame();
postComposition();
mClientColorMatrix = mat4(vec4{1.0f, 0.0f, 0.0f, 0.0f}, vec4{0.0f, -1.0f, 0.0f, 0.0f},
                          vec4{0.0f, 0.0f, -1.0f, 0.0f}, vec4{0.0f, 1.0f, 1.0f, 1.0f});
updateColorMatrixLocked();

コードをビルドします。
```
m
```

デバイス上のビルドを更新します。

adb root
adb remount
adb sync
adb reboot
acloud reconnect

デバイスの選択を求められたら、経過時間が最も短いデバイスを選択します（これはおそらくリストの最後に表示されているデバイスです）。すべての仮想デバイスのインスタンスを表示するには、acloud list コマンドまたは acloud list -v コマンドを使用します。

選択したデバイスの色が変化したことを確認します（図 1 のように表示されます）。

成功した場合の色の変化の例

図 1. 成功した場合の画面上の色の変化

コードをテストする

Codelab のこのパートでは、サンプルのテストを利用します。このテストはソースツリー内にあり、すでに失敗しています。このため、Atest を使用してテストをローカルで実行し、コードをテストします。

テストを使用するには、次の手順を行います。

次のコマンドを実行します。
```
atest DevCodelabTest
```
テストは失敗します。修正するには、失敗したテストのソースコードを見つけます。
```
atest --info android.test.example.devcodelab.DevCodelabTest#testHelloWorld
```

こちらをご覧ください

platform_testing/tests/example/devcodelab

編集するファイルを取得するには、android.test.example.devcodelab.DevCodelabTest でテストの名前を取得し、. を / に置き換えます。結果は次のようになります。
```
src/android/test/example/devcodelab/DevCodelabTest.java
```

次に、

platform_testing/tests/example/devcodelab/src/android/test/example/devcodelab/DevCodelabTest.java

を編集し、

Assert.assertTrue(false)

を

Assert.assertTrue(true)

で置き換えます。テストをもう一度実行して、修正されたことを確認します。
```
atest DevCodelabTest
```

審査用にコードをアップロードする

Repo は、git clone などのコマンドをバンドルして一度に数多くの Git リポジトリ（またはプロジェクト）にわたって処理を実行することにより、Git の使用を簡素化します。

Git と Repo の概要と、Android ソースコードの作業に関する詳細なドキュメントへのリンクについては、ソース管理ツールをご覧ください。Git プロジェクト、個別プロジェクト（パス）、各プロジェクトの関連ブランチについては、AOSP リポジトリをご覧ください。

Git でプロジェクトのコードレビューを行うには、ウェブベースのコードレビューシステム Gerrit を使用します。

たとえば、frameworks/native プロジェクト内で変更を加えた場合は、次のコマンドを実行して変更をアップロードします。
```
cd frameworks/native
repo start codelab .
git add .
git commit
```
Commit メッセージでは、次のように入力します。
```
Android codelab change
Test: manual atest
```
変更をアップロードします。
```
repo upload
```

アップロードが成功すると、次のようなメッセージが表示されます。

Upload project frameworks/native/ to remote branch master:
  branch codelab ( 1 commit, Wed Aug 7 09:32:33 2019 -0700):
         ff46b36d android codelab change
to https://android-review.googlesource.com/ (y/N)? y
remote: Processing changes: refs: 1, new: 1, done
remote:
remote: SUCCESS
remote:
remote:   https://android-review.googlesource.com/c/platform/frameworks/native/+/1098432 android codelab change [NEW]
remote:
To https://android-review.googlesource.com/platform/frameworks/native
 * [new branch]          codelab -> refs/for/master

Gerrit で変更を確認する

ターミナルに表示される次のようなリンク先に移動します。

https://android-review.googlesource.com/c/platform/frameworks/native/+/1098432

Android プラットフォーム開発向けの最初の Codelab はこれで完了です。次のステップについては、パッチの送信をご覧ください。Android 開発の詳細については、このサイトの他の部分をご覧ください。

変更を元に戻す

通常は、テストの後にレビューと承認を受けたら、Gerrit で変更を送信してリポジトリにマージします。

この Codelab は学習を目的としたものであるため、その代わりに Gerrit で [Abandon] をクリックして自分の変更リストを元に戻します。

次に、frameworks/native プロジェクトディレクトリ（またはそのサブディレクトリ）内にある、関連する一時的なブランチを破棄します。

repo abandon codelab .

テストファイルに対する変更も、忘れずに元に戻します。変更の repo start、git commit、repo upload は実行しなかったので、次のコマンドを実行してファイル自体をリセットできます。aosp/platform_testing directory を利用している場合は、次のコマンドを使用してファイルをリセットします。

git reset HEAD tests/example/devcodelab/src/android/test/example/devcodelab/DevCodelabTest.java
git checkout .

この時点で、ウィジェットでの設定は終わりです。お疲れさまでした。

サポートを受ける

この Codelab でエラーが発生した場合は、各ページの下部にある公開バグトラッカーリンクを使用して報告してください。サポートを受けるには、android-building グループに質問をお送りください。