ข้ามไปที่เนื้อหา

Android Native

คู่มือการติดตั้ง Android Native

สามารถติดตั้ง Hercules Android Native Library ผ่าน Maven Central ได้


1. ตั้งค่าที่เก็บแพ็กเกจ Maven Central

ตรวจสอบว่าได้เพิ่มที่เก็บแพ็กเกจ Maven Central ใน settings.gradle หรือ settings.gradle.kts ของโปรเจกต์แล้ว

หากมี mavenCentral() อยู่ใน repositories ของ dependencyResolutionManagement แล้ว ไม่จำเป็นต้องตั้งค่าเพิ่มเติม

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}

หากมี dependencyResolutionManagement อยู่แล้ว แต่ยังไม่มี mavenCentral() ให้เพิ่ม mavenCentral() ลงใน repositories ที่มีอยู่

หากโปรเจกต์ไม่ได้จัดการที่เก็บแพ็กเกจผ่าน settings.gradle หรือ settings.gradle.kts ให้เพิ่มเนื้อหาต่อไปนี้ลงใน build.gradle หรือ build.gradle.kts ของโมดูลที่ใช้ Hercules

repositories {
    mavenCentral()
}
Warning

หากมี repositories อยู่แล้ว อย่าลบหรือเขียนทับรายการเดิม ให้เพิ่มเฉพาะ mavenCentral() เท่านั้น


2. เพิ่ม Dependency ของ Hercules

เพิ่ม Dependency ของ Hercules ลงใน build.gradle หรือ build.gradle.kts ของโมดูล Android ที่จะใช้ Hercules

Gradle (Groovy DSL)

dependencies {
    implementation 'com.com2us.android.gamesec:hercules:26.8.31'
}

Kotlin DSL

dependencies {
    implementation("com.com2us.android.gamesec:hercules:26.8.31")
}

เมื่อเรียกใช้ Gradle Sync ระบบจะดาวน์โหลด Hercules AAR จาก Maven Central โดยอัตโนมัติ


3. ใช้ Hercules ใน C/C++

Hercules รองรับ ABI ต่อไปนี้

arm64-v8a, armeabi-v7a, x86, x86_64

หากต้องการใช้ API ใน C/C++ ให้เปิดใช้งาน Prefab ในโมดูล Android

Gradle (Groovy DSL)

android {
    buildFeatures {
        prefab true
    }
}

Kotlin DSL

android {
    buildFeatures {
        prefab = true
    }
}

จากนั้นเพิ่มการตั้งค่า CMake หรือ ndk-build ตามระบบบิลด์เนทีฟที่ใช้


4. ตั้งค่า CMake

ข้ามการตั้งค่า CMake หากใช้ ndk-build หรือไม่ได้ใช้ Hercules ใน C/C++

4.1 เชื่อมต่อ CMake กับ Gradle

ระบุ CMakeLists.txt ในการตั้งค่า Gradle ของโมดูลที่ใช้ Hercules

Gradle (Groovy DSL)
android {
    externalNativeBuild {
        cmake {
            path file('src/main/cpp/CMakeLists.txt')
        }
    }
}
Kotlin DSL
android {
    externalNativeBuild {
        cmake {
            path = file("src/main/cpp/CMakeLists.txt")
        }
    }
}

หากโปรเจกต์ใช้ CMake อยู่แล้ว ให้ใช้การตั้งค่า externalNativeBuild เดิมต่อไป

4.2 ลิงก์ Hercules ใน CMakeLists.txt

นำเข้าแพ็กเกจ Hercules Prefab ด้วย find_package แล้วลิงก์กับทาร์เก็ตเนทีฟที่จะใช้ Hercules

ตัวอย่างเช่น หากไลบรารีเนทีฟของโปรเจกต์มีชื่อว่า native-lib:

cmake_minimum_required(VERSION 3.22.1)

project("sample")

add_library(native-lib SHARED
    native-lib.cpp
)

find_package(Hercules REQUIRED CONFIG)

target_link_libraries(native-lib
    Hercules::Hercules
)

5. ตั้งค่า ndk-build

ข้ามการตั้งค่า ndk-build หากใช้ CMake หรือไม่ได้ใช้ Hercules ใน C/C++

5.1 เชื่อมต่อ ndk-build กับ Gradle

ระบุ Android.mk ในการตั้งค่า Gradle ของโมดูลที่ใช้ Hercules

Gradle (Groovy DSL)
android {
    externalNativeBuild {
        ndkBuild {
            path file('src/main/cpp/Android.mk')
        }
    }
}
Kotlin DSL
android {
    externalNativeBuild {
        ndkBuild {
            path = file("src/main/cpp/Android.mk")
        }
    }
}

หากโปรเจกต์ใช้ ndk-build อยู่แล้ว ให้ใช้การตั้งค่า externalNativeBuild เดิมต่อไป

5.2 ลิงก์ Hercules ใน Android.mk

เพิ่ม Hercules ลงใน LOCAL_SHARED_LIBRARIES ของโมดูลเนทีฟที่จะใช้ Hercules และนำเข้าโมดูล Prefab

ตัวอย่างเช่น หากไลบรารีเนทีฟของโปรเจกต์มีชื่อว่า native-lib:

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE := native-lib
LOCAL_SRC_FILES := native-lib.cpp
LOCAL_SHARED_LIBRARIES := Hercules
include $(BUILD_SHARED_LIBRARY)

$(call import-module,prefab/Hercules)

หากต้องรองรับเวอร์ชันที่เก่ากว่า NDK r21 ด้วย ให้เพิ่มการตั้งค่าต่อไปนี้ก่อนนำเข้า Prefab

ifneq ($(call ndk-major-at-least,21),true)
    $(call import-add-path,$(NDK_GRADLE_INJECTED_IMPORT_PATH))
endif

6. การใช้ API

ตัวอย่าง:

#include <Hercules.h>
...
unsigned int version = HerculesGetVersion();
__android_log_print(ANDROID_LOG_INFO, "Hercules", "version: %u", version);

Hercules จะเริ่มต้นการทำงานพร้อมกับการเริ่มต้นการทำงานของ Hive SDK

ไม่จำเป็นต้องเรียก InitializeHercules


7. เปลี่ยนเวอร์ชัน

หากต้องการเปลี่ยนเวอร์ชันของ Hercules ที่จะติดตั้ง ให้เปลี่ยนเวอร์ชันที่ระบุใน dependencies

Gradle (Groovy DSL)

implementation 'com.com2us.android.gamesec:hercules:26.8.31'

Kotlin DSL

implementation("com.com2us.android.gamesec:hercules:26.8.31")

8. นำ Hercules ออก

หากต้องการนำ Hercules ออก ให้ลบ Dependency ของ Hercules ออกจาก dependencies ของโมดูลนั้น

com.com2us.android.gamesec:hercules:26.8.31

หากเคยใช้ Hercules ใน C/C++ ให้ลบการตั้งค่าการลิงก์ Hercules ที่เพิ่มไว้ใน CMake หรือ ndk-build ด้วย

CMake:

find_package(Hercules REQUIRED CONFIG)
Hercules::Hercules

ndk-build:

LOCAL_SHARED_LIBRARIES := Hercules
$(call import-module,prefab/Hercules)

หากไม่มี Dependency อื่นนอกจาก Hercules ที่ใช้แพ็กเกจ Prefab สามารถลบการตั้งค่า buildFeatures.prefab ของ Gradle ได้เช่นกัน