Android源码学习------SystemUI（一）

谷翰飞

2023-12-01

SystemUI----mk文件

在学习某一个模块代码之前，首先需要查看该应用的mk文件，以便于有效的了解应用中source的相关信息。Android.mk文件用来告知NDK Build系统关于Source的信息。Android.mk将是GNU Makefile的一部分，且将被Build System解析一次或多次。
主要是用来描述要编译某个具体的模块，所需要的一些资源，包括要编译的源码、要链接的库等等。

SystemUI模块的代码位置：project/frameworks/base/packages/SystemUI/

#每个Android.mk文件必须以定义LOCAL_PATH为开始，它用于在开发tree中查找源文件
LOCAL_PATH:= $(call my-dir)  
include $(CLEAR_VARS)
#LOCAL_MODULE模块必须定义，以表示Android.mk中的每一个模块。名字必须唯一且不包含空格。
LOCAL_MODULE := SystemUI-proto  
LOCAL_SRC_FILES := $(call all-proto-files-under,src)  
LOCAL_PROTOC_OPTIMIZE_TYPE := nano
LOCAL_PROTO_JAVA_OUTPUT_PARAMS := optional_field_style=accessors
#收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息，编译为编译为静态库
include $(BUILD_STATIC_JAVA_LIBRARY)  

include $(CLEAR_VARS)
LOCAL_MODULE := SystemUI-tags
LOCAL_SRC_FILES := src/com/android/systemui/EventLogTags.logtags
include $(BUILD_STATIC_JAVA_LIBRARY)

include $(CLEAR_VARS)
LOCAL_USE_AAPT2 := true
#optional指该模块在所有版本下都编译；user只在user版本下才编译；eng只在eng版本下才编译；tests只在tests版本下才编译
LOCAL_MODULE_TAGS := optional   
RELATIVE_FINGERPRINT_PATH := ../../core/java/android/hardware/fingerprint
LOCAL_SRC_FILES := \
    $(call all-java-files-under, src) \
    $(call all-Iaidl-files-under, src) \
    $(call all-Iaidl-files-under, $(RELATIVE_FINGERPRINT_PATH))
LOCAL_STATIC_ANDROID_LIBRARIES := \                
    SystemUIPluginLib \
    SystemUISharedLib \
    android-support-car \
    android-support-v4 \
    android-support-v7-recyclerview \
    android-support-v7-preference \
    android-support-v7-appcompat \
    android-support-v7-mediarouter \
    android-support-v7-palette \
    android-support-v14-preference \
    android-support-v17-leanback \
    android-slices-core \
    android-slices-view \
    android-slices-builders \
    android-arch-core-runtime \
    android-arch-lifecycle-extensions \
LOCAL_STATIC_JAVA_LIBRARIES := \
    SystemUI-tags \
    SystemUI-proto
LOCAL_JAVA_LIBRARIES := telephony-common \
    android.car
#应用编译后的名称
LOCAL_PACKAGE_NAME := SystemUI
#可使用sdk的hide的api來编译
LOCAL_PRIVATE_PLATFORM_APIS := true
#platform指定用系统级签名，即所在进程的UID为system；testkey普通APK，默认；shared需要和home/contacts进程共享数据；media是media/download系统中的一环。
LOCAL_CERTIFICATE := platform
#true 表示应用编译后为系统路径：/system/pri-app/SystemUI   false 表示应用在目录/system/app/下
LOCAL_PRIVILEGED_MODULE := true
#混淆配置文件来保留文件（proguard.flags文件中内容）不要被混淆
LOCAL_PROGUARD_FLAG_FILES := proguard.flags
#指定res路径
LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res-keyguard $(LOCAL_PATH)/res
#可以选择性使用JACK编译器
ifneq ($(INCREMENTAL_BUILDS),)
    LOCAL_PROGUARD_ENABLED := disabled
    LOCAL_JACK_ENABLED := incremental
    LOCAL_DX_FLAGS := --multi-dex
    LOCAL_JACK_FLAGS := --multi-dex native
endif
include frameworks/base/packages/SettingsLib/common.mk
#可以查看，创建， 更新ZIP格式的文档附件(zip, jar, apk)。也可将资源文件编译成二进制文件。
LOCAL_AAPT_FLAGS := --extra-packages com.android.keyguard
#生成apk文件
include $(BUILD_PACKAGE)
#生成test apk
include $(call all-makefiles-under,$(LOCAL_PATH))

