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

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

Android Studio は、クロスプラットフォームプロジェクトに適した CMake をサポートしています。Android Studio は、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 プロジェクトにインポートし、ネイティブライブラリをアプリにパッケージ化します。

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

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

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

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

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

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

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] ビューを選択します。図 1 に示すように、Android Studio に cpp グループが追加されます。

図 1. 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 がこのライブラリをアプリにパッケージ化します。
実行時には、アプリの MainActivity が System.loadLibrary() を使用してネイティブライブラリを読み込みます。これで、ライブラリのネイティブ関数である stringFromJNI() をアプリで使用できるようになりました。
MainActivity.onCreate() が stringFromJNI() を呼び出し、返された "Hello from C++" で TextView を更新します。

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

[Build] > [Build Bundles(s) / APK(s)] > [Build APK(s)] を選択します。
[Build] > [Analyze APK] を選択します。
app/build/outputs/ ディレクトリで APK または AAB を選択し、[OK] をクリックします。
図 2 に示すように、APK Analyzer ウィンドウの lib/<ABI>/ の下に libnative-lib.so が表示されます。
図 2. 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 など）を選択します。
- Edit File Types アイコンをクリックして、メニューにファイル形式（.cxx、.hxx など）を追加します。表示された [New File Extensions] ダイアログボックスで、[Source Extension] メニューと [Header Extension] メニューから別のファイル拡張子を選択し、[OK] をクリックします。

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

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

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

参考情報

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

Codelabs

Android Studio で Hello-CMake を作成するこの Codelab では、Android Studio の CMake テンプレートを使用して Android NDK プロジェクトの開発を開始する方法について説明します。