プロジェクトへの C / C++ コードの追加

C / C++ コードを Android プロジェクトに追加するには、プロジェクトモジュールの cpp ディレクトリにコードを配置します。プロジェクトをビルドすると、このコードがネイティブライブラリにコンパイルされ、Gradle で APK にパッケージ化できるようになります。Java または Kotlin コードでは JNI（Java Native Interface）を介してネイティブライブラリの関数を呼び出すことができます。JNI フレームワークの使用方法について詳しくは、Android での JNI に関するヒントをご覧ください。

Android Studio は、クロスプラットフォームプロジェクトに適した CMake と、ndk-build をサポートしています。ndk-build は CMake より高速ですが、サポート対象は Android のみです。現時点では、CMake と ndk-build の両方を同じモジュール内で使用することはできません。

既存の ndk-build ライブラリを Android Studio プロジェクトにインポートする場合は、Gradle をネイティブライブラリプロジェクトにリンクさせる方法をご覧ください。

このページでは、必要なビルドツールを搭載した Android Studio のセットアップ方法、C / C++ のサポートを使用して新しいプロジェクトを作成する方法、プロジェクトに新しい C / C++ ファイルを追加する方法を説明します。

既存のプロジェクトにネイティブコードを追加する場合は、次の手順を行う必要があります。

新しいネイティブソースファイルを作成して、Android Studio プロジェクトに追加します。
- すでにネイティブコードがある場合や、ビルド済みネイティブライブラリをインポートする場合は、この手順をスキップしてください。
ネイティブソースコードをライブラリにビルドするように CMake を設定します。このビルドスクリプトは、ビルド済みライブラリやプラットフォームライブラリに対してインポートやリンクを行う際にも必要になります。
- CMakeLists.txt ビルドスクリプトが存在する既存のネイティブライブラリを使用する場合や、ndk-build を使用して Android.mk ビルドスクリプトを組み込む場合は、この手順をスキップしてください。
CMake または ndk-build スクリプトファイルへのパスを指定して、Gradle を設定します。Gradle はこのビルドスクリプトを使用してソースコードを Android Studio プロジェクトにインポートし、ネイティブライブラリ（SO ファイル）を APK にパッケージ化します。

プロジェクトを設定すると、JNI フレームワークを使用して Java または Kotlin コードからネイティブ関数にアクセスできるようになります。実行アイコンをクリックするだけで、アプリをビルドして実行できます。

注: サポートが終了した ndkCompile ツールを既存のプロジェクトで使用している場合は、CMake または ndk-build を使用するように移行する必要があります。詳しくは、ndkCompile から移行する方法をご覧ください。

試験運用版の Gradle ユーザーの皆様へ: ネイティブプロジェクトですでに CMake または ndk-build を使用している、Gradle ビルドシステムの安定版を使用したい、アドオンツール（CCache など）のサポートを必要としている、のいずれかに当てはまる場合は、プラグインバージョン 2.2.0 以降に移行し、CMake または ndk-build を使用してネイティブライブラリをビルドすることをご検討ください。こうした条件に当てはまらない場合は、引き続き試験運用版の Gradle と Android プラグインを使用できます。

NDK とビルドツールのダウンロード

アプリ用のネイティブコードをコンパイル、デバッグするには、次のコンポーネントが必要です。

Android NDK（Native Development Kit）: Android で C / C++ コードを使用するためのツールセット。NDK のプラットフォームライブラリを使用することで、ネイティブアクティビティを管理し、センサーやタップ入力などの実機のコンポーネントにアクセスできるようになります。
CMake: Gradle と連携してネイティブライブラリをビルドする外部ビルドツール。ndk-build のみを使用する予定の場合は、このコンポーネントは不要です。
LLDB: Android Studio でネイティブコードをデバッグする際に使用するデバッガ。

こうしたコンポーネントのインストールについては、NDK、CMake、LLDB のインストールと設定をご覧ください。

CMake 3.6.0 または 3.10.2 を使用する

SDK Manager には、CMake の 3.6.0 フォークバージョンとバージョン 3.10.2 が含まれています。build.gradle で特定のバージョンの CMake を設定していないプロジェクトは、CMake 3.10.2 を使用してビルドされます。以前のバージョンを使用するには、モジュールの build.gradle ファイルで CMake バージョン 3.6.0 を指定します。

    android {
        ...
        externalNativeBuild {
            cmake {
                ...
                version "3.6.0"
            }
        }
    }

おすすめの方法ではありませんが、3.10.2+ のように build.gradle のエントリの末尾に + を付加することで、CMake のバージョンを最小バージョンとして指定できます。

カスタムの CMake バージョンを使用する

SDK Manager に含まれていない CMake バージョン 3.7 以降を使用する場合の手順は次のとおりです。

CMake の公式ウェブサイトから CMake 3.7 以降をダウンロードしてインストールします。

Gradle で使用する CMake バージョンをモジュールの build.gradle ファイルで指定します。

    android {
        ...
        externalNativeBuild {
            cmake {
                ...
                version "cmake-version"
            }
        }
    }

CMake のインストールパスを PATH 環境変数に追加するか、以下に示すようにプロジェクトの local.properties ファイルに含めます。build.gradle ファイルで指定した CMake のバージョンを Gradle が見つけられない場合は、ビルドエラーになります。
```
    # If you set this property, Gradle no longer uses PATH to find CMake.
    cmake.dir="path-to-cmake"
    
```
Ninja ビルドシステムをワークステーションにまだインストールしていない場合は、Ninja の公式ウェブサイトにアクセスして、ご利用の OS に対応している最新版の Ninja をダウンロードしてインストールしてください。また、Ninja のインストールパスを PATH 環境変数に追加してください。

