使用预编译库PREBUILT LIBRARY

2019-08-18

使用预编译库

NDK 支持使用预编译库(同时支持静态库和共享库)。此功能有以下两个主要用例:

  • 向第三方 NDK 开发者分发您自己的库(而不分发您的源代码)。
  • 使用您自己的库的预编译版本来提升编译速度。

本页将介绍如何使用预编译库。

声明预编译库

您必须将自己使用的每个预编译库声明为一个独立模块。为此,请执行以下步骤:

  1. 为模块提供名称。此名称不需要与预编译库本身的名称相同。
  2. 在模块的 Android.mk 文件中,将指向您提供的预编译库的路径分配到 LOCAL_SRC_FILES。指定 LOCAL_PATH 变量的值的相对路径。

    注意:请务必选择与您的目标 ABI 对应的预编译库版本。要详细了解如何确保库支持 ABI,请参阅为预编译库选择 ABI

  3. 根据您使用的是共享库 (.so) 还是静态库 (.a),添加 PREBUILT_SHARED_LIBRARY 或 PREBUILT_STATIC_LIBRARY

下面这个小例子假设预编译库 libfoo.so 与描述它的 Android.mk 文件位于同一个目录中。

    LOCAL_PATH := $(call my-dir)

    include $(CLEAR_VARS)
    LOCAL_MODULE := foo-prebuilt
    LOCAL_SRC_FILES := libfoo.so
    include $(PREBUILT_SHARED_LIBRARY)
    
 

在此示例中,模块名称与预编译库的名称相同。

编译系统会将您的预编译共享库副本置于 $PROJECT/obj/local 中,而将另一个提取的调试信息的副本置于 $PROJECT/libs/<abi> 中。在这里,$PROJECT 是您项目的根目录。

从其他模块引用预编译库

要从其他模块引用预编译库,请在与这些模块关联的 Android.mk 文件中,将该预编译库的名称指定为 LOCAL_STATIC_LIBRARIES 或 LOCAL_SHARED_LIBRARIES 变量。

例如,使用 libfoo.so 的模块说明可能类似于以下内容:

    include $(CLEAR_VARS)
    LOCAL_MODULE := foo-user
    LOCAL_SRC_FILES := foo-user.c
    LOCAL_SHARED_LIBRARIES := foo-prebuilt
    include $(BUILD_SHARED_LIBRARY)
    
 

此处,LOCAL_MODULE 是引用预编译库的模块的名称;LOCAL_SHARED_LIBRARIES 是预编译库本身的名称。

导出预编译库的标头

foo-user.c 中的代码取决于通常位于标头文件(如 foo.h)中的特定声明,而该标头文件是使用预编译库分配的。例如,foo-user.c 中可能会有类似于以下内容的一行代码:

    #include <foo.h>
   
 

在这种情况下,如果您编译 foo-user 模块,则需要提供标头及其指向编译器的 include 路径。完成此任务的一个简单方法是在预编译模块定义中使用导出内容。例如,只要标头 foo.h 位于与预编译模块关联的 include 目录下,您就可以按以下方式对其进行声明:

    include $(CLEAR_VARS)
    LOCAL_MODULE := foo-prebuilt
    LOCAL_SRC_FILES := libfoo.so
    LOCAL_EXPORT_C_INCLUDES := $(LOCAL_PATH)/include
    include $(PREBUILT_SHARED_LIBRARY)
    
 

此处的 LOCAL_EXPORT_C_INCLUDES 定义会确保编译系统导出指向预编译库的 include 目录的路径,针对依赖于它的模块将该路径附加到 LOCAL_C_INCLUDES 的值。

此操作可让编译系统查找必需的标头。

调试预编译库

建议您提供包含调试符号的预编译共享库。NDK 编译系统总是会从其安装到 $PROJECT/libs/<abi>/ 的那版库中提取符号,但您可以使用调试版本通过 ndk-gdb 进行调试。

为预编译库选择 ABI

请务必为您的目标 ABI 选择正确版本的预编译共享库。Android.mk 文件中的 TARGET_ARCH_ABI 变量可以将编译系统指向适当版本的库。

例如,假设您的项目包含库 libfoo.so 的以下两个版本:

    armeabi/libfoo.so
    x86/libfoo.so
    
 

以下代码段显示了如何使用 TARGET_ARCH_ABI,以便编译系统选择适当版本的库:

    include $(CLEAR_VARS)
    LOCAL_MODULE := foo-prebuilt
    LOCAL_SRC_FILES := $(TARGET_ARCH_ABI)/libfoo.so
    LOCAL_EXPORT_C_INCLUDES := $(LOCAL_PATH)/include
    include $(PREBUILT_SHARED_LIBRARY)
    
 

如果您将 armeabi 指定为 TARGET_ARCH_ABI 的值,编译系统便会使用位于 armeabi 目录中的 libfoo.so 版本。如果您将 x86 指定为 TARGET_ARCH_ABI 的值,编译系统便会使用 x86 目录中的版本。