一、介绍
android
.mk是android提供的一种makefile文件,用来指定诸如编译
==生成
==so库名、引用的头文件目录、需要编译的
.c
/.cpp文件和
.a静态库文件等,掌握jni,就必须熟练掌握android
.mk的语法规则。由于这个文件会被NDK的编译工具解析多次,因此尽量减少在源码中声明变量,因为这些变量可能会被多次定义从而影响后面的解析。
### 这个文件的语法允许把源代码组织成模块,每个模块属于下列类型之一。
- APK程序:一般的Android程序,编译打包生成apk文件
- java库:Java类库,编译打包生成jar包文件
- c
/c
++应用程序:可执行的c
/c
+应用程序
- c
/c
++静态库:编译生产c
/c
++静态库,并打包成
.a文件
- c
/c
++共享库:编译成共享库,并打包
.so文件,有且只有共享库才能被安装
/赋值到apk中。
#### 简单的举个栗子
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_MODULES
:=hello
4 LOCAL_SRC_FILES
:=hello
.c
5 include $
(BUILD_SHARE_LIBRARY
)
>1句:一个Android
.mk文件首先必须定义好LOCAL_PATH变量,用于在开发树查找源文件,在这个列子中,宏函数由系统提供,用于返回当前路径(包含Android
.mk文件的目录)
>2句:GUN MAKEFILE清除LOCAL_
***变量
(除了LOCAL_PATH
).这个是由必要的,所有的编译文件在GUN MAKE 执行环境中,所有的变量都是全局变量,不清楚会导致解析错误。
>3句 :这个是必须的,用来标识在Android
.mk文件描述的每一个模块。而库的名字是必须的唯一的,并且不能包含空格,系统会自动产生合适的前缀和后缀,比如:一个被命名为hello的共享库模块,将会生成一个hello
.so文件,如果把库命名成libhello,编译系统将不会添加任何前缀,还是libhello
.os
>4句 :加载一些编译模块使用的源文件,还可以LOCAL _SRC_FILES
:=$
(all
-subdir
-java
-files
,src
)\ 这个意思加载当前目录下所有 java 文件。
>5句: 指向一个GUNMAKEFIL的脚本,
(应该是builder
/core目录下的shared_libbrary
.mk
),负责收集自从上次调用
include(clear_vars
)以来,定义在local_\
*\
*变量中的信息,并且决定编译什么,如何正确的做,并根据规则生成动态库。
解释一下Android
.mk里变量定义字符“
:=”类似于宏,即在定义出明确展开,完成文本替换,
+=是追加的意思,$引用变量的意思
### 多个Android
.mk文件
如果需要编译的模块较多,我们将可能将对应的模块放在对应的目录中,这样,我们可以在对应的目录之中定义对应Android
.mk文件,最后在一个根目录放置一个Android
.mk文件,添加include $
(call all
-subdir
-makefiles
)
#### 多个模块共用一个Android
.mk
这个文件允许你将源文件组织成模块,这个模块有
- 静态库(
.a文件)
- 动态库(共享库
--.so文件)
include $
(BUILD_STATIC_LIBRARY
),编译的是静态库
include $
(BUILD_SHARE_LIBRARY
),编译的是分享库
### GNU Make系统变量
1、这些 GNU Make变量在你的 Android
.mk 文件解析之前,就由编译系统定义好了。注意在某些情况下,NDK可能分析 Android
.mk 几次,每一次某些变量的定义会有不同。
2、BUILD_SHARED_LIBRARY
: 指向编译脚本,根据所有的在 LOCAL_XXX 变量把列出的源代码文件编译成一个共享库。
注意,需要在这行代码之前定义 LOCAL_MODULE 和 LOCAL_SRC_FILES
3、BUILD_STATIC_LIBRARY
: 用于编译一个静态库。静态库不会复制到的APK包中,但是能够用于编译共享库。
示例:include $
(BUILD_STATIC_LIBRARY
)
注意,这将会生成一个名为 lib$
(LOCAL_MODULE
).a 的文件
4、TARGET_ARCH
: 目标 CPU平台的名字
5、TARGET_ABI
: 目标平台和 ABI 的组合
### 自定义变量
以下是在 Android
.mk中依赖或定义的变量列表,可以定义其他变量为自己使用,但是NDK编译系统保留下列变量名:
以 LOCAL_开头的名字(例如 LOCAL_MODULE)
以 PRIVATE_
, NDK_ 或 APP_开头的名字(内部使用)
小写名字(内部使用,例如‘my
-dir’)
如果为了方便在 Android
.mk 中定义自己的变量,建议使用 MY_前缀,一个小例子:
1 MY_SOURCES
:= foo
.c
2 ifneq
($
(MY_CONFIG_BAR
),)
3 MY_SOURCES
+= bar
.c
4 endif
5 LOCAL_SRC_FILES
+= $
(MY_SOURCES
)
注意:‘
:=’是赋值的意思;’
+=’是追加的意思;‘$’表示引用某变量的值。
### 模块描述变量
下面的变量用于向系统描述我们自己的模块,应该定义在include $
(CLEAR_VARS
)和include $
(BUILD_
***)之间。
LOCAL_PATH:这个变量用于给出当前文件的路径,必须在Android
.mk的开头定义,可以这样使用:LOCAL_PATH
:= $
(call my
-dir
),这样这个变量不会被\$
(CLEAR_VARS
)清除,因为每个Android
.mk只需要定义一次(即使一个文件中定义了多个模块的情况下)。
LOCAL_MODULE:当前模块的名称,这个名称应当是唯一的,并且不能包含空格。模块间的依赖关系就是通过这个名称来引用的。
LOCAL_MODULE_CLASS:标识所编译模块最后放置的位置。
ETC表示放置在
/system
/etc
.目录下,
APPS表示放置在
/system
/app目录下,
SHARED_LIBRARIES表示放置在
/system
/lib目录下
如果具体指定,则编译的模块不会放到编译系统中,最后会在out对应product的obj目录下的对应目录中。
LOCAL_SRC_FILES:这是要编译的源代码文件列表。只要列出要传递给编译器的文件即可,编译系统会自动计算依赖关系。源代码文件路径都是相相对于LOCAL_PATH的,因此可以使用相对路径进行描述。
只要列出要传递给编译器的文件,编译系统自动计算依赖。注意源代码文件名称都是相对于 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文件。
LOCAL_JAVA_LIBRARIES:当前模块依赖的Java共享库,也叫Java动态库。例如framework
.jar包。
LOCAL_STATIC_JAVA_LIBRARIES:当前模块依赖的Java静态库,在Android里,导入的jar包和引用的第三方工程都属于Java静态库。
LOCAL_STATIC_LIBRARIES:指定该模块需要使用哪些静态库,以便在编译时进行链接。
LOCAL_SHARED_LIBRARIES:指定模块在运行时要依赖的共享库(动态库),在链接时就需要,以便在生成文件时嵌入其相应的信息。
LOCAL_C_INCLUDES: 可选变量,表示头文件的搜索路径。 默认的头文件的搜索路径是LOCAL_PATH目录。
LOCAL_CFLAGS:提供给C
/C
++编译器的额外编译参数。
LOCAL_PACKAGE_NAME:当前APK应用的名称。
LOCAL_CERTIFICATE:签署当前应用的证书名称。
LOCAL_MODULE_TAGS:当前模块所包含的标签,一个模块可以包含多个标签。标签的值可能是eng、user、debug、development、optional。其中,optional是默认标签。
LOCAL_DEX_PREOPT:apk的odex优化开关,默认是
false。
LOCAL_LDLIBS
: 编译模块时要使用的附加的链接器选项。这对于使用‘
-l’前缀传递指定库的名字是有用的。
例如,LOCAL_LDLIBS
:= -lz表示告诉链接器生成的模块要在加载时刻链接到
/system
/lib
/libz
.so
可查看 docs
/STABLE
-APIS
.TXT 获取使用 NDK发行版能链接到的开放的系统库列表。
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的区别,暂时还不清楚。
LOCAL_JNI_SHARED_LIBRARIES:定义了要包含的so库文件的名字,如果程序没有采用jni,不需要
LOCAL_JNI_SHARED_LIBRARIES
:= libxxx 这样在编译的时候,NDK自动会把这个libxxx打包进apk; 放在youapk
/lib
/目录下
除此之外,Build系统中还定义了一些函数方便在Android
.mk中使用,包括:
$
(call my
-dir
):获取当前文件夹的路径。
$
(call all
-java
-files
-under
, ):获取指定目录下的所有java文件。
$
(call all
-c
-files
-under
, ):获取指定目录下的所有c文件。
$
(call all
-Iaidl
-files
-under
, ):获取指定目录下的所有AIDL文件。
$
(call all
-makefiles
-under
, ):获取指定目录下的所有Make文件。
#### NDK提供的函数宏
GNU Make函数宏,必须通过使用’$
(call
)’来调用,返回值是文本化的信息。
my
-dir
:返回当前 Android
.mk 所在的目录的路径,相对于 NDK 编译系统的顶层。在 Android
.mk 文件的开头如此定义: LOCAL_PATH
:= $
(call my
-dir
)
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