Android mk/bp构建工具介绍

2024-11-24 09:18:26

   零. 前言

由于Bluedroid的介绍文档有限，以及对Android的一些基本的知识需要了(Android 四大组件/AIDL/Framework/Binder机制/JNI/HIDL等)，加上需要掌握的语言包括Java/C/C++等，加上网络上其实没有一个完整的介绍Bluedroid系列的文档，所以不管是蓝牙初学者还是蓝牙从业人员，都有不小的难度，学习曲线也相对较陡，所以我有了这个想法，专门对Bluedroid做一个系统性的介绍，尽可能的涵盖所有内容。

-------------------------------------------------------------------------------------------------------------------------

蓝牙视频教程(跟韦东山老师合作), 其中专题21就是专门针对Bluedroid做的系统介绍

https://item.taobao.com/item.htm?spm=a1z10.1-c-s.w4004-22329603896.20.5aeb41f98e267j&id=693788592796

--------------------------------------------------------------------------------------------------------------------------

一. Android mk

1. 介绍

Android.mk是Android提供的一种makefile文件，用来指定诸如编译生成so库名、引用的头文件目录、需要编译的.c/.cpp文件和.a静态库文件等。要掌握jni，就必须熟练掌握Android.mk的语法规范。

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

LOCAL_PATH变量指定了该.mk的路径，$(call my-dir)调用NDK内部的函数获得当前.mk文件的路径

include $(CLEAR_VARS)清空了除了LOCAL_PATH之外的所有LOCAL_xxx变量的值

省略号中间就是对于模块参数的设置，主要包括：模块名字、模块源文件、模块类型、编译好的模块存放位置、以及编译的平台等

include $(BUILD_xxx_xxx)执行NDK的默认脚本，它会收集include $(CLEAR_VARS)脚本后所有定义的LOCAL_xxx变量，然后根据它们来生成模块。

2. Android.mk语法详解

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_MODULE_PATH :=$(TARGET_ROOT_OUT) 指定最后生成的模块的目标地址

TARGET_ROOT_OUT:根文件系统，路径为out/target/product/generic/root

TARGET_OUT:system文件系统，路径为out/target/product/generic/system

TARGET_OUT_DATA:data文件系统，路径为out/target/product/generic/data

除了上面的这些，NDK还提供了很多其他的TARGET_XXX_XXX变量，用于将生成的模块拷贝到输出目录的不同路径

默认是TARGET_OUT

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

BUILD_PREBUILT ：该模块已经预先编译

NDK还定义了很多其他的BUILD_XXX_XXX变量，它们用来指定模块的生成方式。

三. Android.mk实战

1.编译静态库

首先我们把vendor下创建一个Study的目录，然后再Study创建一个test1的目录，tree如下：

我们的目标是把test.c编译成一个静态库

test.c代码如下：

#include <stdio.h>

int test(void)
{
	printf("hello Androoid.mk\r\n");
	return 0;
}

Android.mk代码如下：

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_SRC_FILES := test.c
LOCAL_MODULE := test1
include $(BUILD_STATIC_LIBRARY)

编译方法：

方法1：在android 跟目录下敲指令：make test1

方法2：在vendor/Study/test1目录下敲指令mm

注意：两个方法都需要先source build/envsetup.sh -> lunch选择41

test.a生成在out/target/product/rk3399_roc_pc_plus/obj_arm/STATIC_LIBRARIES/test1_intermediates/test1.a

NOTED：我们发现生成的并不是libtest1.a，而是test1.a，这个要注意下

2.编译动态库

首先我们把vendor下创建一个Study的目录，然后再Study创建一个test2的目录，tree如下：

我们的目标是把test.c编译成一个静态库

test.c代码如下：

#include <stdio.h>

int test(void)
{
	printf("hello Androoid.mk\r\n");
	return 0;
}

Android.mk代码如下：

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

编译方法：

方法1：在android 跟目录下敲指令：make test2

方法2：在vendor/Study/test2目录下敲指令mm

注意：两个方法都需要先source build/envsetup.sh -> lunch选择41

test.so生成在out/target/product/rk3399_roc_pc_plus/obj_arm/SHARED_LIBRARIES/test2_intermediates/test2.so

NOTED：我们发现生成的并不是libtest2.so，而是test2.so，这个要注意下

二. Android bp

1. Android.bp概念

Android.bp 文件首先是 Android 系统的一种编译配置文件，是用来代替原来的 Android.mk文件的。在Android7.0 以前，Android 都是使用 make 来组织各模块的编译，对应的编译配置文件就是 Android.mk。

