Android.bp入门指南之浅析Android.bp文件

简介: 【2月更文挑战第6天】

image.png

@[toc]

Android.bp文件是什么?

Android.bp 文件是 Android 构建系统(Android Build System)中使用的构建描述文件,它用于定义 Android 项目中的模块、库、应用等构建规则。该文件使用 Blueprint 语言,是 Soong 构建系统的一部分。
Soong则是专为Android编译而设计的工具,Blueprint只是解析文件的形式,而Soong则解释内容的含义,最终转换成Ninja文件。Android.bp文件用类似JSON的简洁声明来描述需要构建的模块。
Android.bp的出现就是为了替换Android.mk文件。bp跟mk文件不同,它是纯粹的配置,没有分支、循环等流程控制,不能做算数逻辑运算。如果需要控制逻辑,那么只能通过Go语言编写。
Android.mk可以引用Android.bp中的模块,反之Android.bp不能引用Android.mk中的模块。

Android.bp的主要作用

以下是 Android.bp 文件的一些主要作用:

模块定义

Android.bp 文件用于定义 Android 项目中的模块,这些模块可以是共享库、可执行文件、静态库等。每个模块都有其自己的属性和规则,用于描述模块的构建过程和依赖关系。

依赖关系

在 Android.bp 文件中,你可以指定一个模块依赖于其他模块,定义了模块之间的依赖关系。这包括依赖于其他库、系统库、源代码文件等。

构建规则

通过 Android.bp 文件,你可以指定模块的构建规则,包括编译选项、链接选项、源文件列表等。这使得开发者可以配置模块的构建过程。

模块属性

对每个模块,你可以定义一系列属性,这些属性包括模块的名称、类型、源文件列表、编译选项、依赖项等。这些属性在构建过程中用于指导构建系统。

插件支持

Android.bp 文件支持插件,这使得开发者可以自定义构建规则,添加额外的构建步骤或其他功能。

模块的可配置性

通过 Android.bp 文件,你可以定义模块的可配置属性,允许构建系统在不同的场景或设备上使用不同的配置。

在整个 Android 构建系统中,Android.bp 文件是非常重要的一部分,它提供了一种灵活且可扩展的方式来定义和配置 Android 项目的构建过程。这样的设计使得 Android 构建系统能够适应不同的硬件、设备和项目需求。

为什么会引入Android.bp

Android.bp 文件是Android构建系统中引入的一种构建文件,用于替代之前的Makefile和其他构建描述文件。主要的原因包括:

构建系统的现代化: 传统的Makefile构建系统在复杂项目中的管理和维护上存在一些困难,特别是随着Android项目的复杂性的增加。Soong构建系统和Android.bp文件的引入旨在提供更现代、可扩展、易维护的构建系统。

模块化和可配置性: Android.bp 文件引入了模块化的构建方式,允许将Android项目拆分为多个模块,并为每个模块定义独立的构建规则。这种模块化的设计使得开发者能够更好地组织项目结构,提高代码的可维护性。同时,Android.bp 文件支持配置属性,允许根据不同的设备或条件进行灵活的配置。

性能和并发构建: Soong构建系统和Android.bp文件的设计旨在提高构建系统的性能。它支持并发构建,可以更高效地利用多核处理器,并在大型项目中减少构建时间。

支持新的Android平台特性: 随着Android平台的不断演进,新的构建需求和特性不断涌现。Soong和Android.bp文件的引入使得构建系统更容易适应这些新的需求,包括对新的硬件架构、系统组件等的支持。

Android.bp 文件的引入是为了提供一个更先进、可扩展和高效的Android构建系统,以满足复杂Android项目的构建需求,并使得构建过程更具灵活性和性能优势。

语法

Android.bp 文件是 Soong 构建系统中的构建描述文件,用于配置 Android 项目的构建规则。以下是 Android.bp 文件的主要语法要点:

模块类型定义:
使用 module_type 字段指定模块的类型,例如 module_type: "android_library" 或 module_type: "android_app"。

模块名定义:
使用 name 字段指定模块的名称,例如 name: "MyLibrary"。

模块属性:
使用各种字段来定义模块的属性,例如 srcs(源文件列表)、cflags(编译选项)、include_dirs(包含目录)等。
例如:

srcs: ["file1.c", "file2.c"],
cflags: ["-Wall", "-Werror"],

默认属性集:
使用 defaults 字段引用一个默认属性集,以便继承一组默认的属性。例如:

