Android so库开发——使用Studio调用so库

Posted 2023-04-06 c小旭

一、JNI规范so库调用

        在 Android Studio生成自己的so库 中已经创建了自己的so库，这是一个JNI规范的so库，可以直接将so库放到libs中，并按照上面文章中MainActivity中的调用方法使用。

1、build.gradle（app）配置

android 

    defaultConfig 
        // 加载so类型
        ndk 
            abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
        
    
    // so库路径
    sourceSets 
        main 
            jniLibs.srcDirs = ['libs']
        
    

2、加载so库中方法

public class NativeImpl 
    // 加载so库
    static 
        System.loadLibrary("native_xiaoxu");
    

    /**
     * 添加 native 方法
     */
    public static native String getUserName();

        在Sudio中方法名虽然显示红色，但不影响使用。

3、Activity中调用方法

NativeImpl.getUserName();

二、非JNI规范的so库调用

         在 Android Studio生成自己的so库 中如果我们没有使用 native-lib.cpp 对命名进行规范化，我们如何直接调用 cpp 中的方法？这时，这时我们需要创建一个自己的so库，在自己的so库中调用三方so库，再在自己的程序中调用自己的so库。

        我们还是在之前项目的基础上进行修改，并使用之前生成的so库。

1、放入so库

        gradle 4.0开始就对jni的预编译依赖引用方式做出了修改，原来的直接放在“src/main/jniLibs”中的方法已经作废了，所以要把jniLibs里的预编译库换个位置，比如把jniLibs改为mylibs，当然，CMakeLists.txt中的IMPORTED路径也要做出相应修改。

 2、CMakeLists.txt

# 设置 Cmake 最小版本
cmake_minimum_required(VERSION 3.10.2)

# 项目名称
project("nativetestdemo")

# 创建并命名一个库，将其设置为STATIC或SHARED，并提供其源代码的相对路径。
add_library( # 设置库名称
        new_xiaoxu
        # 设置库的类型
        SHARED
        # 源代码路径
        native-lib.cpp)

# 声明一个变量 distribution_DIR 并且赋值
# $CMAKE_SOURCES_DIR 是 cmake 自带的参数，可以直接使用
set(distribution_DIR $CMAKE_SOURCE_DIR/../../../../mylibs)

# 添加一个库，在这里可以理解为声明了一个变量，来承载需要引入的库
add_library(
        sotest # 表示的是模块名称，可以自己任意取
        SHARED # 这个是固定的，基本上表示共享库
        IMPORTED # 这个也基本上是固定的，表示当前是导入的，跟我们 java 的 import 差不多含义
        )

# 给sotest这个库设置so文件链接的位置
set_target_properties(sotest # 库的名称
        PROPERTIES IMPORTED_LOCATION # 表示当前库是导入的方式 
        ../../../../mylibs/$ANDROID_ABI/libnative_xiaoxu.so # so动态库的具体路径，这里也可以使用上面的变量表示：$distribution_DIR/$ANDROID_ABI/libnative_xiaoxu.so
        )

# 如果第三方库有头文件的，为了在编码的时候可以有提示，使用下面的指令进行指定
# 这里是指定头文件那些的目录，这样指定后，编译器会扫描这个目录，编码的时候就可以提示到这里的方法了，不加这个也不会报错
include_directories($distribution_DIR/includes)

# 表示从系统中查找库，其中 log-lib 表示我们为这个库的别名（可以随便取），log 就是真实的库名称
find_library( # Sets the name of the path variable.
        log-lib

        # Specifies the name of the NDK library that
        # you want CMake to locate.
        log)

# 连接所有的库.
target_link_libraries( # 指定目标库.
        new_xiaoxu
        sotest
        # 将目标库链接到包含在NDK中的日志库。
        $log-lib)

        主要代码就在注释部分。

3、添加.h文件

        将上篇文章中的NativeImpl.h放到cpp文件夹下。

