مقدمهای برای آشنایی با JNI، ابزار NDK، CMake و Gradle

مقدمهای برای آشنایی با JNI، ابزار NDK، CMake و Gradle
بیشتر اپلیکیشنهای اندروید با Kotlin یا Java نوشته میشوند. بااینحال، گاهی لازم است از کدهای C یا C++ استفاده کنیم؛ برای مثال، هنگام کار با کتابخانههای Native، موتورهای شبکه، گرافیک یا پروژههای قدیمی C++.
اندروید برای برقراری ارتباط بین Java و کد Native سازوکاری به نام JNI (Java Native Interface) ارائه میکند.
در این مقاله یاد میگیریم:
JNI و NDK چه هستند.
چگونه Java یک تابع C++ را فراخوانی میکند.
چگونه C++ یک متد Java را فراخوانی میکند.
پارامترهای JNIEnv* و jobject چه معنایی دارند.
چگونه با CMake و Gradle یک کتابخانه Native بسازیم.
تفاوت اصلی فراخوانی کد Native از Java با فراخوانی کد Java از Native چیست.
برای مثال، تابعی میسازیم که یک عدد را در دو ضرب میکند.
JNI (Java Native Interface) یک رابط استاندارد است که به کد Java در محیط اجرای اندروید (ART) اجازه میدهد با کد Native نوشتهشده به زبان C یا C++ ارتباط برقرار کند.
NDK (Native Development Kit) مجموعهای از ابزارها برای ساخت کدهای C و C++ مخصوص اندروید است.
به زبان ساده:
JNI روش ارتباط Java و کد Native را مشخص میکند.
NDK ابزارهای لازم برای ساخت کد Native را فراهم میکند.
CMake مشخص میکند کد Native چگونه ساخته شود.
Gradle فرایند ساخت کد Native را به Build پروژه اندروید متصل میکند.
JNI یک کلاس جداگانه نیست که خودمان بسازیم. این رابط توسط محیط اجرای اندروید پشتیبانی میشود و از طریق هدرهایی مانند jni.h در اختیار کد C++ قرار میگیرد.
فرض کنیم کلاس MainActivity را به شکل زیر داریم:
package com.example; public class MainActivity { static { System.loadLibrary("native-lib"); } public native int calculate(int number); public void test() { int result = calculate(10); } }
بیایید قسمتهای مهم را بررسی کنیم.
nativepublic native int calculate(int number);
کلمه کلیدی native نشان میدهد که پیادهسازی این متد بهجای Java، در کد Native قرار دارد.
System.loadLibrary("native-lib");
این دستور کتابخانهای با نام libnative-lib.so را بارگذاری میکند.
هنگام استفاده از loadLibrary نیازی نیست پیشوند lib و پسوند .so را بنویسیم.
int result = calculate(10);
متد Native را مانند یک متد معمولی Java فراخوانی میکنیم. لازم نیست پارامترهای مخصوص JNI را بهصورت دستی ارسال کنیم.
اکنون متد calculate() را در C++ پیادهسازی میکنیم:
#include <jni.h> extern "C" JNIEXPORT jint JNICALL Java_com_example_MainActivity_calculate( JNIEnv* env, jobject thiz, jint number ) { return number * 2; }
اگر Java متد calculate(10) را فراخوانی کند، نتیجه 20 خواهد بود.
#include <jni.h>این هدر، اعلانها و انواع موردنیاز JNI را در اختیار C++ قرار میدهد؛ مانند JNIEnv، jobject و jint.
اضافهکردن این هدر بهتنهایی ارتباط زمان اجرا را برقرار نمیکند. محیط اجرای اندروید و کتابخانه Native سازوکار لازم برای ارتباط را فراهم میکنند.
extern "C"کامپایلر C++ معمولاً نام توابع را به شکلی تغییر میدهد که اطلاعات مربوط به نوع و امضای آنها را در بر بگیرد؛ به این کار Name Mangling میگویند.
extern "C" مشخص میکند که تابع باید از قواعد اتصال زبان C استفاده کند. این کار به JNI کمک میکند تابع را با نام موردانتظار پیدا کند.
JNIEXPORT و JNICALLاینها ماکروهای JNI هستند که برای تعریف توابع Native با قابلیت دسترسی و قرارداد فراخوانی مناسب استفاده میشوند.
jintنوع jint معادل نوع int در Java است.

