浅析Android.mk

 android.mk简介：

android.mk文件用来告知ndk build 系统关于source的信息。 android.mk将是gnu makefile的一部分，且将被build system解析一次或多次。

所以，请尽量少的在android.mk中声明变量，也不要假定任何东西不会在解析过程中定义。

android.mk文件语法允许我们将source打包成一个"modules". modules可以是：

静态库

动态库。

只有动态库可以被 install/copy到应用程序包(apk). 静态库则可以被链接入动态库。

可以在一个android.mk中定义一个或多个modules. 也可以将同一份source 加进多个modules.

build system帮我们处理了很多细节而不需要我们再关心。例如：你不需要在android.mk中列出头文件和外部依赖文件。

ndk build system自动帮我们提供这些信息。这也意味着，当用户升级ndk后，你将可以受益于新的toolchain/platform而不必再去修改android.mk.

android.mk语法：

首先看一个最简单的android.mk的例子：

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) 

每个android.mk文件必须以定义local_path为开始。它用于在开发tree中查找源文件。

宏my-dir则由build system提供。返回包含android.mk的目录路径。

include $(clear_vars)

clear_vars 变量由build system提供。并指向一个指定的gnu makefile，由它负责清理很多local_xxx.

例如：local_module, local_src_files, local_static_libraries等等。但不清理local_path.

这个清理动作是必须的，因为所有的编译控制文件由同一个gnu make解析和执行，其变量是全局的。所以清理后才能避免相互影响。

local_module := hello-jni

local_module模块必须定义，以表示android.mk中的每一个模块。名字必须唯一且不包含空格。

build system会自动添加适当的前缀和后缀。例如，foo，要产生动态库，则生成libfoo.so. 但请注意：如果模块名被定为：libfoo.则生成libfoo.so. 不再加前缀。

local_src_files := hello-jni.c

local_src_files变量必须包含将要打包如模块的c/c++ 源码。

不必列出头文件，build system 会自动帮我们找出依赖文件。

缺省的c++源码的扩展名为.cpp. 也可以修改，通过local_cpp_extension。

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可执行程序

一、android.mk文件的用途

一个android子项目中会存在一个或多个android.mk文件

1、单一的android.mk文件

直接参考ndk的sample目录下的hello-jni项目，在这个项目中只有一个android.mk文件

2、多个android.mk文件

如果需要编译的模块比较多，我们可能会将对应的模块放置在相应的目录中，这样，我们可以在每个目录中定义对应的android.mk文件（类似于上面的写法），最后，在根目录放置一个android.mk文件，内容如下：

include $(call all-subdir-makefiles)

只需要这一行就可以了，它的作用就是包含所有子目录中的android.mk文件

3、多个模块共用一个android.mk

这个文件允许你将源文件组织成模块，这个模块中含有：

-静态库(.a文件)
-动态库(.so文件)

只有共享库才能被安装/复制到您的应用软件（apk）包中

include $(build_static_library)，编译出的是静态库
include $(build_shared_library)，编译出的是动态库

二、自定义变量

以下是在 android.mk中依赖或定义的变量列表，可以定义其他变量为自己使用，但是ndk编译系统保留下列变量名：

-以 local_开头的名字（例如 local_module）
-以 private_, ndk_ 或 app_开头的名字（内部使用）
-小写名字（内部使用，例如‘my-dir'）

如果为了方便在 android.mk 中定义自己的变量，建议使用 my_前缀，一个小例子：

my_sources := foo.c 
ifneq ($(my_config_bar),) 
my_sources += bar.c 
endif 
local_src_files += $(my_sources) 

注意：‘:='是赋值的意思；'+='是追加的意思；‘$'表示引用某变量的值。

三、gnu make系统变量

这些 gnu make变量在你的 android.mk 文件解析之前，就由编译系统定义好了。注意在某些情况下，ndk可能分析 android.mk 几次，每一次某些变量的定义会有不同。

（1）clear_vars: 指向一个编译脚本，几乎所有未定义的 local_xxx 变量都在"module-description"节中列出。必须在开始一个新模块之前包含这个脚本：include$(clear_vars)，用于重置除local_path变量外的，所有local_xxx系列变量。

（2）build_shared_library: 指向编译脚本，根据所有的在 local_xxx 变量把列出的源代码文件编译成一个共享库。

注意，必须至少在包含这个文件之前定义 local_module 和 local_src_files。

（3）build_static_library: 一个 build_shared_library 变量用于编译一个静态库。静态库不会复制到的apk包中，但是能够用于编译共享库。

示例：include $(build_static_library)

注意，这将会生成一个名为 lib$(local_module).a 的文件

（4）target_arch: 目标 cpu平台的名字

（5）target_platform: android.mk 解析的时候，目标 android 平台的名字.详情可考/development/ndk/docs/stable- apis.txt.

android-3 -> official android 1.5 system images 
android-4 -> official android 1.6 system images 
android-5 -> official android 2.0 system images 

（6）target_arch_abi: 暂时只支持两个 value，armeabi 和 armeabi-v7a。。

（7）target_abi: 目标平台和 abi 的组合，

四、模块描述变量

下面的变量用于向编译系统描述你的模块。应该定义在'include $(clear_vars)'和'include $(build_xxxxx)'之间。$(clear_vars)是一个脚本，清除所有这些变量。