4、native-lib.cpp

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

/* 获取NativeImpl */
NativeImpl nativeImpl;
NativeImpl* getNativeImpl()
    return &nativeImpl;


extern "C" JNIEXPORT jstring JNICALL
Java_com_wm_auto_nativetestdemo_NativeImpl_getUserName(
        JNIEnv* env,
        jclass clazz) 
    char* c = getNativeImpl()->getUserName();
    return env->NewStringUTF(c);

        这里的代码基本没有变化，但之前getUserName()是cpp下NativeImpl.cpp中的方法，而这里是so库中里NativeImpl.cpp中的方法。

5、Java代码NativeImpl

public class NativeImpl 
    // 加载so库
    static 
        System.loadLibrary("new_xiaoxu");
    

    /**
     * 添加 native 方法
     */
    public static native String getUserName();

        只修改了加载库

整体代码结构

总结：

1、两种引用so库的使用场景

        首先两种调用方式都是可行的，主要是要看提供的是不是JNI规范so库，如果不是就只能选择第二种方案。其次还要看你是不是希望这个SO的库直接暴露给JAVA层，如果答案是否定的，你只能选第二个方案。

项目源码

参考：Android NDK开发: 通过C/C++调用第三方so库

PS：参考代码中，要记得修改so路径。

三、JNI回调

1、NativeImpl中添加回调方法

public class NativeImpl 
    // 加载so库
    static 
        System.loadLibrary("new_xiaoxu");
    

    /**
     * 添加 native 方法
     */
    public static native String getUserName();

    public native String onCallback() 
        // JNI回调成功
    

2、 native-lib.cpp

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

JNIEnv *gEmv = NULL;
jobject gJavaObj = NULL;
jmethodID nativeCallback = NULL;
void setCallBack();

/* 获取NativeImpl */
NativeImpl nativeImpl;
NativeImpl* getNativeImpl()
    return &nativeImpl;


extern "C" JNIEXPORT jstring JNICALL
Java_com_wm_auto_nativetestdemo_NativeImpl_getUserName(
        JNIEnv* env,
        jclass clazz) 
    char* c = getNativeImpl()->getUserName();
    
    // 映射Java方法
    jclass clazz = env->GetObjectClass(thiz);
    nativeCallback = env->GetMethodID(clazz,"onCallback","()V");
    // 保存到全局变量
    gEmv = env;
    gJavaObj = thiz;
    // 调用回调方法，正常应该在其他方法中调用，这里为了方便直接调用了
    setCallBack();

    return env->NewStringUTF(c);


void setCallBack() 
    gEmv->CallVoidMethod(gJavaObj, nativeCallback);

        这里将一些参数保存到全局，并映射到 Java 方法，即可会调到 Java 层。但是在子线程中回调的时候就会出现问题，因为我们保存的 jobject 是一个局部引用，一旦我们的函数返回 jobject 就会被GC回收销毁，所以此时虽然我们的 gJavaObj 保存了全局引用，但是它现在指向的是一个非法地址，当然我们使用非法地址直接报 crash。那就是根据局部引用创建全局引用，这样就不会被GC回收销毁了。

3、子线程调用

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

JavaVM *gJavaVM = NULL;
jobject gJavaObj = NULL;
jmethodID nativeCallback = NULL;
static void* setCallBack(void *arg);

/* 获取NativeImpl */
NativeImpl nativeImpl;
NativeImpl* getNativeImpl()
    return &nativeImpl;


extern "C" JNIEXPORT jstring JNICALL
Java_com_wm_auto_nativetestdemo_NativeImpl_getUserName(
        JNIEnv* env,
        jclass clazz) 
    char* c = getNativeImpl()->getUserName();
    
    gJavaObj = env->NewGlobalRef(thiz);
    jclass clazz = env->GetObjectClass(thiz);
    nativeCallback = env->GetMethodID(clazz,"onClientEvent_native","()V");
    env->GetJavaVM(&gJavaVM);

    pthread_t id;
    //通过pthread库创建线程
    pthread_create(&id,NULL,setCallBack,NULL);

    return env->NewStringUTF(c);


