[Android] 안드로이드 스튜디오 NDK 사용법

NDK란?

• 안드로이드 스튜디오에서 바이트 코드가 아닌 네이티브 코드(C/C++)를 사용해야 할 때가 있습니다.
• 자바 이외의 네이티브 코드(C/C++)을 사용하기 위해서는 JNI(Java Native Interface)라는 인터페이스가 있어야 합니다.
• NDK(Native Development Kit)는 안드로이드 환경에서 JNI를 사용하기 위해 구성된 키트입니다.

 

NDK 설치

• 안드로이드 스튜디오 상단바의 Tools -> SDK Manager를 클릭합니다.
• 이후 Android SDK의 SDK Tools에서 NDK를 설치할 수 있습니다. Show Package Detail을 눌러 상세한 버전의 NDK도 설치가능합니다.

 

NDK 위치 설정

• 안드로이드 상단바의 File -> Project Structure를 클릭합니다.
• SDK, JDK, NDK 설정하는 곳이 나타나며, ndk-bundle이 있는 경로를 입력합니다. 또는 ndk의 버전에 해당하는 폴더 경로를 입력해도 됩니다.
• 간혹 경로가 입력이 안되는데 이럴경우 Gradle.scripts의 local.properties 파일로 가서 직접 수정하도록 합니다.

 

Main 코드

• System.LoadLibrary 함수는 네이티브 코드로 작성된 모듈을 호출하는 부분입니다.
• public native int getSum 메소드는 네이티브 코드로 작성된 메소드와 동일한 형태(메소드명, 리턴 타입) 를 가져야 합니다.

 

Native 코드

JNIEXPORT jint JNICALL Java_com_example_jnitest_MainActivity_getSum(JNIEnv *env, jobject thiz, jint num1, jint num2){
    return num1+num2;
}

• 먼저 네이티브 코드를 모아놓은 폴더를 jni명으로 생성해야 합니다.
• 이후 오른쪽 버튼을 눌러 New -> C/C++ Source File 눌러서 다음과 같이 작성합니다.
• JNIEXPORT <리턴타입> JNICALL_Java_<패키지명>_<클래스명>_<함수명> 형태로 작성하되 패키지명의 .은 _로 대체합니다.

 

Header 파일 생성

• 헤더파일은 직접 생성할 수 있지만, 안드로이드 스튜디오를 이용하여 자동으로 생성하는 방법에 대해 설명하겠습니다.

Preferences에서 Tools -> External Tools에서 새로 하나 추가하여 작성하도록 합니다.

• Name : Tool명
• Program : javah 파일이 있는 경로, 대부분 jdk의 Content/Home/bin 폴더 내부에 존재합니다. java8 버전 이후 javah가 없어져서 javac로 대체된다고 했지만 방법을 못찾았습니다. 찾으신 분 댓글로 남겨주시면 감사합니다.
  ex) /Library/Java/JavaVirtualMachines/jdk1.8.0_281.jdk/Contents/Home/bin/javah
• Arguments : 클래스 파일 경로와 패키지 내부 클래스
  ex) -classpath /Users/wonseok/AndroidStudioProjects/JniTest/app/src/main/java -v -jni $FileClass$
• Working directory : header 파일이 생성될 경로, jni 폴더 경로
  ex) /Users/wonseok/AndroidStudioProjects/JniTest/app/src/main/jni

javah를 클릭하면 이전에 생성했던 Calculator.cpp의 헤더파일이 생성됩니다. 헤더파일 명은 <패키지명>_<클래스명> 으로 지정되는데 직접 변경 가능합니다. 이후 cpp 파일에 헤더파일 명을 include 해야 합니다.

#include<com_example_jnitest_MainActivity.h>

JNIEXPORT jint JNICALL Java_com_example_jnitest_MainActivity_getSum(JNIEnv *env, jobject thiz, jint num1, jint num2){
    return num1+num2;
}

 

Android.mk, Application.mk 파일 생성

jni 폴더에서 Android.mk, Application.mk 파일을 생성합니다.

다음과 같이 작성하면 됩니다. 각 세부적인 내용은 공식문서에서 확인할 수 있습니다. Android.mk는 빌드시스템의 소스 및 공유 라이브러리를 설명하는 파일이고, 이 파일을 통해서 소스코드를 모듈로 그룹화할 수 있습니다. 모듈은 정적 라이브러리, 공유 라이브러리, 실행 파일을 뜻하게 됩니다.

• LOCAL_PATH : 소스파일의 경로 , my-dir(시스템이 제공하는 매크로 함수) : Android.mk파일이 포함된 경로
• CLEAR_VARS : LOCAL_XXX로 되어 있는 변수들을 자동으로 삭제하는 변수입니다. 모듈을 설명하기 전에 선언되어야 합니다.
• LOCAL_MODULE : 빌드하려는 모듈의 이름을 지정합니다. System.loadLibrary에서 설정했던 모듈명을 입력해야 합니다.
• LOCAL_SRC_FILES : 모듈에 빌드할 C,C++ 소스파일 목록을 입력합니다.
• LOCAL_LDLIBS : 공유 라이브러리나 실행 파일을 빌드할 때 사용할 추가 링커 목록입니다. -l 접두사를 사용하고 뒤에는 log 라이브러리입니다.
• BUILD_SHARED_LIBRARY : LOCAL_XXX변수에서 제공한 모듈의 모든 정보를 수집하는 빌드 스크립트를 가리키고 나열한 소스에서 타겟 공유 라이브러리의 빌드 방법을 결정합니다.

Application.mk는 ndk-build의 프로젝트 전체 설정을 지정합니다. 세부적인 내용은 공식문서에서 확인할 수 있습니다.

 

• APP_ABI : ABI용 코드 생성
• APP_PLATFORM : 애플리케이션이 빌드된 API 수준을 선언하며, 애플리케이션의 minSdkVersion을 뜻합니다.
• APP_STL : 애플리케이션에 사용될 C++ 표준 라이브러리
• APP_CPPFLAGS : 모든 C++ 컴파일을 위해 전달되는 플래그
• APP_BUILD_SCRIPT : Android.mk 파일의 절대경로, 기본값으로 jni 폴더 아래를 찾기에 위 경로일 시 따로 지정을 안해도 무방

 

NDK 빌드, 전체 결과

MainActivtiy 클래스 파일에 오른쪽 버튼을 클릭하여 Link C++ Project with Gradle 클릭합니다.
이 메뉴가 없다면 상단바의 Build -> Refresh Linked C++ Projects를 클릭하면 됩니다.

만일 Link C++ Project with Gradle이 없고 Refersh Linked C++ Project 버튼이 활성화 되어 있지 않으면 수동으로 Gradle을 구성하여 네이티브 라이르러리를 연결해야 합니다.

build.gradle(app)에 다음과 같이 추가하면 네이티브 라이브러리와 연결되고 Refresh Linked C++ Project 버튼을 활성화되는 것을 확인하실 수 있습니다.

 

NDK 빌드 후 Main 코드를 실행하더라도 오류가 없이 정상적인 출력 결과를 확인할 수 있습니다.
java 코드로 두 피연산자를 더하는 메소드는 없지만 네이티브 코드(c/c++)로 정의된 메소드를 실행하여 정상적으로 출력할 수 있습니다.