Java_com_example_MainActivity_calculate
در روش متداول JNI، نام تابع از نام پکیج، کلاس و متد Java ساخته میشود.
در مثال ما:
پکیج: com.example
کلاس: MainActivity
متد: calculate
این نام باید با تعریف Java مطابقت داشته باشد. روش دیگر، ثبت صریح متدها با استفاده از RegisterNatives است.
JNIEnv* env و jobject thiz را تأمین میکند؟به فراخوانی زیر در Java توجه کن:
int result = calculate(10);
ما فقط یک آرگومان، یعنی 10، ارسال کردهایم. پس env و thiz از کجا میآیند؟
محیط اجرای اندروید (ART) هنگام ورود به تابع Native این پارامترها را فراهم میکند. لازم نیست آنها را از Java ارسال کنیم.
JNIEnv* envاین پارامتر امکان دسترسی به عملیات JNI (JNI API) را فراهم میکند. از طریق آن میتوانیم کلاسهای Java را پیدا کنیم، متدها را فراخوانی کنیم و با اشیا و رشتههای Java کار کنیم.
هر Thread که از JNI استفاده میکند، رابط JNIEnv مخصوص خودش را دارد. بنابراین نباید یک اشارهگر JNIEnv را آزادانه بین Threadهای مختلف به اشتراک گذاشت.
jobject thizاین پارامتر به شیء Javaای اشاره میکند که متد Native روی آن فراخوانی شده است.
در مثال ما، thiz به نمونه مربوط از MainActivity اشاره میکند.
نام thiz اجباری نیست؛ میتوانیم نام دیگری، مانند instance، انتخاب کنیم.
jint numberاین پارامتر همان آرگومانی است که از Java دریافت میشود. اگر Java متد calculate(10) را فراخوانی کند، مقدار number برابر 10 خواهد بود.
static باشد چه میشود؟اگر تعریف متد در Java به شکل زیر تغییر کند:
public static native int calculate(int number);
نوع پارامتر دوم در C++ بهجای jobject، از نوع jclass خواهد بود:
JNIEXPORT jint JNICALL Java_com_example_MainActivity_calculate( JNIEnv* env, jclass clazz, jint number ) { return number * 2; }
در این حالت، clazz به کلاس Java اشاره میکند، نه به یک نمونه از آن.
بنابراین:
متد Native غیر static: پارامتر دوم jobject است.
متد Native از نوع static: پارامتر دوم jclass است.
JNI به کد Native اجازه میدهد متدهای Java را نیز فراخوانی کند.
فرض کنیم کلاس MainActivity متد زیر را دارد:
public String createMessage(int number) { return "Number: " + number; }
کد C++ میتواند با استفاده از JNI آن را فراخوانی کند:
jclass clazz = env->FindClass( "com/example/MainActivity" ); jmethodID method = env->GetMethodID( clazz, "createMessage", "(I)Ljava/lang/String;" ); jstring message = (jstring) env->CallObjectMethod( thiz, method, 10 );
در این مثال، نام کلاس را مستقیماً به FindClass() دادهایم. توجه کن که نام کلاس در این تابع با اسلش (/) نوشته میشود، نه نقطه (.).
این مثال فرض میکند thiz به یک نمونه از MainActivity اشاره میکند؛ همانطور که وقتی این کد در پیادهسازی Native یک متد نمونهای از همین کلاس اجرا شود، اتفاق میافتد.
این کد سادهشده است. در کد واقعی باید خطاهای احتمالی هنگام پیدا کردن کلاس یا متد، استثناهای Java و مدیریت Referenceهای JNI را نیز در نظر بگیریم.
عملکرد توابع:
۱. FindClass() کلاس Java را با نام آن پیدا میکند.
۲. GetMethodID() متد را با استفاده از نام و امضای آن پیدا میکند.
۳. CallObjectMethod() متد Java را روی شیء مشخصشده اجرا میکند.
امضای زیر را در نظر بگیر:
(I)Ljava/lang/String;
معنای آن:
(I): متد یک آرگومان از نوع int دریافت میکند.
Ljava/lang/String;: متد یک String برمیگرداند.
-> چیست؟در عبارت زیر:
env->GetMethodID(...)
علامت -> یک عملگر معمولی C++ برای دسترسی به عضو از طریق اشارهگر است؛ این علامت مخصوص JNI نیست.
اما GetMethodID() یکی از توابع API مربوط به JNI است که از طریق رابط JNIEnv به آن دسترسی داریم.
تا اینجا دو حالت متفاوت را بررسی کردیم:
۱. فراخوانی یک متد Native در C++ از داخل Java
۲. فراخوانی یک متد Java از داخل کد Native در C++
هر دو حالت از JNI استفاده میکنند، اما نحوه نوشتن کد در آنها متفاوت است.
در Java، متد را با کلمه کلیدی native تعریف میکنیم:
public native int calculate(int number);
سپس آن را مانند یک متد معمولی فراخوانی میکنیم:
int result = calculate(10);
لازم نیست از داخل Java توابع JNI مانند FindClass() یا GetMethodID() را بهصورت دستی فراخوانی کنیم. محیط اجرای اندروید انتقال به کد Native را مدیریت میکند و پارامترهای موردنیاز JNI را در اختیار تابع Native قرار میدهد.
وقتی کد Native نیاز دارد یک متد Java را اجرا کند، معمولاً باید APIهای JNI را بهصورت صریح به کار ببریم:
jclass clazz = env->FindClass( "com/example/MainActivity" ); jmethodID method = env->GetMethodID( clazz, "createMessage", "(I)Ljava/lang/String;" ); jstring message = (jstring) env->CallObjectMethod( thiz, method, 10 );
در این حالت، کد C++ باید کلاس و متد Java را پیدا کند و سپس از طریق رابط JNI آن متد را اجرا کند.
تفاوت اصلی این است: وقتی Java یک متد Native را فراخوانی میکند، معمولاً کافی است متد را با native تعریف کنیم و مستقیماً آن را صدا بزنیم؛ نیازی به استفاده دستی از APIهای JNI برای این فراخوانی نداریم. اما وقتی C++ یک متد Java را فراخوانی میکند، معمولاً باید APIهایی مانند FindClass()، GetMethodID() و CallObjectMethod() را صریحاً به کار ببریم.
JNI در هر دو جهت حضور دارد، اما نحوه استفاده ما از API آن متفاوت است.
نوشتن کد C++ کافی نیست؛ باید آن را کامپایل کنیم و به یک کتابخانه Native تبدیل کنیم تا اندروید بتواند آن را بارگذاری کند.
یکی از روشهای رایج در Android Studio، استفاده از CMake است.
ساختار معمول پروژه:
app/ └── src/ └── main/ └── cpp/ ├── CMakeLists.txt └── native-lib.cpp
native-lib.cppپیادهسازی C++ بخش چهارم را در این فایل قرار میدهیم.
CMakeLists.txtدر همان پوشه، فایلی با نام دقیق CMakeLists.txt ایجاد میکنیم:
cmake_minimum_required(VERSION 3.22.1) project("native-lib") add_library( native-lib SHARED native-lib.cpp )
معنای دستورات:
cmake_minimum_required(): حداقل نسخه موردنیاز CMake را مشخص میکند.
project(): پروژه CMake را تعریف میکند.
add_library(): یک هدف کتابخانهای تعریف میکند.
SHARED: مشخص میکند خروجی یک کتابخانه اشتراکی باشد.
native-lib.cpp: فایل C++ای است که باید کامپایل شود.
خروجی کتابخانهای با نام libnative-lib.so خواهد بود.
فایل build.gradle.kts مربوط به ماژول اپلیکیشن را باز میکنیم و تنظیمات زیر را داخل بلوک موجود android قرار میدهیم:
android { externalNativeBuild { cmake { path = file("src/main/cpp/CMakeLists.txt") } } }
این مثال از Kotlin DSL، یعنی فایل build.gradle.kts، استفاده میکند. اگر پروژه از فایل build.gradle با Groovy استفاده کند، ساختار نوشتن تنظیمات کمی متفاوت خواهد بود.
مسیر بالا فرض میکند فایل CMake در app/src/main/cpp/CMakeLists.txt قرار دارد.
هنگام Build اپلیکیشن، Gradle، CMake را اجرا میکند و ابزارهای NDK کد C++ را به یک کتابخانه Native تبدیل میکنند.
کتابخانه .so برای معماریهای پردازنده پشتیبانیشده ساخته و توسط Gradle داخل اپلیکیشن بستهبندی میشود.
در زمان اجرا، این دستور کتابخانه را بارگذاری میکند:
System.loadLibrary("native-lib");
پس از آن، متد Native میتواند از طریق سازوکار JNI فراخوانی شود.
برای این فرایند، باید نسخه سازگار Android NDK و CMake در محیط توسعه نصب باشد. این ابزارها را میتوان از طریق SDK Tools در Android Studio مدیریت کرد.
فرایند ساخت را میتوان به شکل زیر خلاصه کرد:
۱. Gradle: فرایند Build اپلیکیشن اندروید را مدیریت میکند.
۲. CMake: نحوه کامپایل و لینککردن کتابخانه Native را مشخص میکند.
۳. Android NDK: کامپایلر و ابزارهای توسعه Native را فراهم میکند.
۴. کد C++ به یک فایل .so تبدیل میشود.
۵. Gradle کتابخانه را داخل اپلیکیشن قرار میدهد.
۶. محیط اجرای اندروید کتابخانه را بارگذاری میکند و متدهای Native را به پیادهسازیهایشان متصل میکند.
CMake تنها روش موجود نیست؛ اندروید از ndk-build نیز پشتیبانی میکند. بااینحال، CMake یکی از انتخابهای رایج در پروژههای Android Studio است.
JNI امکان برقراری ارتباط بین Java و C++ را در اپلیکیشنهای اندروید فراهم میکند.
نکات کلیدی:
با کلمه کلیدی native، متدی را در Java تعریف میکنیم که پیادهسازی آن در کد Native قرار دارد.
با System.loadLibrary() کتابخانه Native را بارگذاری میکنیم.
با jni.h به انواع و اعلانهای JNI در C++ دسترسی پیدا میکنیم.
محیط اجرای اندروید پارامتر JNIEnv* و Reference مربوط به شیء یا کلاس را فراهم میکند.
برای فراخوانی متدهای Java از C++ از توابعی مانند FindClass()، GetMethodID() و CallObjectMethod() استفاده میکنیم.
وقتی Java متد Native را فراخوانی میکند، معمولاً آن را مانند یک متد معمولی صدا میزنیم و نیازی به فراخوانی دستی APIهای JNI نداریم.
CMake نحوه ساخت کتابخانه Native را مشخص میکند و Gradle این فرایند را به Build پروژه اندروید متصل میکند.
با درک این مفاهیم، کار با پروژههایی که Kotlin یا Java را با کتابخانههای Native مبتنی بر C++ ترکیب میکنند، بسیار سادهتر خواهد شد.
من محمد رئیسی برنامه نویس اندروید هستم و امیدوارم این مقاله براتون مفید بوده باشه.