（1）local_path: 这个变量用于给出当前文件的路径。

必须在 android.mk 的开头定义，可以这样使用：local_path := $(call my-dir)

如当前目录下有个文件夹名称 src，则可以这样写 $(call src)，那么就会得到 src 目录的完整路径

这个变量不会被$(clear_vars)清除，因此每个 android.mk 只需要定义一次(即使在一个文件中定义了几个模块的情况下)。

（2）local_module: 这是模块的名字，它必须是唯一的，而且不能包含空格。

必须在包含任一的$(build_xxxx)脚本之前定义它。模块的名字决定了生成文件的名字。

（3）local_src_files: 这是要编译的源代码文件列表。

只要列出要传递给编译器的文件，因为编译系统自动计算依赖。注意源代码文件名称都是相对于 local_path的，你可以使用路径部分，例如：

local_src_files := foo.c toto/bar.c\

hello.c

文件之间可以用空格或tab键进行分割,换行请用"\"

如果是追加源代码文件的话，请用local_src_files +=

注意：可以local_src_files := $(call all-subdir-java-files)这种形式来包含local_path目录下的所有java文件。

（4）local_c_includes: 可选变量，表示头文件的搜索路径。

默认的头文件的搜索路径是local_path目录。

（5）local_static_libraries: 表示该模块需要使用哪些静态库，以便在编译时进行链接。

（6）local_shared_libraries: 表示模块在运行时要依赖的共享库（动态库），在链接时就需要，以便在生成文件时嵌入其相应的信息。

注意：它不会附加列出的模块到编译图，也就是仍然需要在application.mk 中把它们添加到程序要求的模块中。

（7）local_ldlibs: 编译模块时要使用的附加的链接器选项。这对于使用‘-l'前缀传递指定库的名字是有用的。

例如，local_ldlibs := -lz表示告诉链接器生成的模块要在加载时刻链接到/system/lib/libz.so

可查看 docs/stable-apis.txt 获取使用 ndk发行版能链接到的开放的系统库列表。

(8)local_module_path 和 local_unstripped_path

在 android.mk 文件中， 还可以用local_module_path 和local_unstripped_path指定最后的目标安装路径.

不同的文件系统路径用以下的宏进行选择：
target_root_out：表示根文件系统。
target_out：表示 system文件系统。
target_out_data：表示 data文件系统。
用法如：local_module_path :=$(target_root_out)
至于local_module_path 和local_unstripped_path的区别，暂时还不清楚。

（9）local_jni_shared_libraries：定义了要包含的so库文件的名字，如果程序没有采用jni，不需要

local_jni_shared_libraries := libxxx 这样在编译的时候，ndk自动会把这个libxxx打包进apk； 放在youapk/lib/目录下

五、ndk提供的函数宏

gnu make函数宏，必须通过使用'$(call )'来调用，返回值是文本化的信息。

（1）my-dir:返回当前 android.mk 所在的目录的路径，相对于 ndk 编译系统的顶层。这是有用的，在 android.mk 文件的开头如此定义：

local_path := $(call my-dir)

（2）all-subdir-makefiles: 返回一个位于当前'my-dir'路径的子目录中的所有android.mk的列表。

例如，某一子项目的目录层次如下：

src/foo/android.mk
src/foo/lib1/android.mk
src/foo/lib2/android.mk

如果 src/foo/android.mk 包含一行：

include $(call all-subdir-makefiles)

那么它就会自动包含 src/foo/lib1/android.mk 和 src/foo/lib2/android.mk。

这项功能用于向编译系统提供深层次嵌套的代码目录层次。

注意，在默认情况下，ndk 将会只搜索在 src/*/android.mk 中的文件。

（3）this-makefile: 返回当前makefile 的路径(即这个函数调用的地方)

（4）parent-makefile: 返回调用树中父 makefile 路径。即包含当前makefile的makefile 路径。

（5）grand-parent-makefile：返回调用树中父makefile的父makefile的路径

六、 android.mk示例

#编译静态库 
local_path := $(call my-dir) 
include $(clear_vars) 
local_module = libhellos 
local_cflags = $(l_cflags) 
local_src_files = hellos.c 
local_c_includes = $(includes) 
local_shared_libraries := libcutils 
local_copy_headers_to := libhellos 
local_copy_headers := hellos.h 
include $(build_static_library) 
#编译动态库 
local_path := $(call my-dir) 
include $(clear_vars) 
local_module = libhellod 
local_cflags = $(l_cflags) 
local_src_files = hellod.c 
local_c_includes = $(includes) 
local_shared_libraries := libcutils 
local_copy_headers_to := libhellod 
local_copy_headers := hellod.h 
include $(build_shared_library) 
#使用静态库 
local_path := $(call my-dir) 
include $(clear_vars) 
local_module := hellos 
local_static_libraries := libhellos 
local_shared_libraries := 
local_ldlibs += -ldl 
local_cflags := $(l_cflags) 
local_src_files := mains.c 
local_c_includes := $(includes) 
include $(build_executable) 
#使用动态库 
local_path := $(call my-dir) 
include $(clear_vars) 
local_module := hellod 
local_module_tags := debug 
local_shared_libraries := libc libcutils libhellod 
local_ldlibs += -ldl 
local_cflags := $(l_cflags) 
local_src_files := maind.c 
local_c_includes := $(includes) 
include $(build_executable)