【NDK】Android開発にC/C++を使う。最低限の導入手順まとめ

NDKを使うとAndroid開発でこんなことできます。

ネイティブコードを呼び出す
コードをC/C++で書くことができる

ただその手順がメチャクチャ面倒でした。

同じように困っている人に向けて、
Android開発で NDKからC/C++を使う手順をまとめます。

最低限の手順だけまとめると次の通り。

※ ただし Android Studio での手順。

このページの目次

１．C/C++ ファイルを既存プロジェクトに追加
２．CMakeLists.txtにビルド設定を追加
３．モジュール側（アプリ側）のbuild.gradleを編集
４．C/C++ソースでネイティブメソッドを定義
５．Javaからネイティブメソッド呼び出し
６．C/C++側からJavaメソッドの呼び出しもできる
ここまでのNDK導入手順まとめ

１．C/C++ ファイルを既存プロジェクトに追加

まずプロジェクトペインから【Project】を選択

その中から【app】＝＞【src】と開き、【main】を右クリックして【New】＝＞【Directory】を選択。出てきたダイアログに "cpp" と入力して作成。（あるいは "jni" という名前でも良いらしい）

作成したcppディレクトリ上で右クリックし、【New】＝＞【C/C++ source file】を選択。ダイアログから適当にC/C++ソースファイル名を入力。

ここでは hello.cpp を作りました。

もちろんC++ではなくCでもOKです。

ビルドには CMakeLists.txt も必要です。

その作り方はプロジェクトペインのルートディレクトリで右クリックし、【New】＝＞【File】を選択。ダイアログから "CMakeLists.txt" を入力して作成

これで下準備の下準備が完了。

２．CMakeLists.txtにビルド設定を追加

CMakeLists.txtはC/C++のビルド設定ファイル

ここでは次のような設定を書いてみました。

▼ CMakeLists.txtの設定例

cmake_minimum_required(VERSION 3.4.1)

add_library( 
  # 識別用ライブラリ名を指定
  hello

  # 共有ライブラリとしてビルドさせる
  SHARED

  # C/C++ソースへの相対パス指定
  src/main/cpp/hello.cpp
)

target_link_libraries(
        hello
        android
        log
)

cmake_minimum_required(VERSION 3.4.1)

add_library(

# 識別用ライブラリ名を指定

hello

# 共有ライブラリとしてビルドさせる

SHARED

# C/C++ソースへの相対パス指定

src/main/cpp/hello.cpp

)

target_link_libraries(

hello

android

log

)

大事なポイントは次の２つ

add_library
ここには作成したC/C++ライブラリの名前・ビルド方法・相対パス指定する。ここでは hello.cpp の設定を追加（内容については後述）
target_link_libraries
ここには独自ライブラリ名、android, log を指定しておく。こうすることでC/C++側でもログ出力が使えるように

この２点さえ押さえとけばOK

３．モジュール側（アプリ側）のbuild.gradleを編集

次にモジュール側の build.gradle を開きます。

編集画面が開いたら、以下の内容を追加

android {
    compileSdkVersion 29
    
    // 中略...
    
    externalNativeBuild {
        cmake{
            path "CMakeLists.txt"
        }
    }
}

android {

compileSdkVersion 29

// 中略...

externalNativeBuild {

cmake{

path "CMakeLists.txt"

}

CMakeLists.txt のパスを指定するだけです。

これでネイティブメソッドを呼び出す準備は完了

４．C/C++ソースでネイティブメソッドを定義

ここでは次のネイティブメソッドを定義しました。

関数名は getMessage という名前
引数として文字列を１つ受け取る
その引数を含むメッセージを返す

やってることは単純明快です。

そのために書いたC++コードがこちら

▼ ネイティブメソッドのC++コード例

#include <string.h>
#include <string>
#include <jni.h>

extern "C" JNIEXPORT jstring JNICALL
Java_com_example_example_MainActivity_getMessage(
        JNIEnv* env, jobject thiz, jstring j_name
        ){
    const char* name = env->GetStringUTFChars(j_name, 0);
    std::string msg = "Hello ";
    msg +=  name;
    msg += " from JNI!!";
    return env->NewStringUTF(msg.c_str());
}

#include <string.h>

#include <string>

#include <jni.h>

extern "C" JNIEXPORT jstring JNICALL

Java_com_example_example_MainActivity_getMessage(

JNIEnv* env, jobject thiz, jstring j_name

){

const char* name = env->GetStringUTFChars(j_name, 0);

std::string msg = "Hello ";

msg += name;

msg += " from JNI!!";

return env->NewStringUTF(msg.c_str());

}

ここで大事なのは次の３点

マングリングを無効化
上コードのように extern "C" としてマングリング（C++特有の機能）をさせなくする。C++の場合、こうしないとビルドエラーが出る
メソッドの命名規則
例えば com.example.example のMainActivityから呼ばれる場合、 Java_com_example_example_MainActivity_getMessage という名前にする。Java側からは getMessage("hoge"); で呼び出せる。
JavaとC++でのデータ交換
例えばJavaでは文字列に String を使うが、C/C++では jstring が代替として使える。ネイティブ側からJavaに返すときは env->NewStringUTF(msg.c_str()); のように変換する必要あり

あと引数ですが JNIEnv* env, jobject thiz は必須です。

第３引数以降がネイティブメソッドの純粋な引数になります。

５．Javaからネイティブメソッド呼び出し

最後の最後の仕上げ。

Java側からネイティブメソッドを呼びだします。

▼ 成功したActivity全体のコードはこうなりました。

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        // ネイティブメソッド実行
        Log.d("MainActivity", getMessage("Pisuke"));
          /// => Hello Pisuke from JNI!!
    }

    /**
     * C/C++のネイティブメソッドを宣言
     **/
    public native String getMessage(String msg);

    /**
     * C/C++ライブラリを読み込みさせる 
     **/
    static {
        System.loadLibrary("hello");
    }
}