Bash技巧：一个大幅提升Android平台开发效率的Shell脚本

之前文章介绍了一个 quickcd.sh 脚本，可以指定任意的顶层目录，在顶层目录底下快速 cd 到特定的目录。

这个 quickcd.sh 脚本是通用的，适用于各种目录结构。

如果从事 Android 开发工作，经常需要在 Android 源码目录之间切换。

同时，可以对脚本进行一些修改，支持一些跟 Android 相关的功能。

例如，指定一个选项就可以自动 source、lunch、全编译 Android 源码。

添加一些标志位指定进入某个目录时，就自动编译这个目录下的代码。等等。

本篇文章介绍一个 androidcd.sh 脚本，在 quickcd.sh 脚本的基础上添加跟 Android 相关的代码和选项。

实际上，androidcd.sh 脚本支持 quickcd.sh 的所有功能，也可以用于任意顶层目录。

只是脚本代码里面多加了一些 Android 相关的代码和选项。

如果不需要用到这些选项，使用之前文章介绍的 quickcd.sh 脚本即可，这个代码比较独立。

下面提供具体的脚本代码、参考的配置文件内容、以及一个测试例子。

脚本代码

列出 androidcd.sh 脚本的具体代码如下所示。

在这个代码中，对大部分关键代码都提供了详细的注释，方便阅读。

这篇文章的后面也会提供一个简单的测试例子，可供参考。

#!/bin/bash
# 该脚本用于在所指定顶层目录底下的各个目录之间直接来回快速 cd.
# 把各个目录路径和一些简单的字符对应起来,通过解析预先配置的文本文件,获取
# 路径简写和对应要 cd 到的目录路径. 基本配置格式为: 路径简写|目录路径
# 例如配置 "b|frameworks/base",则 b 是路径简写, frameworks/base 是对应的
# 路径.在顶层目录底下的任意一个目录里面,都可以执行 source androidcd.sh b
# 命令来直接 cd 到 framework/base 目录下,不需要先退回到顶层目录再执行 cd.
# 为了让脚本执行结束后,还保持在 cd 后的目录,需要用 source 命令来执行
# 当前脚本. 可以在 ~/.bashrc 文件中添加如下语句来设置命令别名:
#   alias c='source androidcd.sh'
# 后续执行 c 命令,就相当于执行 source androidcd.sh 命令.
# 这里假设 androidcd.sh 脚本放在 PATH 指定的寻址目录下.例如 /usr/bin 目录.
# 如果 androidcd.sh 脚本没有放在默认的寻址目录下,请指定完整的绝对路径.

# 下面变量指定默认解析的配置文件名.该文件配置了路径简写、以及对应的路径.
# 这个 dirinfo.txt 文件需要预先配置好,放到 HOME 目录的 .liconfig 目录下.
DEFAULT_DIRINFO="${HOME}/.liconfig/dirinfo.txt"

# PARSECFG_filepath 是 parsecfg.sh 脚本里面的变量. 如果这个变量为空,
# 说明还没有打开过配置文件,进入下面的分支打开默认的配置文件.由于当前的
# androidcd.sh 脚本和 parsecfg.sh 脚本都是通过 source 命令来调用.只要
# source 过一次,导出到调用者 shell 的全局变量和函数会一直有效.所以只有
# PARSECFG_filepath 变量为空才 source parsecfg.sh,避免多次打开配置文件.
if [ -z "$PARSECFG_filepath" ]; then
    # 导入解析配置文件的脚本,以便调用该脚本的函数来解析配置文件.
    source parsecfg.sh
    # 调用 parsecfg.sh 里面的 open_config_file() 函数解析配置文件.
    open_config_file "$DEFAULT_DIRINFO"
    # 当 parsecfg.sh 脚本解析配置文件失败时,则退出,不再往下执行.
    if [ $? -ne 0 ]; then
        return 1
    fi
fi

