虹软人脸识别 - Android平台调用动态库时的常见错误解析

最近我们发现很多用户在接入虹软ArcFace人脸识别SDK时，经常会遇到动态库加载失败的相关问题。本文详细介绍从编译动态库（.so）到程序调用so的整个流程，模拟在加载虹软人脸识别so文件时经常遇到的一些问题，帮助大家了解这些问题出现的原因以及解决方法。

java.lang.UnsatisfiedLinkError: couldn't find "libarcsoft_face_engine.so"

原因：

在安装应用时，APK中指定的ABI目录下没有发现指定的动态库，寻找apk中动态库的规则详见

https://developer.Android.Google.cn/ndk/guides/abis?hl=en#aen

导致这个问题的间接原因很多，比如：

Android工程中没有指定的动态库

Android工程中动态库存放位置错误

设备支持的最高ABI是armeabi-v7a，而apk只有arm64-v8a的动态库

解决方案：

确保被安装程序中包含的目标设备支持的ABI的动态库，可以解压APK检查动态库是否存在。

java.lang.UnsatisfiedLinkError: "libarcsoft_face_engine.so" is 32-bit instead of 64-bit

原因：

在64位库目录下存放的动态库文件是32位的。

例如将armeabi-v7a的动态库存放在arm64-v8a目录下，并安装在支持arm64-v8a的设备上，就会导致这样的错误。

解决方案：

确保动态库ABI正确，一般在拷贝文件时拷贝ABI文件夹即可。

java.lang.UnsatisfiedLinkError: dlopen failed: file offset for the library ".../libarcsoft_face_engine.so" >= file size: 0 >= 0

原因：

动态库存在，但是文件是空的。

解决方案：

重新将动态库引入工程。

java.lang.UnsatisfiedLinkError: No implementation found for int b.a.a.b.b(android.content.Context, java.lang.String, java.lang.String) (tried Java_b_a_a_b_b and Java_b_a_a_b_b__Landroid_content_Context_2Ljava_lang_String_2Ljava_lang_String_2)
        at b.a.a.b.b(Native Method)
        at b.a.a.b.a(:182)

原因：

在Java函数确定后，按照固定的规则去寻找native函数找不到。一般情况下都是Java代码混淆导致的。

解决方案：

修改混淆配置文件，确保相关的Java代码不被混淆。

JNI DETECTED ERROR IN APPLICATION: JNI ReGISterNatives called with pending exception java.lang.ClassNotFoundException: Didn't find class "com.arcsoft.face.FaceEngine"

原因：

在动态库中，以指定的Java签名无法找到对应的Java类、函数、变量。

解决方案：

修改混淆配置文件，确保相关的Java代码不被混淆。

以上是常见的crash与基本原因和解决方案的介绍，接下来，我们来自己编译动态库并使用，了解下这些问题是怎么出现的。

CMakeLists.txt

CMakeLists.txt

hello.cpp

libhello-sdk.so

add_library(
          hello-sdk
          SHARED
          hello.cpp
)

hello.cpp

在这个文件中，使用JNI静态注册和动态注册的方式定义了两个函数，并在

JNI_Onload

Java_com_arcsoft_functionregisterdemo_MainActivity_hello

需要被静态注册的函数，在Java中定义的native函数首次被调用时，会由JVM按照固定的规则去寻找native函数并注册。这个规则一般是：

Java_包名_类名_函数名

JniShortName()

JniLongName()

dynamicRegisterFunction

需要被动态注册的函数，一般在

JNI_OnLoad

JNI_OnLoad

动态库被加载时，会被执行的函数，在这里对

dynamicRegisterFunction

