Bash如何简化调试输出 实现DBG命令自动携带代码位置信息

原有方案失效的核心原因 #

Bash 中直接在函数内部读取$LINENO、${FUNCNAME[0]}、$0拿到的是函数自身执行上下文的值，不是调用DBG那一行的上下文；alias别名属于纯文本替换，要么变量在定义时就被固定展开，要么进入函数作用域后丢失调用点位置信息；eval方案存在代码注入风险，且很难精准控制变量展开时机，都无法满足需求。

Bash 内置了完整的调用栈变量数组，可以直接在函数内部拿到调用点的准确位置，不需要调用方手动拼接前缀：

• ${BASH_SOURCE[1]##*/}：调用DBG的脚本文件名（去掉路径）
• ${FUNCNAME[1]:-GLOBAL}：调用DBG时所在的函数名，全局作用域调用时显示为GLOBAL
• ${BASH_LINENO[0]}：调用DBG的行号

修正后的完整实现代码 #

# 先定义日志文件路径
LOG="/path/to/your/debug.log"
DVAR=()

function DBG() {
    # 自动获取调用点位置，生成统一前缀
    local call_script="${BASH_SOURCE[1]##*/}"
    local call_func="${FUNCNAME[1]:-GLOBAL}"
    local call_line="${BASH_LINENO[0]}"
    local log_prefix="${call_script}:${call_func}:${call_line} === "

    # 保留原有的打印栈逻辑
    if [[ $1 == -s ]]; then 
        shift
        stackTrace
    fi

    # 新增队列缓存参数：加-q表示把日志存入DVAR暂存，不立即写入文件
    if [[ $1 == -q ]]; then
        shift
        DVAR+=("${log_prefix}$*")
        return
    fi

    # 批量输出DVAR中缓存的所有日志，输出后清空队列
    if [[ ${#DVAR[@]} -gt 0 ]]; then
        printf "%s\n" "${DVAR[@]}" >> "$LOG"
        DVAR=()
    fi

    # 输出当前传入的即时日志
    if [[ $# -gt 0 ]]; then
        echo "${log_prefix}$*" >> "$LOG"
    fi
}

使用方式 #

• 即时输出日志：完全不需要手动拼接位置前缀，直接按你期望的格式写即可：

DBG assorted local variables and stuff here

写入日志的内容会自动带上位置前缀，格式为脚本名:函数名:行号 === 日志内容。

• 批量缓存输出：如果需要先暂存日志、后续统一批量输出，在调用时加-q参数即可，同样不需要手动拼前缀：

# 以下两行不会立即写日志，会自动带上当前行位置存入DVAR队列
DBG -q first debug content at line 42
DBG -q second debug content at line 57

# 任意位置调用DBG，会先把队列里缓存的所有日志批量写入文件，再输出当前行的日志
DBG flush all cached logs

原有代码的问题修正 #

• 原代码数组追加写法DVAR+="xxx"是错误语法，该写法会把内容追加到数组第一个元素末尾，不会新增独立数组元素，正确追加方式为DVAR+=("元素内容")
• 原代码循环unset清空数组效率极低，直接赋值DVAR=()即可一次性清空整个数组
• 原代码中continue关键字只能在循环结构内使用，写在函数中非循环上下文会直接报错，已移除该无效逻辑。

内容的提问来源于stack exchange，提问作者BenG