C / C++ のサポートを使用した新しいプロジェクトの作成

ネイティブコードのサポートを使用した新しいプロジェクトの作成は、他の Android Studio プロジェクトの作成に似ていますが、次の追加の手順を行う必要があります。

ウィザードの [Choose your project] で、プロジェクトタイプとして [Native C++] を選択します。
[Next] をクリックします。
ウィザードの次のセクションで、他のすべてのフィールドに入力します。
[Next] をクリックします。
ウィザードの [Customize C++ Support] の [C++ Standard] でプロジェクトをカスタマイズできます。プルダウンリストでは、使用する C++ の標準化を選択します。[Toolchain Default] を選択すると、CMake のデフォルト設定が使用されます。
[Finish] をクリックします。

Android Studio で新しいプロジェクトの作成が完了したら、IDE の左側の [Project] ペインを開き、[Android] ビューを選択します。図 2 に示すように、Android Studio に cpp グループが追加されます。

図 2. Android ビューのネイティブソースのグループと外部ビルドスクリプトのグループ

注: このビューではディスク上の実際のファイル階層は反映されておらず、プロジェクト内を移動しやすいように類似のファイルがグループ化されています。

cpp グループには、プロジェクトに含まれているすべてのネイティブソースファイル、ヘッダー、CMake または ndk-build のビルドスクリプト、ビルド済みのライブラリがあります。新しいプロジェクトでは、Android Studio によってサンプルの C++ ソースファイルである native-lib.cpp が作成され、アプリモジュールの src/main/cpp/ ディレクトリに配置されます。このサンプルコードには、「Hello from C++」という文字列を返す簡単な C++ 関数 stringFromJNI() が記述されています。プロジェクトにソースファイルを追加する方法については、新しいネイティブソースファイルの作成方法についてのセクションをご覧ください。

build.gradle ファイルで Gradle にアプリのビルド方法を指示するのと同様に、CMake と ndk-build はビルドスクリプトでネイティブライブラリのビルド方法を確認する必要があります。新しいプロジェクトでは、Android Studio によって CMake ビルドスクリプトである CMakeLists.txt が作成され、モジュールのルートディレクトリに配置されます。このビルドスクリプトの内容について詳しくは、CMake の設定をご覧ください。

サンプルアプリをビルドして実行する

実行アイコンをクリックすると、Android デバイスまたはエミュレータにテキスト「Hello from C++」を表示するアプリが Android Studio によってビルドされ、起動されます。ここでは、サンプルアプリをビルドして実行する際に発生するイベントの概要を説明します。

Gradle が外部ビルドスクリプトの CMakeLists.txt を呼び出します。
CMake がビルドスクリプトのコマンドに従って C++ ソースファイルの native-lib.cpp をコンパイルして共有オブジェクトライブラリを生成し、libnative-lib.so という名前を付けます。次に、Gradle がこのライブラリを APK にパッケージ化します。
実行時にアプリの MainActivity が System.loadLibrary() を使用してネイティブライブラリを読み込みます。これで、ライブラリのネイティブ関数である stringFromJNI() をアプリで使用できるようになりました。
MainActivity.onCreate() が stringFromJNI() を呼び出し、返された「Hello from C++」で TextView を更新します。

注: Instant Run は、ネイティブコードで記述されたプロジェクトのコンポーネントと互換性がありません。

Gradle がネイティブライブラリを APK にパッケージ化したことを確認するには、APK Analyzer を使用します。

[Build] > [Build Bundles(s) / APK(s)] > [Build APK(s)] を選択します。
[Build] > [Analyze APK] を選択します。
app/build/outputs/apk/ ディレクトリで APK を選択し、[OK] をクリックします。
図 3 に示すように、APK Analyzer ウィンドウの lib/<ABI>/ の下に libnative-lib.so が表示されます。
図 3. APK Analyzer を使用してネイティブライブラリを特定します。

ヒント: ネイティブコードを使用する他の Android アプリで試す場合は、[File] > [New] > [Import Sample] をクリックし、[Ndk] リストからサンプルプロジェクトを選択します。

新しい C / C++ ソースファイルの作成

既存のプロジェクトに新しい C / C++ ソースファイルを追加する手順は次のとおりです。

アプリのメインソースセットに cpp/ ディレクトリをまだ作成していない場合は、次の手順で作成します。

IDE の左側にある [Project] ペインを開き、プルダウンメニューの [Project] ビューを選択します。
your-module > src に移動し、main ディレクトリを右クリックして [New] > [Directory] を選択します。
ディレクトリ名として「cpp」と入力し、[OK] をクリックします。

cpp/ ディレクトリを右クリックし、[New] > [C/C++ Source File] を選択します。

ソースファイルの名前（native-lib など）を入力します。

[Type] プルダウンメニューで、ソースファイルのファイル拡張子（.cpp など）を選択します。
- その他のファイル形式（.cxx や .hxx など）をプルダウンメニューに追加することもできます。その場合、「ファイル形式を編集」アイコンをクリックします。ポップアップ表示された [C/C++] ダイアログボックスの [Source Extension] プルダウンメニューと [Header Extension] プルダウンメニューで別のファイル拡張子を選択し、[OK] をクリックします。

ヘッダーファイルを作成する場合は、[Create an associated header] チェックボックスをオンにします。

[OK] をクリックします。

新しい C / C++ ファイルをプロジェクトに追加した後、CMake の設定でそれらのファイルをネイティブライブラリに含める必要があります。

参考情報

アプリでの C / C++ コードのサポートについて詳しくは、以下のリソースをご覧ください。

コードラボ

Android Studio での Hello-CMake の作成コードラボでは、Android Studio の CMake テンプレートを使用して Android NDK プロジェクトの開発を始める方法が紹介されています。