static void* setCallBack(void *arg)
    JNIEnv *env;
    //从全局的JavaVM中获取到环境变量
    gJavaVM->AttachCurrentThread(&env,NULL);
	//跨线程回调Java层函数
    env->CallVoidMethod(gJavaObj, nativeCallback);
    gJavaVM->DetachCurrentThread();
	return ((void *)0);

        这样就可以在子线程中调用了。注意：如果在非子线程中这么使用还会出现另一个异常“attempting to detach while still running code”。这是调用 DetachCurrentThread() 时报错，调用DetachCurrentThread 函数的地方在 java 线程中，即在 java 调用 C++ 代码时在 C++ 代码中调用了 AttachCurrentThread 方法来获取 JNIEnv，此时 JNIEnv 已经通过参数传递进来，你不需要再次 AttachCurrentThread 来获取。在释放时就会报错。

---

        以上两种方案使用自己生成的 so 库都是没问题的，但是在实际项目开发中，我们的 so 库是底层开发的同事提供的。使用上面的方案在调用 System.loadLibrary("lib") 时会报错，提示找不到库。最后在同事的帮助下对 so 的引用做了修改。

1、修改so库文件路径

        再 cpp 下创建 so 库存放路径

2、修改 CMakeLists.txt

cmake_minimum_required(VERSION 3.18.1)

project("jniServer")

add_library( # Sets the name of the library.
        jniServer

        # Sets the library as a shared library.
        SHARED

        # Provides a relative path to your source file(s).
        ServerLib.cpp
        )

project("jniClient")

add_library( # Sets the name of the library.
        jniClient

        # Sets the library as a shared library.
        SHARED

        # Provides a relative path to your source file(s).
        ClientLib.cpp
        )

target_include_directories(jniServer
        PRIVATE
        include)

target_include_directories(jniClient
        PRIVATE
        include)

add_library(client SHARED IMPORTED)

set_target_properties(client
        PROPERTIES IMPORTED_LOCATION
        $CMAKE_SOURCE_DIR/libs/$CMAKE_ANDROID_ARCH/client_lib.so)

add_library(server SHARED IMPORTED)
set_target_properties(server
        PROPERTIES IMPORTED_LOCATION
        $CMAKE_SOURCE_DIR/libs/$CMAKE_ANDROID_ARCH/server_lib.so)


include_directories(
        include
)

find_library( # Sets the name of the path variable.
        log-lib

        # Specifies the name of the NDK library that
        # you want CMake to locate.
        log)

target_link_libraries( # Specifies the target library.
        jniServer
        server
        # Links the target library to the log library
        # included in the NDK.
        $log-lib)

target_link_libraries( # Specifies the target library.
        jniClient
        client
        # Links the target library to the log library
        # included in the NDK.
        $log-lib)

install(TARGETS jniServer
        LIBRARY DESTINATION .
        )

install(TARGETS jniClient
        LIBRARY DESTINATION .
        )

        这个配置文件是对两个 so 库进行了重写 Server 和 Client，一个 so 库的时候删除一组对应的代码即可。使用的时候跟上面就一样了。

Android Studio 编译apk，so库一起打包

参考技术A 如下图所示，在编译apk的时候，我需要把libs/armeabi-v7a下的so库一起打包到apk里面。

需要在build.gradle中添加如下内容：
ndk
abiFilters "armeabi-v7a"


sourceSets.main.jniLibs.srcDirs = ['libs']

===============================================================
深圳上班，
生活简简单单，
14年开始从事Android Camera相关软件开发工作，
做过车载、手机、执法记录仪......
公众号记录生活和工作的点滴，
关注“小驰笔记”，期待和你相遇~