defaults: ["my_defaults"],

模块依赖关系:
使用 deps 字段指定模块的依赖关系,即依赖于其他模块。例如:

deps: ["lib1", "lib2"],

可选依赖关系:
使用 optional_uses_libs 字段指定可选的依赖关系。例如:

optional_uses_libs: ["optional_lib1", "optional_lib2"],

构建配置块:
使用 build 字段定义一个构建配置块,其中可以包含 target、host 或 device 等不同配置。例如:

build: {
    target: {
        cflags: ["-O2"],
    },
    device: {
        cflags: ["-DDEVICE_BUILD"],
    },
},

构建工具配置:
使用 tool 字段配置构建过程中使用的工具。例如:

tool: {
    yacc: ["my_yacc_tool"],
},

标记特定模块属性:
使用 tags 字段给模块打标签,以便在其他模块中引用。例如:

tags: ["my_tag"],

架构相关配置:
使用 arch 字段指定特定的架构相关配置。例如:

arch: {
    arm64: {
        cflags: ["-march=armv8-a"],
    },
    x86: {
        cflags: ["-march=x86-64"],
    },
},

变量和函数:
可以使用变量和函数来简化配置。例如:

my_var = "my_value";
my_func = {
    name: "my_function",
    args: ["arg1", "arg2"],
};

命名空间:

使用 namespace 字段来定义一个命名空间,将一组模块组织在同一个命名空间下。例如:

namespace {
    module_type: "my_namespace_type",
    name: "my_namespace",
    srcs: ["namespace_file1.c", "namespace_file2.c"],
}

模块分隔:
使用 group 字段将一组模块组织在同一个分组中,以便对它们应用相同的配置。例如:

group {
    name: "my_group",
    srcs: ["group_file1.c", "group_file2.c"],
}

源文件通配符:
使用通配符指定源文件,例如 srcs: ["src/*/.c"],表示匹配 src 目录及其所有子目录下的所有 .c 文件。

条件语句:
使用条件语句来根据不同的条件执行不同的配置。例如:

if (my_condition) {
    // 针对条件为真时的配置
    srcs: ["file_condition_true.c"],
} else {
    // 针对条件为假时的配置
    srcs: ["file_condition_false.c"],
}

标签过滤:
使用 required 和 host_required 字段指定模块的标签过滤条件。例如:

required: ["my_required_tag"],
host_required: ["my_host_required_tag"],

模块替代:
使用 overrides 字段指定被当前模块替代的其他模块。例如:

overrides: ["my_overridden_module"],

私有模块属性:
使用 private 字段指定私有属性,这些属性只能在同一 Android.bp 文件中的其他属性块中使用。例如:

private: {
    my_private_var: "private_value",
}

自动生成的源文件:
使用 generated_sources 字段指定由构建系统自动生成的源文件。例如:

generated_sources: ["generated_file1.c", "generated_file2.c"],

构建工具:
使用 tool 字段指定使用的构建工具及其配置。例如:

tool: {
    aidl: {
        flags: ["-Ipath/to/aidl/include"],
    },
},

这些语法要点提供了 Android.bp 文件中一些常见的配置选项和结构。要了解更多详细信息,可以查阅官方 Soong 构建系统文档,该文档提供了全面的语法和配置选项说明,以及更多实际的示例。

例子

android_app {
    name: "TvLocalMediaPlayer",
    defaults: ["xxx_DexPreOptVariant_defaults"],

    srcs: ["src/**/*.java",
          "src/**/*.kt"],
    resource_dirs: ["res"],

    optional_uses_libs: [
        "javax.obex",
    ],

    static_libs: [
        "com.mediatek.exoplayerlib",
        "com.mediatek.tv.oneworld.basic",
        "com.mediatek.tv.oneworld.tvapi",
        "extservice_api",
        "com.mediatek.tv.agent.settingspqdb.lib",
        "com.mediatek.tv.oneworld.systemapi",
        "com.mediatek.xxxPhoto",
        "androidx.recyclerview_recyclerview",
        "androidx.preference_preference",
        "androidx.appcompat_appcompat",
        "androidx.leanback_leanback-preference",
        "androidx.leanback_leanback",
        "androidx.lifecycle_lifecycle-runtime",
        "androidx.lifecycle_lifecycle-common",
        "com.mediatek.tv.common.views"
    ],

    certificate: "platform",
    platform_apis: true,
    privileged: true,
    system_ext_specific: true,

    optimize: {
        proguard_flags_files: ["proguard.flags"],
    },
    overrides: ["LiveTv"],
}