JNI_OnLoad

  #include 
  #include 
  // 静态注册的函数，对应MainActivity类中的hello函数
  extern "C" JNIEXPORT jstring JNICALL
  Java_com_arcsoft_functionregisterdemo_MainActivity_hello(JNIEnv *env,jobject thiz) {
      return env->NewStringUTF("hello world");
  }
  // 动态注册的函数
  jstring dynamicRegisterFunction(JNIEnv *env, jobject thiz) {
      return env->NewStringUTF("hello, I'm from dynamicRegisterFunction");
  }  
  // 在动态库加载时进行函数注册
  int JNI_OnLoad(JavaVM *javaVM, void*reserved) {
      JNIEnv *jniEnv; 
      if (javaVM->GetEnv((void **)(&jniEnv), JNI_VERSION_1_4) != JNI_OK) {
          return JNI_ERR;
      }
      jclass registerClass =jniEnv->FindClass("com/arcsoft/functionregisterdemo/MainActivity");
      JNINativeMethodjniNativeMethods[] = {
              // name signature nativeFunction             
             {"dynamicRegisterFunction", "()Ljava/lang/String;",
                     (void *)(dynamicRegisterFunction)}
      };
      if(jniEnv->RegisterNatives(registerClass, jniNativeMethods,
                                 sizeof(jniNativeMethods) / sizeof((jniNativeMethods)[0])) < 0) {
          return JNI_ERR;
      } else {
          return JNI_VERSION_1_4;
      }
  }

build.gradle

配置

CMakeLists.txt

armeabi-v7a

arm64-v8a

  apply plugin: 'com.android.application'
  android {
      ...
      defaultConfig {
          ...
          ndk.abiFilters 'armeabi-v7a', 'arm64-v8a'
      }
      ...
      externalNativeBuild {
        cmake {
              path "src/main/cpp/CMakeLists.txt"
              version "3.10.2"
        }
      }
  }
  dependencies {
      ...
  }

我们可以选择直接打包apk安装运行，但这里为了模拟调用SDK，我们可以选择手动打包动态库再拿来使用。

执行

externalNativebuild(Release|Debug)

terminal

gradlew externalNativebuildRelease

externalNativeBuildRelease

至此，

libhello-sdk.so

src/main/jniLibs

由于我们已经编译好动态库了，现在去除gradle中的Native构建配置，否则会报

More than one file was found with OS independent path 'XXXX'

    //    externalNativeBuild {
    //        cmake {
    //            path "src/main/cpp/CMakeLists.txt"
    //            version "3.10.2"
    //        }
    //    }

MainActivity

  package com.arcsoft.functionregisterdemo;
  import androidx.appcompat.app.AppCompatActivity;
  import android.os.Bundle;
  import android.widget.TextView;
  public class MainActivity extends AppCompatActivity {
      // 加载动态库
      static {
         System.loadLibrary("hello-sdk");
      }
      @Override
      protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);   
         setContentView(R.layout.activity_main);
         TextView tv = findViewById(R.id.sample_text);
         tv.setText(hello());
         tv.append("\n\n");
         tv.append(dynamicRegisterFunction());
      }
      // 静态注册的函数
      public native String hello();      
      // 动态注册的函数
      public native String dynamicRegisterFunction();
  }

2.2.4 运行效果正常

操作方式：jniLibs目录下不保留任何动态库

日志如下，在加载动态库时，由于在几个库目录寻找所需的动态库没找到，于是报了

UnsatisfiedLinkError

couldn't find "libhello-sdk.so"

2020-03-26 15:55:09.448 26336-26336/com.arcsoft.functionregisterdemo E/AndroidRuntime: FATAL EXCEPTION: main
    Process: com.arcsoft.functionregisterdemo, PID: 26336
    java.lang.UnsatisfiedLinkError: dalvik.system.PathClassLoader[DexPathList[[zip file "/data/app/com.arcsoft.functionregisterdemo-6C3PyVyDJypXOtLP_dDykA==/base.apk"],nativeLibraryDirectories=[/data/app/com.arcsoft.functionregisterdemo 6C3PyVyDJypXOtLP_dDykA==/lib/arm64, /system/lib64, /system/vendor/lib64]]] couldn't find "libhello-sdk.so"
        at java.lang.Runtime.loadLibrary0(Runtime.java:1012)
        ....

操作方式：将

armeabi-v7a

arm64-v8a

日志如下，在加载动态库时，虽然库是存在的，但是ABI不对，于是报了

UnsatisfiedLinkError

"XXXX" is 32-bit instead of 64-bit

  2020-03-26 15:56:25.747 26517-26517/com.arcsoft.functionregisterdemo E/AndroidRuntime: FATAL EXCEPTION:
