Linux 系统中怎么编写支持多级调用的日志缩进函数

云涛吖_5965

云涛吖_5965

2026-10-04

291人浏览

原创

linux中实现多级日志缩进有两种纯shell方法:一是利用funcname数组自动计算调用深度并添加空格缩进;二是用全局变量log_depth显式增减,配合log_enter/log_leave/log_msg函数及return trap确保深度准确,更稳定且易扩展。

linux 系统中怎么编写支持多级调用的日志缩进函数

在 Linux 系统中编写支持多级调用的日志缩进函数,核心是**跟踪函数调用深度**,并在每条日志前添加对应数量的缩进(如 2 个空格/层级)。不依赖外部库,纯 Shell 实现即可,关键是利用 Bash 的 FUNCNAME 数组或手动维护调用栈深度。

方法一:用 FUNCNAME 数组自动推导调用深度

FUNCNAME 是 Bash 内置数组,从当前函数开始,逐层记录调用链(FUNCNAME[0] 是当前函数名,FUNCNAME[1] 是上一级,依此类推)。可据此计算缩进空格数:

log() {
    local depth=${#FUNCNAME[@]}
    # 减去 main 和 log 本身(FUNCNAME 包含 "main" 和 "log")
    # 实际调用层级 = depth - 2(若在脚本顶层调用)或 depth - 1(若 log 被函数调用)
    # 更稳妥:排除 "source"、"main"、"log" 后统计非空函数名数量
    local indent=""
    local i
    for ((i=1; i 

说明:

  • 从 i=1 开始遍历,跳过当前 log 函数(FUNCNAME[0])
  • 过滤掉 source、main 等非业务函数,只对真实业务函数计数
  • 每层加两个空格,直观体现嵌套关系
  • 该方式无需手动管理状态,适合调试时快速启用

方法二:用全局变量显式维护调用深度(推荐用于生产)

更可控、兼容性更好(适用于 dash/sh 等非 Bash 场景),通过 LOG_DEPTH 全局变量增减:

LOG_DEPTH=0
<p>log_enter() {
local func="${1:-$FUNCNAME}"
LOG_DEPTH=$((LOG_DEPTH + 1))
local indent=$(printf "%<em>s" $((LOG_DEPTH </em> 2)) "")
echo "[$(date +'%H:%M:%S')]${indent}▶ ENTER $func"
}</p><p>log_leave() {
local func="${1:-$FUNCNAME}"
local indent=$(printf "%<em>s" $((LOG_DEPTH </em> 2)) "")
echo "[$(date +'%H:%M:%S')]${indent}◀ LEAVE $func"
LOG_DEPTH=$((LOG_DEPTH - 1))
}</p><p>log_msg() {
local indent=$(printf "%<em>s" $((LOG_DEPTH </em> 2)) "")
echo "[$(date +'%H:%M:%S')]${indent} $*"
}</p>

使用示例:

Linux installer
Linux installer

先解析安全源,运行本地CLI安装、启动、卸载Linux桌面应用。用户请求时使用。

下载
foo() {
    log_enter "foo"
    log_msg "doing something..."
    bar
    log_msg "done"
    log_leave "foo"
}
<p>bar() {
log_enter "bar"
log_msg "inner work"
log_leave "bar"
}</p>

优点:

  • 行为明确,便于加锁、异步安全(如配合 trap EXIT 防止漏减)
  • 支持自定义进入/离开标记(▶/◀)、不同日志级别
  • 可扩展为带颜色、写文件、过滤关键词等

进阶:支持子 shell 和 trap 自动恢复深度

子 shell 会复制变量但不共享修改,导致 LOG_DEPTH 在管道或 (...) 中失效。可用 trap 确保退出时自动回退:

log_enter() {
    LOG_DEPTH=$((LOG_DEPTH + 1))
    trap 'LOG_DEPTH=$((LOG_DEPTH - 1))' RETURN
    local indent=$(printf "%*s" $((LOG_DEPTH * 2)) "")
    echo "[$(date +'%H:%M:%S')]${indent}▶ $1"
}

RETURN trap 在函数返回时触发,比手动调用 log_leave 更健壮,尤其适合长函数或多分支逻辑。

小技巧:让缩进对齐更清晰

避免空格混用,统一用 printf 生成缩进;时间戳固定宽度;关键操作加符号增强可读性:

  • 用 $(printf "%-8s" "$1") 对齐模块名
  • 错误日志加 ERR 前缀并标红:echo -e "\033[31m[$(date ...)]${indent}ERR $*\033[0m"
  • 重定向到文件时保留颜色需加 script -qec '...' /dev/null 或用 tee 分流

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

linux

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
磁盘配额是什么
磁盘配额是什么

磁盘配额是计算机中指定磁盘的储存限制,就是管理员可以为用户所能使用的磁盘空间进行配额限制,每一用户只能使用最大配额范围内的磁盘空间。php中文网为大家提供各种磁盘配额相关的内容,教程,供大家免费下载安装。

2023.06.21

3810

4

如何安装LINUX
如何安装LINUX

本站专题提供如何安装LINUX的相关教程文章,还有相关的下载、课程,大家可以免费体验。

2023.06.29

3273

10

linux find
linux find

find是linux命令,它将档案系统内符合 expression 的档案列出来。可以指要档案的名称、类别、时间、大小、权限等不同资讯的组合,只有完全相符的才会被列出来。find根据下列规则判断 path 和 expression,在命令列上第一个 - ( ) , ! 之前的部分为 path,之后的是 expression。还有指DOS 命令 find,Excel 函数 find等。本站专题提供linux find相关教程文章,还有相关

2023.06.30

2393

5

linux修改文件名
linux修改文件名

本专题为大家提供linux修改文件名相关的文章,这些文章可以帮助用户快速轻松地完成文件名的修改工作,大家可以免费体验。

2023.07.05

5770

7

linux系统安装教程
linux系统安装教程

linux系统是一种可以免费使用,自由传播,多用户、多任务、多线程、多CPU的操作系统。本专题提供linux系统安装教程相关的文章,大家可以免费体验。

2023.07.06

5422

7

linux查看文件夹大小
linux查看文件夹大小

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。linux怎么查看文件夹大小呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.20

3193

8

linux查看ip命令
linux查看ip命令

本专题为大家提供linux查看ip命令相关文章内容,感兴趣的朋友可以免费下载体验试试。

2023.07.20

2705

4

linux查看cpu使用率
linux查看cpu使用率

在linux的系统维护中,可能需要经常查看cpu使用率,分析系统整体的运行情况。本专题为大家带来了linux查看cpu使用率的相关文章,感兴趣的朋友千万不要错过了。

2023.07.25

2919

6

linux查找文件命令
linux查找文件命令

Linux是一种自由和开放源码的类Unix操作系统,存在着许多不同的Linux版本,但它们都使用了Linux内核。Linux可安装在各种计算机硬件设备中,比如手机、平板电脑、路由器、视频游戏控制台、台式计算机、大型机和超级计算机。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.31

277

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习