这个 Android.bp 文件是一个用于构建 Android 应用程序模
块的配置文件,采用 Soong 构建系统的语法。以下是对文件中的各个部分的详细解释:

android_app 模块类型:

android_app 是 Android 构建系统中用于定义 Android 应用程序模块的一种模块类型。
这个模块类型表示一个Android应用程序,它将编译成一个APK文件。
模块的基本信息:

name: "TvLocalMediaPlayer":指定应用程序模块的名称为 "TvLocalMediaPlayer"。
defaults: ["xxx_DexPreOptVariant_defaults"]:引用了一个名为 "xxx_DexPreOptVariant_defaults" 的默认配置。
源代码和资源文件:

srcs: ["src//*.java", "src//*.kt"]:指定了Java和Kotlin源代码文件的路径,这些文件将被编译成应用程序的可执行代码。
resource_dirs: ["res"]:指定了资源文件的路径,这些资源文件将被包含在最终的APK中。
可选使用的库:

optional_uses_libs: ["javax.obex"]:指定了一个可选使用的库,即 javax.obex。如果该库可用,则将其链接到应用程序中。
静态库依赖关系:

static_libs 部分列举了应用程序依赖的静态库模块。这些库模块将被链接到应用程序中。
例如,"com.mediatek.exoplayerlib"、"com.mediatek.tv.oneworld.basic" 等。
证书和平台相关属性:

certificate: "platform":指定应用程序使用平台证书进行签名,这是 Android 平台的标准做法。
platform_apis: true:表明该应用程序使用了 Android 平台的 API。
privileged: true:表明该应用程序是特权应用,可能需要更高的系统权限。
system_ext_specific: true:

system_ext_specific: true:表明该应用程序是专门为 System Ext 分区设计的,System Ext 是 Android 10 引入的一个扩展系统分区。

优化配置:
optimize 部分定义了一些优化配置。
proguard_flags_files: ["proguard.flags"]:指定了 ProGuard 优化的配置文件。

overrides: ["LiveTv"]:
overrides 部分列举了该应用程序覆盖的其他模块,这里是 "LiveTv"。这意味着当前应用程序可能包含或修改了 "LiveTv" 模块的一些功能。


结束语
Flutter是一个由Google开发的开源UI工具包,它可以让您在不同平台上创建高质量、美观的应用程序,而无需编写大量平台特定的代码。我将学习和深入研究Flutter的方方面面。从基础知识到高级技巧,从UI设计到性能优化,欢饮关注一起讨论学习,共同进入Flutter的精彩世界!
相关文章
|
1月前
|
测试技术 API 调度
【Android 从入门到出门】第七章:开始使用WorkManager
【Android 从入门到出门】第七章:开始使用WorkManager
19 3
【Android 从入门到出门】第七章:开始使用WorkManager
|
1月前
|
存储 Android开发 C++
【Android 从入门到出门】第五章:使用DataStore存储数据和测试
【Android 从入门到出门】第五章:使用DataStore存储数据和测试
30 3
|
1月前
|
Android开发
【Android 从入门到出门】第四章:现代Android开发中的导航
【Android 从入门到出门】第四章:现代Android开发中的导航
22 2
【Android 从入门到出门】第四章:现代Android开发中的导航
|
1月前
|
XML API Android开发
【Android 从入门到出门】第三章:使用Hilt处理Jetpack Compose UI状态
【Android 从入门到出门】第三章:使用Hilt处理Jetpack Compose UI状态
26 4
|
1月前
|
存储 XML 编译器
【Android 从入门到出门】第二章:使用声明式UI创建屏幕并探索组合原则
【Android 从入门到出门】第二章:使用声明式UI创建屏幕并探索组合原则
47 3
|
1月前
|
存储 SQL 数据库
【Android 从入门到出门】第六章:使用Room数据库并测试
【Android 从入门到出门】第六章:使用Room数据库并测试
29 4
|
1月前
|
存储 Android开发
【Android 从入门到出门】第八章:分页入门指南
【Android 从入门到出门】第八章:分页入门指南
21 3
|
1月前
|
IDE Java 开发工具
【Android 从入门到出门】第一章:Android开发技能入门指南
【Android 从入门到出门】第一章:Android开发技能入门指南
60 3