NDK 开发(二，Android.mk梳理)

感谢原作者的辛勤劳作：

http://blog.csdn.net/wwj_748/article/details/30055915

http://blog.csdn.net/wzy_1988/article/details/39958727

   某些时候，项目的开发考虑到性能以及安全性的问题，编程语言的选择更多的是偏向底层的逻辑，可是为了追求效率选择使用了部分上层语言，这时就涉及到一个底层(native)和上层语言交流的问题(这里介绍google官方提供的解决方案：NDK)。

   Native Development Kit（NDK）是一系列工具的集合。它提供了一系列的工具，帮助开发者快速开发C/C++的动态库。然后通过JNI的方式完成java语言与C/C++库的交互以解决java语言在运行上的性能及安全问题。

   NDK内部提供及封装了一系列的操作，隐藏了内部具体的处理流程，对外提供了相关操作接口，开发人员通过使用Android.mk文件配置好相应的描述信息，交由NDK_Build系统处理就行。 

   

   Android.mk文件用来告知NDK Build 系统关于Source的信息。 Android.mk将是GNU Makefile的一部分，更确切地说，该文件其实就是一个小型的Makefile。由于该文件会被NDK的编译工具解析一次或者多次，因此应该尽量减少源码中声明变量，也不要假定任何东西不会在解析过程中定义。

   1，Android.mk文件的语法允许把源代码组织成模块，每个模块属于下列类型之一：

• APK程序：一般的Android程序，编译打包生成apk文件。
• JAVA库：java类库，编译打包生成jar包文件。
• C\C++应用程序：可执行的C/C++应用程序。
• C\C++静态库：编译生产C/C++静态库，并打包成.a文件。
• C\C++共享库：编译生成共享库，并打包成.so文件，有且只有共享库(动态库)才能被安装/复制到APK包中。

   2，可以在一个Android.mk中定义一个或多个modules. 也可以将同一份source加进多个modules.Build System帮我们处理了很多细节而不需要我们再关心。例如：你不需要在Android.mk中列出头文件和外部依赖文件。NDK Build System自动帮我们提供这些信息。这也意味着，当用户升级NDK后，你将可以受益于新的toolchain/platform而不必再去修改Android.mk.

   举例： 

     例如下面的文件：

     1. sources/test/hello.c

     2. sources/test/Android.mk

    其中“hello.c”是一个JNI共享库，实现返回“hello world”字符串的原生方法。因此，Android.mk文件内容如下：

1. LOCAL_PATH := $(call my-dir)  
2. include $(CLEAR_VARS)  
3. LOCAL_MODULE := hello  
4. LOCAL_SRC_FILES := hello.c  
5. include $(BUILD_SHARED_LIBRARY)  

     解释一下这几行代码：

     1. LOCAL_PATH := $(call my-dir) 

        一个Android.mk文件首先必须定义好LOCAL_PATH变量，用于在开发树中查找源文件。在这个例子中，宏函数my-dir由编译系统提供，用于返回当前路径（即包含Android.mk文件的目录）。

     2. include $(CLEAR_VARS)

        CLEAR_VARS由编译系统提供，指定让GNU MAKEFILE清除除了LOCAL_PATH变量外的许多LOCAL_***变量（例如：LOCAL_MODULE、LOCAL_SRC_FILES等）。这是非常有必要的，因为所有的编译文件都在同一个GUN MKAE执行环境中，所有的变量都是全局变量，不清除容易引起解析错误。

     3. LOCAL_MODULE := hello

         LOCAL_MODULE变量必须定义，用来标识在Android.mk文件描述的每一个模块。而且名称必须是唯一的，并且不能包含空格。编译系统会自动产生合适的前缀和后缀，比如一个被命名为hello的共享库模块，将会生成libhello.so文件。如果把库命名为libhello，编译系统将不会添加任何lib前缀，也会生成libhello.so文件。

     4. LOCAL_SRC_FILES := hello.c

         LOCAL_SRC_FILES变量必须包含将要编译打包进模块中的源代码文件。

     5. include $(BUILD_SHARED_LIBRARY)

         BUILD_SHARED_LIBRARY是编译系统提供的变量，指向一个GNU Makefile脚本（应该就是build/core目录下的shared_library.mk）,负责收集自从上次调用include $(CLEAR_VARS)以来，定义在LOCAL_***变量中的所有信息，并且决定编译什么，如何正确地去做，并根据其规则生成静态库。     

         BUILD_STATIC_LIBRARY：编译为静态库。
         BUILD_SHARED_LIBRARY ：编译为动态库(共享库) 。
         BUILD_EXECUTABLE：编译为Native C可执行程序。

     6. 解释一下Android.mk里变量定义字符":="

       “:=”类似于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_前缀，一个小例子：

?

1

2

3

4

5

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.

?

1

2

3

android-3-> Official Android 1.5system images 

android-4-> Official Android 1.6system images 

android-5-> Official Android 2.0system 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示例

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

#编译静态库 

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)