Android.mk 语法浅析

概述

Android 底层代码中，使用 Android.mk 文件来进行编译代码，类似于我们平常接触的 gradle。底层的编译，由一套 NDK Build 系统构成，而 mk 文件用来告知 NDK 关于 Source 的信息。

本质上，Android.mk只是GNU MakeFile的一个片段，编译系统在编译的时候有可能会多次解释Android.mk文件，所以要尽量少在脚本里面申明变量，也不要假设任何没有在脚本中定义的条件。

GNU 是什么？
Unix 系统被发明之后，大家用的很爽。但是后来开始收费和商业闭源了。一个叫 RMS 的大叔觉得很不爽，于是发起 GNU 计划，模仿 Unix 的界面和使用方式，从头做一个开源的版本。经过一些列的演变，其就是后来的Linux。

1. 模块

mk 语法允许将 Source 打包成一个模块，模块又分为：

• 动态库：可以被 install/copy 到应用程序包（apk）
• 静态库：可以被链接入动态库

一个 mk 中能定义一个或者多个模块，也可以将同一份 Source 加入到多个模块中。

2. 示例解析

看一个简单的例子：

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE    := hello-jni
LOCAL_SRC_FILES := hello-jni.c
include $(BUILD_SHARED_LIBRARY)

• LOCAL_PATH := $(call my-dir)
  mk 文件须由 LOCAL_PATH 开始，用于在开发 tree 中查找源文件，宏 my-dir 则由 Build System 提供，返回包含 Android.mk 的目录路径。

• include $(CLEAR_VARS)
  CLEAR_VARS 变量由 Build System 提供，并指向一个指定的 GNU Makefile，由它负责清理很多LOCAL_xxx。可以理解为，在每次 mk 编译之前，需要执行 CLEAR_VARS 的 mk 指令集，用于清理、重置环境，这个清理动作是必须的，因为所有的编译控制文件由同一个GNU Make解析和执行，其变量是全局的，所以清理后才能避免相互影响。

• LOCAL_MODULE := hello-jni
  模块的名称，必须定义，名字要唯一不能带空格。Build System 会自动添加适当的前缀和后缀。例如，foo 要产生动态库，则生成 libfoo.so。 但请注意：如果模块名被定为：libfoo，则生成libfoo.so，不再加前缀。

• LOCAL_SRC_FILES := hello-jni.c
  定义需要编译打包的 C/C++ 源码。不必列出头文件。

• include $(BUILD_SHARED_LIBRARY)

  BUILD_SHARED_LIBRARY 是 Build System 提供的一个变量，指向一个 GNU Makefile Script。
  它负责收集自从上次调用 include $(CLEAR_VARS) 后的所有 LOCAL_XXX 信息，并决定编译成什么类型的库。

  • BUILD_STATIC_LIBRARY：编译为静态库
  • BUILD_SHARED_LIBRARY：编译为动态库
  • BUILD_EXECUTABLE：编译为Native C可执行程序

3. mk 其他变量

• LOCAL_MODULE_TAGS
  LOCAL_MODULE_TAGS := optional
  指定在什么类型的版本下编译：

  • user/debug/eng: 指定该模块只在 user 版本下才编译（makePRODUCT-XXX-user）
  • optional: 在所有版本下都会编译（貌似在tests下不会，这点待确认）

• LOCAL_PRIVATE_PLATFORM_APIS
  LOCAL_PRIVATE_PLATFORM_APIS := true
  设置后，会使用 sdk 的 hide 的 api 來编译

• LOCAL_SDK_VERSION
  LOCAL_SDK_VERSION := current
  若是在 Android.mk 中添加该选项，则编译时会忽略源码隐藏的API，故在使用源码的 hide api 后会导致编译失败
  API 的分类：

  • internal api
    翻译为内部API，理解为供sdk内部使用的API。这类接口最初打算就是不对外公开的
  • hide api
    在源码中看到使用@hide 标记的方法或类，就是hide的。这类接口本意是要公开，但是当前阶段仍然不稳定或未开发完成。所以暂时不推荐开发者调用。但可以使用
  • 普通api
    第三方app也可以使用的api

• LOCAL_CERTIFICATE
  LOCAL_CERTIFICATE := platform
  指定用的是什么签名，如上用的是 platform 签名。

• LOCAL_USE_AAPT2
  LOCAL_USE_AAPT2 := true
  aapt 是Android Asset Packaging Tool的缩写，是编译和打包资源的工具。而aapt2是在aapt上做了优化。

• LOCAL_JNI_SHARED_LIBRARIES
  LOCAL_JNI_SHARED_LIBRARIES := libbluetooth_jni
  声明 mk 要使用到的共享 JNI 库的名称

• LOCAL_JAVA_LIBRARIES
  LOCAL_JAVA_LIBRARIES := javax.obex telephony-common services.net
  指定依赖的共享java类库，这个是编译时依赖，最终不会打包

• LOCAL_STATIC_JAVA_LIBRARIES

LOCAL_STATIC_JAVA_LIBRARIES := \
        com.android.vcard \
        bluetooth.cc\
        services.net \
        libprotobuf-java-lite \

指定依赖的静态java类库，最终会打包到apk里面。引用多个的时候，可以像上面那样写。

• LOCAL_STATIC_ANDROID_LIBRARIES

LOCAL_STATIC_ANDROID_LIBRARIES := \
    $(ANDROID_SUPPORT_DESIGN_TARGETS) \
    android-support-transition \
    android-support-v13 \
    android-support-v7-appcompat \
    android-support-v7-cardview \
    android-support-v7-recyclerview \
    android-support-v7-palette \
    android-support-v4 \

声明要调用 android 的包，像 v7,v13 包

• LOCAL_ANNOTATION_PROCESSORS

LOCAL_ANNOTATION_PROCESSORS := \
        bt-androidx-annotation-nodeps \
        bt-androidx-room-common-nodeps \
        bt-androidx-room-compiler-nodeps \
        bt-androidx-room-migration-nodeps \
        bt-antlr4-nodeps \
        bt-apache-commons-codec-nodeps \
        bt-auto-common-nodeps \
        bt-javapoet-nodeps \
        bt-kotlin-metadata-nodeps \
        bt-sqlite-jdbc-nodeps \
        bt-jetbrain-nodeps \
        guava-21.0 \

声明用到的注解

• LOCAL_ANNOTATION_PROCESSOR_CLASSES

LOCAL_ANNOTATION_PROCESSOR_CLASSES := \
        androidx.room.RoomProcessor

声明用到的注解器

• LOCAL_PROTOC_OPTIMIZE_TYPE
  protocol 相关配置

• LOCAL_REQUIRED_MODULES
  LOCAL_REQUIRED_MODULES := SoundRecorder
  指定依赖的模块。一旦本模块被安装，通过此变量指定的模块也将被安装

• LOCAL_PROGUARD_ENABLED

LOCAL_PROGUARD_ENABLED := disabled
LOCAL_PROGUARD_ENABLED := full obfuscation

混淆配置，默认为full obfuscation，全代码混淆，disabled不开启。

• LOCAL_PROGUARD_FLAG_FILES
  LOCAL_PROGUARD_FLAG_FILES := proguard.flags
  混淆规则配置文件

---

技术酱专注 Android 技术，工作日不定时推送新鲜文章，如果你有好的文章想和大家分享（有稿费哦），欢迎关注投稿！

技术酱