# 由于不同源代码的目录结构可能不同,当在不同的源代码目录中使用
# 当前脚本来切换时,需要指定不同的配置文件.下面函数就用于打开
# 用户指定的配置文件名. 所给的第一个参数指定配置文件名.
# 有一个特殊的文件名是 "default",表示要打开脚本默认的配置文件.
open_user_config_file()
{
    if [ $# -ne 1 ]; then
        echo "Usage: $FUNCNAME filepath"
        return 1
    fi

    local filepath
    if [ "$1" == "default" ]; then
        filepath="$DEFAULT_DIRINFO"
    else
        filepath="$1"
    fi

    # 调用 parsecfg.sh 的 open_config_file 函数打开配置文件
    open_config_file "$filepath"
    # 当 return 后面不带参数时,默认返回上一个命令的状态码.
    return
}

# 下面的 DIRECTCD_TOP_DIR 变量用于保存设置的顶层目录路径.
# 当设置顶层目录为 code/ 时,后续实际 cd 的所有目录路径前面都会加上 code/.
# 这个设置是为了方便在指定的某个顶层目录(例如源码根目录)底下进行快速 cd.
# 例如,在一个大型项目代码中,这些代码都放在同一个顶层目录下,我们只需要配置
# 顶层目录下的子目录路径即可.实际切换目录时,会自动加上顶层目录,再进行 cd.
# NOTE: 不要在脚本开头为这个变量赋初值.每次 cd 时,都会执行这个脚本.但不是
#   每次 cd 都要设置顶层目录路径.在多次调用该脚本时,要保持该变量的值不变.
# DIRECTCD_TOP_DIR=""

# 在路径简写前面加上字符'+'时,表示进入该路径简写对应的目录下进行编译.
COMPILE_PREFIX="+"
# 指定编译 Android 时默认要 lunch 的分支名.目前设置成最常用的project名称.
# 后续如有调整,需要把 DEFAULT_LAUNCH_COMBO 修改成对应的 project 名称.
DEFAULT_LAUNCH_COMBO="K80129AA1-userdebug"

quickcd_show_help()
{
printf "USAGE
    source androidcd.sh [option] [symbol]
OPTIONS
    option: 可选的选项参数,描述如下:
        -h: 打印当前帮助信息.
        -f: 指定要解析的配置文件名.后面跟着一个参数,指定具体的文件路径.
            如果所给文件名是 'default',表示要打开脚本默认的配置文件.
        -p: 打印当前设置的顶层目录和所解析的配置文件名.
        -s: 设置并cd到所给的顶层目录.后面跟着一个参数,指定具体的顶层目录.
        -r: 清空当前设置的顶层目录.
        -l: 查看脚本支持的路径简写及其对应的路径.
        -v: 以键值对的方式打印详细的配置文件信息.
        -i: 在配置文件中查找指定内容.需要一个参数来指定要查找的内容.
        -e: 使用 vim 打开脚本的配置文件,以供编辑.
        -a: 增加或修改一个路径简写和对应的路径到配置文件.后面跟着一个参数,
            用单引号括起来,以指定路径简写和路径. 格式为: 路径简写|路径
            例如: -a 'b|frameworks/base'.如果 b 简写还不存在,会新增
            这个配置项. 如果已经存在,会修改 b 简写对应的路径为新的路径.
        -d: 从脚本配置文件中删除一个路径简写和对应的路径.后面跟着一个
            参数,指定路径简写.脚本将从配置文件中删除该路径简写对应的行.
            例如 -d b, 将删除路径简写为 b 的行.
        -g: 在Android源码下查找指定的文件.需要提供参数来指定文件名.
        -n: 进行source和lunch的操作,但是不编译.需要提供参数指定project名称.
            有效 project 参数是 lunch 命令支持的参数.
            有一个特殊参数是 'dl',表示编译脚本默认预置的 project.
        -m: 在Android源码根目录下进行全编译.需要提供参数来指定编译的project.
            有效 project 参数是 lunch 命令支持的参数.
            有一个特殊参数是 'dl',表示编译脚本默认预置的 project.
    symbol: 可选参数,指定要 cd 到的路径简写.支持的简写可以用-l或-v选项来查看.
            在路径简写前面加上字符'+',表示进入该路径简写对应的目录下进行编译.

    当不提供任何参数且已经设置过顶层目录时,该脚本会 cd 到顶层目录下.
NOTE
    可以使用 alias c='source androidcd.sh' 设置 c 别名来方便执行.
"
}

# 打印当前设置的顶层目录到标准输出.
show_top_dir()
{
    echo "当前设置的顶层目录路径是: ${DIRECTCD_TOP_DIR}"
    echo "当前解析的配置文件是: ${PARSECFG_filepath}"
}

# 该函数设置顶层目录路径. 所给的第一个参数指定顶层目录路径.
# 这个顶层目录路径可以是相对路径,或者绝对路径.
setup_top_dir()
{
    if [ $# -ne 1 ]; then
        echo "Usage: $FUNCNAME top_dir"
        return 1
    fi

    # 进入到所给的顶层目录路径底下,并检查 cd 命令是否执行成功.
    \cd "$1"
    if [ $? -eq 0 ]; then
        # 所给的顶层目录可以是相对路径.但是代码要获取该顶层目录的
        # 绝对路径,以便后续通过绝对路径寻址,不受工作目录的影响.
        DIRECTCD_TOP_DIR="$(pwd)"
    else
        echo "出错: 无法进入所给的顶层目录.请检查所给路径是否正确."
        return 2
    fi
}

# 重置 DIRECTCD_TOP_DIR 变量值为空.取消设置顶层目录路径.
# 由于这个脚本预期通过 source 命令调用.只要设置过顶层目录,在
# 当前 shell 中,DIRECTCD_TOP_DIR 变量就一直有值.在调试脚本代码时,
# 如果想要再次测试没有设置顶层目录的情况,只能重新打开终端,比较麻烦.
# 提供 -r 选项调用下面 reset_top_dir() 函数来重置所设置的顶层目录.
# 会一起设置 PARSECFG_filepath 变量值为空,以便重新解析配置文件.
reset_top_dir()
{
    DIRECTCD_TOP_DIR=""
    PARSECFG_filepath=""
}

# 如果当前路径不位于顶层目录底下,打印一些提示信息,以便用户关注到这一点.
# 例如,顶层目录是 code/dev/. 而当前所在的shell工作目录是 code/test/,
# 可能预期执行该脚本时会 cd 到 code/test/ 目录下的子目录,但实际会 cd
# 到 code/dev/ 目录下的子目录,这可能会修改到不预取目录的代码文件.
# 为了避免这个问题,这个函数打印一些提示信息,作为提醒.
check_top_dir()
{
    # 查看man bash的"Compound Commands"小节说明, =~ 判断左边字符串是否包含
    # 右边字符串.如果左边字符串包含右边的字符串,其返回状态码是0,否则返回1.
    if [[ ! $(pwd) =~ "${DIRECTCD_TOP_DIR}" ]]; then
        # 如果当前的工作目录不包含所给的顶层目录,说明没有位于顶层目录底下.
        echo -e 当前路径'\e[31m' $(pwd) '\e[0m'位于设置的顶层目录之外.
        echo -e 将会跳转到顶层目录'\e[32m' ${DIRECTCD_TOP_DIR} '\e[0m'底下的目录!
    fi
}

# 进入Android源码根目录进行source、lunch的操作.所给第一个参数指定要编译
# 的 project 名称.有效的project参数是lunch命令支持的参数.有一个特殊参数
# 是 "dl",表示要编译脚本预置的 project,由 DEFAULT_LAUNCH_COMBO 变量指定.
source_and_lunch()
{
    # 如果 DIRECTCD_TOP_DIR 变量为空,则还没有设置顶层目录,报错返回
    if [ -z "${DIRECTCD_TOP_DIR}" ]; then
        echo "出错: 还没有设置顶层目录,请使用 -h 选项查看脚本帮助说明."
        return 2
    fi

    if [ $# -ne 1 ]; then
        echo "Usage: $FUNCNAME launch_combo"
        return 1
    fi

    local lunch_combo
    if [ "$1" == "dl" ]; then
        # "dl" 特殊参数表示要编译默认的 project
        lunch_combo="${DEFAULT_LAUNCH_COMBO}"
    else
        lunch_combo="$1"
    fi

    \cd "${DIRECTCD_TOP_DIR}"
    source build/envsetup.sh
    # 在Android的"build/envsetup.sh"脚本中,有一个print_lunch_menu()函数可以
    # 打印所有lunch分支,格式类似于"1. aosp_arm-eng".其中,1 是lunch分支编号,
    # "aosp_arm-eng"是lunch分支名. lunch命令可以接收lunch分支名或者lunch分
    # 支编号来指定要lunch的分支.下面用grep查找特定的分支,并用awk提取出分支
    # 名,将分支名作为参数传给 lunch 命令,从而自动lunch需要的分支.
    lunch $(print_lunch_menu | grep "$lunch_combo" | awk '{print $2}')
    return
}

# 进入 Android 源码根目录全编译代码. 所给第一个参数指定要编译的 project.
# 为了简化使用, compile_android 会自己调用 source_and_lunch 函数,而不是
# 要求用户先手动指定 -s 选项来调用 source_and_lunch 函数才能编译. 可以
# 修改成还没有source、lunch过, compile_android 再自己 lunch. 但是目前
# Android 没有提供查询是否已经 lunch 过的命令.虽然查看 envsetup.sh 的源码
# 可以找到判断方法,但随着版本改动可能会失效,影响当前脚本的独立性,暂定不做.
compile_android()
{
    if [ $# -ne 1 ]; then
        echo "Usage $FUNCNAME android_lunch_combo"
        return 1
    fi

    source_and_lunch "${1}" && \
        make -j16 2>&1 | tee build_android.log
    if [ $? -ne 0 ]; then
        echo -e '\e[31m编译 Android 出错!\e[0m'
        return 1
    fi
}

# 保存Android源码各个目录和文件的名字到一个文本文件里面,然后可以在该
# 文件中查找指定的文件名,如果只找到一个就直接 cd 到该文件所在的目录.如果
# 找到多个匹配项,就弹出列表给用户选择,选择之后再 cd 过去.
# 这个函数复制自Android源码的build/make/envsetup.sh文件,进行了一些修改.
godir() {
    # 如果 DIRECTCD_TOP_DIR 变量为空,则还没有设置顶层目录,报错返回
    if [ -z "${DIRECTCD_TOP_DIR}" ]; then
        echo "还没有设置顶层目录,请使用-h选项查看脚本帮助说明."
        return 1
    fi
    if [[ -z "$1" ]]; then
        echo "Usage: godir "
        return 1
    fi
    local T="${DIRECTCD_TOP_DIR}/"
    # envsetup.sh 是把文件信息写入 filelists 文件,修改写入的文件名
    # 为 gtags.files,这是 gtags 要解析的文件名,这两者需要的文件内容
    # 是一样的,只生成一份文件即可.
    local FILELIST="gtags.files"
    if [[ ! -f $T/${FILELIST} ]]; then
        echo -n "Creating index..."
        \cd $T
        # 下面的find指定只在 bionic、build、frameworks 等目录下查找,
        # 且通过-path和-prune选项忽略这些目录下带有 test、git 等名称的
        # 子目录,最后通过正则表达式查找指定后缀名的文件.使用$来要求匹
        # 配末尾. 下面的 -print 要写在最后面,把最终查找的文件名打印出
        # 来,如果写在-prune的后面,它是打印-prune的结果,不是打印-regex
        # 匹配的文件结果. -regex 和 -type 之间不用加-o,加上反而有问题.
        find ./bionic ./build ./device ./external \
            ./frameworks ./hardware ./kernel \
            ./packages ./system ./vendor \
            \( -path "*test*" -o -path "*tools" -o -path "*docs" \
            -o -path "*git*" -o -path "*svn" \) -prune \
            -o -regex '.+\.\(c\|h\|cpp\|cc\|hpp\|java\|rc\|xml\)$' \
            -type f -print > $FILELIST
            # grep -E "\.\w+$" | grep -v -E "\.html$|\.txt$|\.so$"
        echo " Done"
    fi
    local lines
    lines=($(\grep "$1" $T/${FILELIST}|sed -e 's/\/[^/]*$//'|sort|uniq))
    if [[ ${#lines[@]} = 0 ]]; then
        echo "Not found"
        return
    fi
    local pathname
    local choice
    if [[ ${#lines[@]} > 1 ]]; then
        while [[ -z "$pathname" ]]; do
            local index=1
            local line
            for line in ${lines[@]}; do
                printf "%6s %s\n" "[$index]" $line
                index=$(($index + 1))
            done
            echo
            echo -n "Select one: "
            unset choice
            read choice
            if [[ $choice -gt ${#lines[@]} || $choice -lt 1 ]]; then
                echo "Invalid choice"
                continue
            fi
            pathname=${lines[$(($choice-1))]}
        done
    else
        pathname=${lines[0]}
    fi
    echo -e "\033[32mFind it. Let's Go!\033[0m"
    \cd $T/$pathname
}

# 处理所给的路径简写,看配置文件中是否保存这个路径简写.
# 如果包含,就 cd 到该简写对应的目录底下.
# 所给的第一个参数指定路径简写.
handle_symbol()
{
    if [ $# -ne 1 ]; then
        echo "Usage: $FUNCNAME symbol"
        return 1
    fi
    local key="$1"

    local prefix mm_cmd
    # 获取路径简写的首字母.如果首字母是'+',则进到该简写对应的目录下进行编译
    # 注意: 要先source之后,才能执行mm命令.为了避免多次source,不会在每次mm之
    # 前都执行一次source,所以要求先source,再执行这个编译命令,否则编译报错.
    prefix="${key:0:1}"
    if [ "${prefix}" == "${COMPILE_PREFIX}" ]; then
        mm_cmd="mm"
        # 此时,需要去掉'+'这个首字母,该字母不属于路径简写的一部分.
        key=${key:1}
    fi

    # 调用 parsecfg.sh 的 get_value_by_key 函数获取所给的
    # 路径简写在配置文件中对应的目录路径.
    local dir_value=$(get_value_by_key "${key}")
    if test -n "${dir_value}"; then
        # 如果获取到路径简写对应的目录路径,则在该目录路径前面
        # 自动加上顶层目录路径,组成完整的绝对路径,然后进行 cd.
        \cd "${DIRECTCD_TOP_DIR}/${dir_value}"
        # 如果在路径简写前面有加号 '+',则在对应目录下进行编译.
        if [ -n "${mm_cmd}" ]; then
            echo -e "\e[32mEnter $(pwd), execute mm.\e[0m"
            ${mm_cmd}
        fi
        return 0
    fi

    echo "出错: 找不到路径简写 '${key}' 对应的行"
    return 2
}

# 经过验证发现,用source命令来执行该脚本后,OPTIND的值不会被重置为1,导致
# 再次用source命令执行脚本时,getopts解析不到参数,所以手动重置OPTIND为1.
OPTIND=1
while getopts "hf:ps:rlvi:ea:d:g:n:m:" opt; do
    # 调用parsecfg.sh脚本处理选项的函数来处理 "lvi:ea:d:" 这几个选项.
    # 如果处理成功,就直接继续读取下一个选项,不再往下处理.
    # handle_config_option()函数要求传入的选项以'-'开头,而getopts命令
    # 返回的选项不带有'-',所以下面在 ${opt} 前面加上一个 '-'.
    handle_config_option "-${opt}" "${OPTARG}"
    if [ $? -ne 127 ]; then
        continue
    fi

    case "$opt" in
        h) quickcd_show_help ;;
        f) open_user_config_file "$OPTARG" || return ;;
        p) show_top_dir ;;
        s) setup_top_dir "$OPTARG" || return ;;
        r) reset_top_dir ;;
        g) godir "$OPTARG" ;;
        n) source_and_lunch "$OPTARG" ;;
        m) compile_android "$OPTARG" ;;
        ?) echo "出错: 异常选项,请使用 -h 选项查看脚本的帮助说明." ;;
    esac
done

# $# 大于0,说明提供了命令参数. $# 等于OPTIND减去1,说明传入的参数都
# 是命令选项. 此时,直接结束执行,不需要执行后面解析symbol参数的语句.
# 下面的 -a 表示两个表达式都为真时才为真.表达式之间不要加小括号.
# Shell里面的小括号有特殊含义,跟C语言的小括号有些区别,加上会有问题.
if [ $# -gt 0 -a $# -eq $((OPTIND-1)) ]; then
    return 0
fi

# 下面判断 DIRECTCD_TOP_DIR 变量值是否为空.
# 如果为空,说明还没有设置顶层目录. 此时不再往下处理,直接报错返回.
if [ -z "${DIRECTCD_TOP_DIR}" ]; then
    echo -e "\e[31m还没有设置顶层目录,请使用-h选项查看脚本帮助说明.\e[0m"
    return 2
fi

# 检查当前路径是否位于顶层目录下.如果不是,打印一些提示信息.
check_top_dir

if [ $# -eq 0 ]; then
    # 执行该脚本不带参数时,默认 cd 到顶层目录下.
    \cd "${DIRECTCD_TOP_DIR}"
    # 由于不带参数,不需要往下处理,在 cd 之后直接返回.
    return 0
fi

# 移动脚本的参数,去掉前面输入的选项,只剩下表示路径简写的参数.
shift $((OPTIND-1))
# 循环遍历所有剩余的参数,可以处理传入多个参数的情况.
# 例如执行 source androidcd.sh -s topdir a 命令,可以先设置顶层目录,
# 然后 cd 到 a 简写对应的目录下. 这种情况要注意提供的参数顺序.
# 如果写为 source androidcd.sh a -s topdir 命令,会在解析 a 简写时
# 发现还没有设置顶层目录而报错.
for arg in "$@"; do
    handle_symbol "$arg"
done

return

参考的配置文件内容

这个脚本默认会读取 HOME 目录下的 .liconfig/dirinfo.txt 文件。

这个文件里面配置了各个路径简写和对应要调整的目录路径。

参考的配置文件内容如下：

b|frameworks/base
fm|frameworks/base/media/java/android/media
fr|frameworks/base/core/res/res
fs|frameworks/base/services
sui|frameworks/base/packages/SystemUI/src/com/android/systemui
ps|packages/apps/Settings/

基于这个配置信息，无论当前位于哪个目录下，使用 fs 这个简写作为参数，androidcd.sh 脚本都会执行 cd 命令直接进入 frameworks/base/services 目录下。

测试例子

把当前的 androidcd.sh 脚本、所调用的 parsecfg.sh 脚本（具体代码可以查看之前文章）放到可寻址的 PATH 目录下。

在 bash 中设置 alias c='source androidcd.sh' 别名。

把 dirinfo.txt 配置文件放到 HOME 目录的 .liconfig 目录下（如果没有该目录，则手动创建）。

之后，就可以使用 c 命令来执行 androidcd.sh 脚本。

一个简单的测试例子如下所示：

$ c -s android/
[android]$ c fm
[android/frameworks/base/media/java/android/media]$ c fs
[android/frameworks/base/services]$ c sui
[android/frameworks/base/packages/SystemUI/src/com/android/systemui]$ c ps
[android/packages/apps/Settings/]$ c -m dl
...... # 省略打印的编译信息
[android]$ c +ps
Enter /home/android/packages/apps/Settings/, execute mm.

执行 c -s android/ 设置要跳转的 Android 源码根目录路径。

执行 c fm 命令跳转到 fm 路径简写对应的目录。

执行 c fs 命令跳转到 fs 路径简写对应的目录。

执行 c sui 命令跳转到 sui 路径简写对应的目录。

执行 c ps 命令跳转到 ps 路径简写对应的目录。

可以看到，使用 androidcd.sh 脚本可以直接在跨度非常大的目录之间跳转，非常方便。

只要执行过 c -s 命令指定了 Android 源码根目录路径，无论当前位于哪个目录下，执行 c -m dl 命令会自动跳转到Android 源码根目录进行全编译。

执行 c +ps 命令，在 ps 路径简写前面加上字符 ‘+’。

那么会切换到 ps 对应的目录下，然后自动执行 Android 的 mm 命令编译该目录下的代码。

前面进行全编译时，已经进行过 Android 的 source、lunch 操作。

这里可以直接使用 mm 命令进行编译。

在 Android 下进行编译，需要先进行 source、lunch 的操作。

目前 Android 没有提供可以判断是否 lunch 过的命令。

为了避免多次 source、lunch，使用字符 ‘+’ 来指定编译时，不会自动 source、lunch。

即，要先 source、lunch，再使用字符 ‘+’ 来指定编译。

可以使用 c -n lunch_combo 命令来进行 source、lunch 操作。

上面 c -m 所给的 dl 参数表示编译默认的 project。

这个 project 由 androidcd.sh 脚本的 DEFAULT_LAUNCH_COMBO 变量指定。

默认配置为最常使用的 project 名称。

可以根据实际需要修改为对应的 project 名称。

如果想要编译其他的 project，在 -m 选项后面提供对应的 lunch 分支即可。

要查看 -m 选项、以及更多选项的用法，可以使用 c -h 命令打印具体的帮助信息。