Android.mk构建一个模块

在Android系统开发中，Android.mk是一个非常关键的文件，它用于定义如何构建一个模块，无论是库、可执行文件还是应用程序。这个文件通常位于项目的某个子目录中，为ndk-build或Android的构建系统提供必要的构建指令。

Android.mk文件中常见的变量和指令

1. LOCAL_PATH：这个变量用于定义当前处理的目录，通常设置为$(call my-dir)，以表示包含Android.mk文件的目录。
2. include $(CLEAR_VARS)：这行命令包含了一个预定义的Makefile，它清除了之前定义的许多LOCAL_XXX变量。这是在定义一个新的模块前常见的步骤，用于避免变量污染。
3. LOCAL_MODULE：定义了当前模块的名称，这个名字是唯一的，用于在构建系统中引用该模块。
4. LOCAL_SRC_FILES：列出了构建模块时需要编译的源文件。
5. LOCAL_STATIC_LIBRARIES：指定了模块依赖的静态库。
6. LOCAL_SHARED_LIBRARIES：指定了模块依赖的动态库（共享库）。
7. LOCAL_MODULE_TAGS：为模块指定标签，如optional，用于控制模块是否被包含在特定的构建中。
8. LOCAL_MODULE_CLASS：定义了模块的类别，例如APPS、SHARED_LIBRARIES等。
9. LOCAL_MODULE_PATH：定义了模块编译完成后的安装路径。
10. LOCAL_C_INCLUDES：指定编译源文件时需要包含的头文件目录。
11. LOCAL_LDLIBS：列出了编译时需要链接的系统库。
12. include $(BUILD_EXECUTABLE) 或 include $(BUILD_SHARED_LIBRARY)：这些语句告诉构建系统模块是可执行文件还是共享库，并触发相应的构建规则。
13. LOCAL_PREBUILT_STATIC_LIBRARY 和 LOCAL_PREBUILT_SHARED_LIBRARY：用于指定预构建的静态或动态库。

Android.mk文件支持条件编译、包含其他Makefile文件等高级功能，使得构建过程非常灵活和强大。它需要精确描述如何构建每个模块，包括它们的依赖关系、特定的编译标志、包含的源文件等。

为什么需要PREBUILT_XXXX_LIBRARY

在Android的构建系统中，如果你的项目依赖于第三方库文件，而这些库已经被预编译（即，你没有这些库的源代码，只有编译好的库文件），你需要使用PREBUILT_XXXX_LIBRARY标记来告诉构建系统如何处理这些预编译的库。这里的XXXX可以是SHARED_LIBRARY或STATIC_LIBRARY，取决于你的库是动态链接库（.so文件）还是静态链接库（.a文件）。

1. 区分源代码库与预编译库： Android的构建系统需要区分哪些库是需要从源代码编译的，哪些库是已经编译好的。对于预编译的库，构建系统不需要编译它们，只需要知道它们的位置，并在链接时使用它们。
2. 指定库文件的位置： 通过PREBUILT_XXXX_LIBRARY，可以明确告诉构建系统预编译库的具体位置。构建系统会使用这个位置来找到并链接这些库。
3. 简化依赖关系管理： 在大型项目中，可能会有多个模块依赖同一个预编译的第三方库。使用PREBUILT_XXXX_LIBRARY可以在项目的不同部分中统一管理这些依赖，避免重复指定库文件的路径，简化构建配置。
4. 优化构建过程： 如果使用预编译库，构建系统可以省去编译这些库的时间，从而加快整个项目的构建过程。

例如，如果你有一个预编译的动态库libexample.so，你可以在Android.mk中这样指定：

include $(CLEAR_VARS)
LOCAL_MODULE := libexample_prebuilt
LOCAL_SRC_FILES := path/to/libexample.so
include $(PREBUILT_SHARED_LIBRARY)

这段代码定义了一个名为libexample_prebuilt的模块，它指向了预编译的libexample.so库。当其他模块依赖于这个库时，它们可以通过libexample_prebuilt这个标识符来引用它。