在 Android7.0 开始，Google 引入了 ninja 和 kati 来编译，为啥引入 ninja？因为随着 Android 越来越庞大，module 越来越多，编译时间也越来越久，而使用 ninja 在编译的并发处理上较 make 有很大的提升。Ninja 的配置文件就是Android.bp，Android 系统使用 Blueprint 和 Soong 工具来解析 Android.bp 转换生成 ninja文件。为了兼容老的 mk 配置文件，Android 当初也开发了 Kati 工具来转换 mk 文件生成ninja，目前 Android Q 里边，还是支持 Android.mk 方式的。相信在将来的版本中，会彻底让 mk 文件废弃，同时 Kati 也就淘汰了，只保留 bp 配置方式，所以我们要提前学习bp。

这里涉及到Ninja, kati, Soong, bp概念，接下来分别简单介绍一下。

Ninja

ninja是一个编译框架，会根据相应的ninja格式的配置文件进行编译，但是ninja文件一般不会手动修改，而是通过将Android.bp文件转换成ninja格文件来编译。

Android.bp

Android.bp的出现就是为了替换Android.mk文件。bp跟mk文件不同，它是纯粹的配置，没有分支、循环等流程控制，不能做算数逻辑运算。如果需要控制逻辑，那么只能通过Go语言编写。

Soong

Soong类似于之前的Makefile编译系统的核心，负责提供Android.bp语义解析，并将之转换成Ninja文件。Soong还会编译生成一个androidmk命令，用于将Android.mk文件转换为Android.bp文件，不过这个转换功能仅限于没有分支、循环等流程控制的Android.mk才有效。

Blueprint

Blueprint是生成、解析Android.bp的工具，是Soong的一部分。Soong负责Android编译而设计的工具，而Blueprint只是解析文件格式，Soong解析内容的具体含义。Blueprint和Soong都是由Golang写的项目，从Android 7.0，prebuilts/go/目录下新增Golang所需的运行环境，在编译时使用。

Kati

kati是专为Android开发的一个基于Golang和C++的工具，主要功能是把Android中的Android.mk文件转换成Ninja文件。代码路径是build/kati/，编译后的产物是ckati。

重要的事情说三遍，Android.mk可以引用Android.bp中的模块，反之Android.bp不能引用Android.mk中的模块。

重要的事情说三遍，Android.mk可以引用Android.bp中的模块，反之Android.bp不能引用Android.mk中的模块。

重要的事情说三遍，Android.mk可以引用Android.bp中的模块，反之Android.bp不能引用Android.mk中的模块。

2. Android mk转换成Android bp

1.安装androidmk 工具

我们以rk3399来举例说明

source build/envsetup.sh

lunch rk3399_roc_pc_plus-userdebug

make androidmk

生成androidmk转换工具，路径为：/out/soong/host/linux-x86/bin/androidmk

2.转换

androidmk Android.mk > Android.bp

3.Android bp语法

1.编译静态库

首先我们把vendor下创建一个Study的目录，然后再Study创建一个test1的目录，tree如下：

我们的目标是把test.c编译成一个静态库

test.c代码如下：

#include <stdio.h>

int test(void)
{
	printf("hello Androoid.mk\r\n");
	return 0;
}

Android.bp代码如下：

cc_library_static {
    name: "test3",
    srcs: ["test.c"],
}

编译方法：

方法1：在android 跟目录下敲指令：make test3

方法2：在vendor/Study/test3目录下敲指令mm

注意：两个方法都需要先source build/envsetup.sh -> lunch选择41

test.a生成在out/target/product/rk3399_roc_pc_plus/obj_arm/STATIC_LIBRARIES/test3_intermediates/test3.a

NOTED：我们发现生成的并不是libtest3.a，而是test3.a，这个要注意下

其中cc_library_static就是编译成c/c++ 静态库，可以有以下类型

name就是模组的名称

srcs就是源文件

2.编译动态库

首先我们把vendor下创建一个Study的目录，然后再Study创建一个test2的目录，tree如下：

我们的目标是把test.c编译成一个静态库

test.c代码如下：

#include <stdio.h>

int test(void)
{
	printf("hello Androoid.mk\r\n");
	return 0;
}

Android.bp代码如下：

cc_library_shared {
    name: "test4",
    srcs: ["test.c"],
}

编译方法：

方法1：在android 跟目录下敲指令：make test4

方法2：在vendor/Study/test4目录下敲指令mm

注意：两个方法都需要先source build/envsetup.sh -> lunch选择41

test.so生成在out/target/product/rk3399_roc_pc_plus/obj_arm/SHARED_LIBRARIES/test4_intermediates/test4.so

NOTED：我们发现生成的并不是libtest4.so，而是test4.so，这个要注意下

上一篇：[Unity Demo]从零开始制作空洞骑士Hollow Knight第二十集：制作专门渲染HUD的相机HUD Camera和画布HUD Canvas


下一篇：IDEA2023版本配置项目全局编码