main
      Process: com.arcsoft.functionregisterdemo, PID: 26517
      java.lang.UnsatisfiedLinkError: dlopen failed: "/data/app/com.arcsoft.functionregisterdemo-EWDPPRqzg8u7sv1Dq30ZJA==/lib/arm64/libhello-sdk.so" is 32-bit instead of 64-bit
          at java.lang.Runtime.loadLibrary0(Runtime.java:1016)
          ....

操作方式：删除动态库文件再撤销删除

这可能是Android Studio的一个小问题，有时删除文件后撤销删除，文件虽然能够重新出现，但是大小为0。

日志如下，在加载动态库时，虽然库是存在的，但是文件大小为0，于是报了

UnsatisfiedLinkError

dlopen failed: file offset for the library "XXXX" >= file size: 0 >= 0

2020-03-26 15:56:58.114
26669-26669/com.arcsoft.functionregisterdemo E/AndroidRuntime: FATAL EXCEPTION: main
    Process: com.arcsoft.functionregisterdemo, PID: 26669
    java.lang.UnsatisfiedLinkError: dlopen failed: file offset for the library "/data/app/com.arcsoft.functionregisterdemo-PITl9rCd6FztSupEwwvjQA==/lib/arm64/libhello-sdk.so" >= file size: 0 >= 0
        at java.lang.Runtime.loadLibrary0(Runtime.java:1016)
        at java.lang.System.loadLibrary(System.java:1669)
        ....

操作方式：混淆Java代码

这也是导致crash的最常见的一种场景，一般情况下，我们在编译debug版apk时，是没有进行代码混淆的，而编译release版apk时会做混淆，这就会导致debug时程序运行正常，但一运行release版就crash。刚才在代码中，我们用静态注册和动态注册两种方式实现函数的注册，

对于JNI静态注册，JVM会根据Java函数的名称和签名寻找对应的native函数，若找不到，则报

java.lang.UnsatiesFiedLinkError

hello()

a()

java.lang.UnsatisfiedLinkError: No implementation found for java.lang.String com.arcsoft.functionregisterdemo.MainActivity.a() (tried Java_com_arcsoft_functionregisterdemo_MainActivity_a and Java_com_arcsoft_functionregisterdemo_MainActivity_a__)
              at com.arcsoft.functionregisterdemo.MainActivity.a(Native Method)

修改为原来的函数名，运行正常。

操作方式：混淆Java代码

混淆Java代码也可能会导致加载动态库时直接crash。

对于JNI动态注册，我们一般会在JNI_OnLoad中进行函数注册，此时native函数由函数指针确定，JVM根据指定的Java函数名和函数签名寻找对应的Java函数，若找不到，则会直接报错，错误内容一般如下：

JNI DETECTED ERROR IN APPLICATION: JNI NewGlobalRef called with pending exception java.lang.NoSuchMethodError: no static or non-static method "classSignature + . + functionName + FunctionSignature"

修改

build.gradle

buildTypes {
     debug {
         minifyEnabled true
         proguardFiles  'proguard-rules.pro'
     }
}

当前

proguard-rules.pro

    ......
    2020-03-26 15:58:39.046 26947-26947/com.arcsoft.functionregisterdemo A/ionregisterdem: java_vm_ext.cc:542] JNI DETECTED ERROR IN APPLICATION: JNI NewGlobalRef called with pending exception java.lang.NoSuchMethodError: no static or non-static method "Lcom/arcsoft/functionregisterdemo/MainActivity;.dynamicRegisterFunction()Ljava/lang/String;"
    ......

修改

proguard-rules.pro

MainActivity

-keepclasseswithmembers class com.arcsoft.functionregisterdemo.MainActivity{
   native ;
}

此时运行效果正常，需要注意的是，如果自己编写native函数，需要在native反射修改java中的field，还需要确保需要被反射的field不被混淆。

若以下其中一项不满足，就无法成功调用动态库：

动态库及其依赖库存在，且加载成功

Java函数和native函数关联成功（静态注册 or 动态注册）

当遇到错误时，日志中一般都有一些关键信息，能看到错误的具体原因，我们可以分析日志，了解排错方法。