使用PREBUILT_XXXX_LIBRARY让构建系统明确知道这些库文件已经是编译好的，不需要再次编译，同时还提供了库文件的位置信息，确保链接过程能够正确地找到并使用这些库。这是Android构建系统设计的一部分，旨在提供一种高效、可靠的方式来处理预编译的第三方库。

为什么需要BUILD_PREBUILT

在Android构建系统中，通常有两种方式来使用第三方库：

1. 源码方式：将第三方库的源代码包含在你的项目中，然后一起编译。这种方式使得第三方库在构建时会根据你的项目配置（如架构、编译器标志等）重新编译。
2. 预编译方式：当你没有第三方库的源码，或者不希望每次都重新编译这些库时，可以使用预编译的库。预编译的库是已经编译好的，可以直接链接到你的项目中。

使用PREBUILT_XXXX_LIBRARY（XXXX可以是STATIC或SHARED）告诉构建系统这个库已经编译好了，不需要再次编译，只需要在链接时将其包含进来。当你在Android.mk文件中设置了相关的PREBUILT_XXXX_LIBRARY变量后，使用include $(BUILD_PREBUILT)告诉构建系统应用这些设置。这行命令实际上引入了一个预定义的Makefile片段，这个片段包含了处理预编译库所需的规则和逻辑。

用BUILD_PREBUILT而不是直接引入源码编译有几个好处：

• 时间节省：避免了每次构建都重新编译库，尤其是对于大型第三方库来说，这可以大大减少构建时间。
• 一致性：确保库的版本一致，避免因不同编译环境或参数导致的差异。
• 简化依赖：对于使用者来说，不需要关心库的编译过程和依赖，只需要关注如何链接和使用。

通过这种方式，开发者可以有效地管理和使用第三方预编译库，使得构建过程更加高效和可控。

Android.mk示例分析

LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := NotePad
LOCAL_MODULE_TAGS := optional
LOCAL_MODULE_CLASS := APPS

ifeq ($(SOC_VENDOR), x)
    LOCAL_MODULE_PATH := $(TARGET_OUT)/preload
else ifeq ($(APP_USE_SYSTEM_EXT), true)
    LOCAL_MODULE_PATH := $(TARGET_OUT_SYSTEM_EXT)/partner
else
    LOCAL_MODULE_PATH := $(TARGET_OUT)/partner
endif

ifeq ($(ODM_VERTU_METASPACE), true)
    LOCAL_MODULE_PATH :=
endif

ifeq ($(RETAIL_MODE), true)
LOCAL_SRC_FILES := $(LOCAL_MODULE)-retail.apk
endif

LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
LOCAL_DEX_PREOPT := false

ifeq ($(TARGET_BUILD_VARIANT), user)
LOCAL_CERTIFICATE := releasekey
else
  LOCAL_CERTIFICATE := testkey
endif

include $(BUILD_PREBUILT)

设置LOCAL_PATH变量为当前目录。$(call my-dir)是一个内置函数，用于获取当前Android.mk文件所在的目录。

包含了CLEAR_VARS变量指向的文件，通常用于清除之前为新模块设置的所有变量，以避免设置冲突。

定义模块名为NotePad

指定模块标签为optional，意味着这个模块不是必须的，可以根据需求包含或不包含在最终产品中。

指定模块类别为应用程序(APPS)。

根据不同条件设置模块的安装路径。如果系统芯片供应商(SOC_VENDOR)是x，模块将安装到preload目录；如果设置了使用系统扩展(APP_USE_SYSTEM_EXT)，则安装到system_ext/partner目录；否则，默认安装到partner目录。

如果定义了ODM_VERTU_METASPACE并设置为true，那么LOCAL_MODULE_PATH将被清空，可能意味着这个模块不会被安装。

根据不同的特性标志选择不同的APK文件作为源文件。如果是零售模式(RETAIL_MODE)，选择-retail.apk版本；否则，选择默认的.apk文件。

设置模块后缀，通常为.apk

禁用DEX文件的预优化

根据不同的条件选择使用的签名密钥。使用releasekey或使用预签名(PRESIGNED)。

包含BUILD_PREBUILT，这个指令告诉构建系统如何处理预先构建的模块。