解析

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_LIBRABIRES等等。但不清理LOCAL_PATH。这个清理动作是必须的，因为所有的编译控制文件都由GNU Make解析和执行，其变量是全局的，所以清理后才能避免相互影响。

LOCAL_MODULE := SystemUI-proto

以表示Android.mk中的每一个模块。名字必须唯一且不包含空格。通常用于编译各种库，可执行文件。编译系统（Build System）会自动添加适当的前缀和后缀。例如，foo，要产生动态库，则生成 libfoo.so。但请注意：如果模块名被定为：libfoo.则生成 libfoo.so。不再加前缀。

LOCAL_SRC_FILES := $(call all-proto-files-under,src)

all-proto-files-under在指定目录下查找所有的.proto文件。

LOCAL_PROTOC_OPTIMIZE_TYPE := nano
LOCAL_PROTO_JAVA_OUTPUT_PARAMS := optional_field_style=accessors

LOCAL_PROTOC_OPTIMIZE_TYPE：构建Java库或app（包）目标时，构建系统会将Java nano运行时库添加到LOCAL_STATIC_JAVA_LIBRARIES变量中。
LOCAL_PROTO_JAVA_OUTPUT_PARAMS：获取所需的任何命令行选项。使用逗号连接多个选项。
optional_field_style={default,accessors,reftypes}，定义每个字段所生成的代码的格式。

default：proto中每个字段生成一个public的可变的值；
accessors：proto中每个optional字段会封装成一个private的值和4个用于操作该值的方法，分别是get(), set(), has()和clear()，在accessors选项中，required字段依旧是生成public的可变的值，repeated字段依旧是生成一个array；
要注意的是，当启用accessors选项时，使用Proguard混淆时，一定禁用-dontoptimize选项和启用-allowaccessmodification选项，这能够在项目编译时去掉那些没被调用的方法，减少最终的代码量；
reftypes:proto中每个字段都会生成一个public的可变的值，与default不同的是，对于每个基本数据类型，如int，float等，都会使用Java对应的内建类型，并初始化为null（比如int会使用Java.lang.Integer类来替代），这样会带来额外的开销，好处是你可以避免歧义，比如optional int的字段，收到为0的值时，会分不清到底传来的值是0，还是这个字段为空。
https://www.jianshu.com/p/185fc0e13028

include $(BUILD_STATIC_JAVA_LIBRARY)

截至最近的一个include $(CLEAR_VARS)，将当前模块编译成一个静态的 Java 库。

LOCAL_USE_AAPT2 := true

aapt 是Android Asset Packaging Tool的缩写，是编译和打包资源的工具。由gradle自动调用aapt2，将资源文件编译成二进制文件。

LOCAL_MODULE_TAGS := optional

LOCAL_MODULE_TAGS :=user eng tests optional

user: 指该模块只在user版本下才编译
eng: 指该模块只在eng版本下才编译
tests: 指该模块只在tests版本下才编译
optional:指该模块在所有版本下都编译

LOCAL_SRC_FILES := \
    $(call all-java-files-under, src) \
    $(call all-Iaidl-files-under, src) \
    $(call all-Iaidl-files-under, $(RELATIVE_FINGERPRINT_PATH))

all-java-files-under: 找出当前makefile所在目录的指定子目录里的所有java文件
all-Iaidl-files-under: 在指定子目录下查找所有类似I*.aidl代码文件

LOCAL_STATIC_ANDROID_LIBRARIES := \                
    SystemUIPluginLib \
    SystemUISharedLib \
    android-support-car \
    android-support-v4 \
    android-support-v7-recyclerview \
    android-support-v7-preference \
    android-support-v7-appcompat \
    android-support-v7-mediarouter \
    android-support-v7-palette \
    android-support-v14-preference \
    android-support-v17-leanback \
    android-slices-core \
    android-slices-view \
    android-slices-builders \
    android-arch-core-runtime \
    android-arch-lifecycle-extensions \
LOCAL_STATIC_JAVA_LIBRARIES := \
    SystemUI-tags \
    SystemUI-proto
LOCAL_JAVA_LIBRARIES := telephony-common \
    android.car

LOCAL_****_LIBRARIES:导入对应的包
注意：‘:=’是赋值的意思；’+=’是追加的意思；‘\’表示连接符。

LOCAL_PACKAGE_NAME := SystemUI

当前 APK 应用的名称，这个名字在脚本中将标识这个app或package。

LOCAL_PRIVATE_PLATFORM_APIS := true

设置后，会使用sdk的hide的api來编译。如果有LOCAL_SDK_VERSION 这个编译配置，就会使编译的应用不能访问hide的api，有时一些系统的class被import后编译时说找不到这个类，就是这个原因造成的。LOCAL_SDK_VERSION := current 意思是编译时忽略系统隐藏类(@hide)。

LOCAL_CERTIFICATE := platform

用于设置不同的签名方式。build/target/product/security目录中有四组默认签名供Android.mk在编译APK使用：

testkey：普通APK，默认情况下使用。
platform：该APK完成一些系统的核心功能。这种方式编译出来的APK所在进程的UID为system。
shared：该APK需要和home/contacts进程共享数据。
media：该APK是media/download系统中的一环。
SystemUI.apk是platform级别的签名，系统级别的应用都应该使用这个签名。

LOCAL_PRIVILEGED_MODULE := true

LOCAL_PRIVILEGED_MODULE 决定了其编译后的在ROM中的安装位置
如果不设置或者设置为false，安装位置为system/app；如果设置为true，安装位置为system/priv-app。

LOCAL_PROGUARD_FLAG_FILES := proguard.flags

针对android 选择user版本进行编译的时候，指定不需要混淆的native方法和变量的文件为proguard.flags，在proguard.flags文件中加入不需要proguard优化的类和方法并不会对其进行混淆。LOCAL_PROGUARD_ENABLED := disabled 不要使用代码混淆的工具进行代码混淆。
不设置，默认使用LOCAL_PROGUARD_ENABLED := full.即将该工程代码全部混淆。

LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res-keyguard $(LOCAL_PATH)/res

用来指定参与编译的资源文件。

ifneq ($(INCREMENTAL_BUILDS),)
    LOCAL_PROGUARD_ENABLED := disabled
    LOCAL_JACK_ENABLED := incremental
    LOCAL_DX_FLAGS := --multi-dex
    LOCAL_JACK_FLAGS := --multi-dex native
endif

在增量编译过程中配置JACK编译器，JACK编译器有三种模式：
LOCAL_JACK_ENABLED:= disabled ” (ie disabled, full, incremental）

disabled是指关闭JACK编译，使用android old toolchain。
full是指全部编译，即每次编译，都会将所有的code全部编译。
incremental是指增量编译，即只会编译修改的代码。incremental模式默认是关闭的，需要设置。
LOCAL_DX_FLAGS & LOCAL_JACK_FLAGS ：Android平台的Java虚拟机Dalvik执行Dex程序时，使用的是short类型来索引DEX文件中的方法。这就意味着单个Dex文件可被引用的方法总数被限制为64x1024, 即65536。其中包括:Android Framework的方法，library的方法，我们自己写的方法。为突破这个限制，需要使用multidex来生成多个dex文件。

include frameworks/base/packages/SettingsLib/common.mk

commom.mk
LOCAL_STATIC_JAVA_LIBRARIES += \
    android-support-annotations \
    android-arch-lifecycle-common
LOCAL_STATIC_ANDROID_LIBRARIES += \
    android-support-v4 \
    android-arch-lifecycle-runtime \
    android-support-v7-recyclerview \
    android-support-v7-preference \
    android-support-v7-appcompat \
    android-support-v14-preference \
    SettingsLib

导入公用的资源包。

LOCAL_AAPT_FLAGS := --extra-packages com.android.keyguard

指定打包资源文件。因为Android的工具aapt在生成apk文件时默认地会编译并压缩res/下的文件，而一些系统文件则不需要被压缩（否则在读取该文件时需要解压缩），在Android.mk文件需要指定以下选项告诉aapt工具不压缩所的文件。

include $(BUILD_PACKAGE)

将该模块的内容生成apk文件。

include $(call all-makefiles-under,$(LOCAL_PATH))

获取指定目录下及子目录的所有 Android.mk 。

Android源码学习------SystemUI（一）

SystemUI----mk文件

解析

相关阅读

相关文章

相关问答

相关文档