当前位置:首页>Linux>Linux Shell 函数库与脚本复用——建立自己的工具箱

Linux Shell 函数库与脚本复用——建立自己的工具箱

  • 2026-09-22 12:24:54
Linux Shell 函数库与脚本复用——建立自己的工具箱

大家好,我是冯哥的缓存。

上篇我们了解了Shell 脚本编写的基础——变量、条件、循环、函数、调试,还写了三个实用脚本(备份、重命名、磁盘监控)。

写完三个脚本之后,可能会发现一个问题:很多功能是重复的。比如"打印带颜色的信息"这个函数,备份脚本里要用,磁盘监控脚本里也要用,难道每次都复制粘贴一遍?

更严重的是,脚本多了以后:

1、不知道哪个脚本放哪了

2、换个机器,所有脚本都要重新配

3、想改一个通用功能,得改 N 个文件

这一篇,我们就来系统地聊一下怎么解决这些问题——把常用功能抽成函数库,建立自己的 Shell 工具箱。

一、为什么需要函数库

1.1 脚本越来越多的痛点

假设已经写了这些脚本:

~/bin/

├── backup.sh# 备份脚本

├── rename.sh# 批量重命名

├── disk_check.sh# 磁盘监控

├── git_pull_all.sh# 批量拉取 Git 仓库

└── serve.sh# 快速起一个 HTTP 服务器

然后发现:

痛点

具体表现

代码重复

每个脚本里都有 print_info()、print_error() 这些彩色输出函数

不好维护

想改一下颜色格式,得打开 5 个文件逐个改

找不到

半年后忘了 serve.sh 放哪了,又重新写了一个

换机器就丢

新电脑上所有脚本都要重新建,配置也要重新写

没有文档

忘了某个脚本接受什么参数,只能打开看源码

函数库就是用来解决这些问题的——把通用功能抽出来,集中管理,随时调用。

1.2 函数库的核心思想

┌─────────────────────────────────────────────┐

│函数库(mylib.sh)│

│┌───────────┐┌───────────┐┌──────┐│

││ print_info ││ disk_usage ││ ...││

││ print_err││ ip_addr││││

││ confirm││ is_root││││

│└───────────┘└───────────┘└──────┘│

└──────────────────┬──────────────────────────┘

│ source mylib.sh

┌─────────┼─────────┐

▼▼▼

backup.shrename.shdisk_check.sh

(直接调用库里的函数,不用重复写)

一句话总结:函数库就是一个装满了"零件"的工具箱,脚本直接拿零件组装,不用每次从零造轮子。

二、建立函数库——从零开始

2.1 第一步:规划目录结构

先建立一个规范的目录结构:

bash

# 在主目录下创建工具箱目录,Ubuntu 默认会把~/.local/bin 加入 PATH,但 ~/bin 需要手动加。

mkdir -p ~/bin/lib

mkdir -p ~/bin/scripts

最终结构是这样的:

~/bin/

├── lib/# 函数库文件(被 source 的)

│├── mylib.sh# 通用函数库

│├── gitlib.sh# Git 相关函数

│└── syslib.sh# 系统相关函数

├── scripts/# 可直接执行的脚本

│├── backup.sh

│├── rename.sh

│└── disk_check.sh

└── mylib.sh -> lib/mylib.sh# 可选:在 ~/bin 根目录放个软链接

⚠️注意:~/.local/bin是系统推荐的用户二进制目录,但 ~/bin更短更好记,两者选一个坚持用就行。记得把 ~/bin加到 PATH里(上篇讲过)。

2.2 写一个基础函数库

在~/bin/lib/mylib.sh里写入以下内容:

bash

#!/bin/bash

# ============================================================

# mylib.sh —— 个人 Shell 函数库

# 使用方法:在脚本开头加 source ~/bin/lib/mylib.sh

# ============================================================

# 如果此文件已经被 source 过,直接返回(防止重复加载)

[[ -n "${MYLIB_LOADED:-}" ]] && return 0

readonly MYLIB_LOADED=1

# 如果需要在运行时重新加载库,先 unset MYLIB_LOADED 再 source。

# ============================================================

# 一、彩色输出函数

# ============================================================

# 颜色定义(方便后面直接用)

readonly RED='\033[0;31m'

readonly GREEN='\033[0;32m'

readonly YELLOW='\033[1;33m'

readonly BLUE='\033[0;34m'

readonly CYAN='\033[0;36m'

readonly BOLD='\033[1m'

readonly NC='\033[0m'# No Color

# 打印普通信息(绿色)

print_info() {

echo -e "${GREEN}[INFO]${NC} $*"

}

# 打印警告(黄色)

print_warn() {

echo -e "${YELLOW}[WARN]${NC} $*" >&2

}

# 打印错误(红色)

print_error() {

echo -e "${RED}[ERROR]${NC} $*" >&2

}

# 打印调试信息(青色,只在 DEBUG=1 时输出)

print_debug() {

[[ "${DEBUG:-0}" == "1" ]] && echo -e "${CYAN}[DEBUG]${NC} $*" >&2

}

# 打印成功信息(粗体绿色)

print_success() {

echo -e "${BOLD}${GREEN}✔ $*${NC}"

}

# ============================================================

# 二、系统信息函数

# ============================================================

# 获取本机 IP 地址(优先返回第一个非 lo 的 IPv4)

get_ip() {

ip -4 -o addr show scope global 2>/dev/null \

| awk '{print $4}' \

| cut -d/ -f1 \

| head -n1

}

# 获取当前发行版名称

get_distro() {

if [[ -f /etc/os-release ]]; then

source /etc/os-release

echo"$NAME"

else

uname -s

fi

}

# 检查是否为 root 用户

is_root() {

[[ "$(id -u)" -eq 0 ]]

}

# 检查命令是否存在

cmd_exists() {

command -v "$1" &>/dev/null

}

# 检查某个端口是否被占用

port_used() {

local port="$1"

if cmd_exists ss; then

ss -tuln | grep -q ":$port "

elif cmd_exists netstat; then

netstat -tuln | grep -q ":$port "

else

print_error "ss 和 netstat 都不存在,无法检查端口"

return 2

fi

}

# ============================================================

# 三、文件操作函数

# ============================================================

# 创建备份(自动加时间戳)

backup_file() {

local file="$1"

if [[ ! -f "$file" ]]; then

print_error "文件不存在:$file"

return 1

fi

local backup="${file}.$(date +%Y%m%d_%H%M%S).bak"

cp"$file""$backup"

print_info "已备份为:$backup"

}

# 安全删除(移动到 ~/.trash,而不是真的删除)

safe_rm() {

local trash_dir="$HOME/.trash"

mkdir -p "$trash_dir"

for file in"$@"; do

if [[ -e "$file" ]]; then

mv"$file""$trash_dir/"

print_info "已移动到回收站:$file"

else

print_warn "不存在,跳过:$file"

fi

done

}

# 在文件中查找内容(支持忽略大小写)

search_file() {

local pattern="$1"

local file="${2:-}"

if [[ -z "$file" ]]; then

# 没指定文件,就在当前目录递归搜索,如果目录很大,建议指定具体文件名以避免全目录扫描。

grep -rin "$pattern" . 2>/dev/null

else

grep -in"$pattern""$file"

fi

}

# ============================================================

# 四、确认提示函数

# ============================================================

# 用法:confirm "确定要删除吗" && rm file

confirm() {

local prompt="${1:-确认执行此操作?(y/N)}"

local response

read -r -p "$prompt " response

[[ "$response" =~ ^[Yy]$ ]]

}

# 必须确认(输 yes 才通过,用于危险操作)

must_confirm() {

local prompt="${1:-请输入 YES 确认:}"

local response

read -r -p "$prompt " response

[[ "$response" == "YES" ]]

}

# ============================================================

# 五、错误处理辅助

# ============================================================

# 在脚本里用:set -euo pipefail 开启严格模式

# 然后可以用 trap 捕获错误,打印出错行号

setup_error_trap() {

trap'print_error "脚本在第 $LINENO 行出错,命令:$BASH_COMMAND"' ERR

}

# 打印上次命令的退出码

last_exit() {

echo"上次命令退出码:$?"

}

# ============================================================

# 六、网络检测函数

# ============================================================

# 检查网络连通性

net_check() {

local host="${1:-8.8.8.8}"

if ping -c 1 -W 2 "$host" &>/dev/null; then

print_success "网络连通($host可达)"

return 0

else

print_error "网络不通($host不可达)"

return 1

fi

}

# 检查某个网址是否可访问(HTTP 状态码)

url_check() {

local url="$1"

local code

code=$(curl -s -o /dev/null -w "%{http_code}""$url" 2>/dev/null)

if [[ "$code" =~ ^[23] ]]; then

print_success "$url可访问(HTTP $code)"

return 0

else

print_error "$url不可访问(HTTP $code)"

return 1

fi

}

# ============================================================

# 加载完成提示(可选,第一次 source 时显示)

# ============================================================

print_debug "mylib.sh 加载完成(调试模式开启)"

把以上内容保存为~/bin/lib/mylib.sh。

2.3 在脚本里使用函数库

写一个使用函数库的脚本,比如~/bin/scripts/disk_check.sh:

bash

#!/bin/bash

# disk_check.sh —— 磁盘空间监控(使用函数库版本)

# 加载函数库(如果找不到,尝试常见路径)

if [[ -f "$HOME/bin/lib/mylib.sh" ]]; then

source"$HOME/bin/lib/mylib.sh"

elif [[ -f "/usr/local/lib/mylib.sh" ]]; then

source"/usr/local/lib/mylib.sh"

else

echo"找不到 mylib.sh,请先安装函数库" >&2

exit 1

fi

# 现在可以直接用库里的函数了

print_info "开始检查磁盘空间..."

echo"----------------------------------------"

# 检查根分区使用率

root_usage=$(df / | awk 'NR==2 {gsub(/%/,""); print $5}')

if [[ "$root_usage" -ge 80 ]]; then

print_error "根分区使用率 ${root_usage}%,请及时清理!"

else

print_info "根分区使用率 ${root_usage}%(正常)"

fi

# 检查 home 分区

home_usage=$(df"$HOME" | awk 'NR==2 {gsub(/%/,""); print $5}')

if [[ "$home_usage" -ge 80 ]]; then

print_error "HOME 分区使用率 ${home_usage}%,请及时清理!"

else

print_info "HOME 分区使用率 ${home_usage}%(正常)"

fi

echo"----------------------------------------"

print_info "本机 IP:${CYAN}$(get_ip)${NC}"

💡提示:source和 .是等价的,source ~/bin/lib/mylib.sh也可以写成 . ~/bin/lib/mylib.sh。

三、让函数库随处可用

3.1 把函数库加入 bashrc

上面的方法在每个脚本里都要写一遍source路径,太麻烦。更好的办法是在 ~/.bashrc里统一加载,这样所有脚本(以及交互式终端)都能直接用库里的函数。

在~/.bashrc末尾加上:

bash

# ============================================================

# 加载个人函数库

# ============================================================

MY_LIB="$HOME/bin/lib/mylib.sh"

if [[ -f "$MY_LIB" ]]; then

source"$MY_LIB"

export -p MYLIB_LOADED

else

echo"⚠️找不到函数库:$MY_LIB" >&2

fi

# 也把 ~/bin 加入 PATH(如果还没加的话)

if [[ ":$PATH:" != *":$HOME/bin:"* ]]; then

export PATH="$HOME/bin:$HOME/bin/scripts:$PATH"

fi

保存后执行source ~/.bashrc,现在直接在终端里试试:

bash

print_info "Hello, World!"

print_success "函数库已加载"

get_ip

如果都能正常输出,说明函数库已经全局可用了 ✅

3.2 处理 bashrc 和脚本的冲突

有一个常见的坑:如果在~/.bashrc里 source了函数库,那么每个新开的终端都会加载它。这通常是好事,但要注意:

场景

问题

解决办法

函数库里有 echo 输出

每次开终端都会看到输出

把输出改成 print_debug,只在 DEBUG=1 时显示

脚本在 cron 里运行

cron 的环境不加载 ~/.bashrc

脚本里还是需要显式 source 函数库

函数名冲突

不同库定义了同名函数

给函数加统一前缀,如 my_print_info()

推荐的防护写法(在函数库开头): 给不同库的函数加前缀,如my_color_info()、git_status(),避免命名冲突。

bash

# 防止在非交互式 Shell(如 cron)里产生输出

if [[ "$-" != *i* ]] && [[ "${QUIET_LOAD:-0}" == "1" ]]; then

# 非交互式且要求安静,不输出任何东西

:

fi

四、错误处理与脚本健壮性

4.1set -euo pipefail是什么

在函数库或脚本开头加上这行,可以让脚本更健壮:

bash

set -euo pipefail

选项

全称

作用

-e

exit on error

任何命令返回非零退出码时,脚本立即退出

-u

unset variables

使用未定义的变量时,脚本立即退出(防止拼写错误)

-o pipefail

pipe failure

管道中任何一个命令失败,整个管道返回失败

示例:没有set -e时

bash

#!/bin/bash

rm /nonexistent/file# 失败,但脚本继续运行

echo"这一行还是会执行"# 会执行(这可能是想要的,也可能不是)

加了set -e后

bash

#!/bin/bash

set -e

rm /nonexistent/file# 失败,脚本立即退出

echo"这一行不会执行"

⚠️注意:set -e不是银弹。有些命令失败是预期的(比如 grep没找到匹配返回 1),这时需要用 command || true来抑制退出。

4.2 在函数库里用好 trap

trap可以在脚本收到信号(如 Ctrl+C、错误或正常退出)时执行清理操作:

bash

# 在函数库里加一个通用的清理函数模板

cleanup() {

local exit_code=$?

print_debug "脚本退出,退出码:$exit_code"

# 这里可以加清理临时文件的代码

# rm -f /tmp/myapp.$$.tmp

exit$exit_code

}

# 捕获常见退出信号

trap cleanup EXIT INT TERM

把这些加到函数库的末尾,每个脚本source之后都会自动有错误处理能力。

五、把函数库拆分成多个文件

当一个函数库越来越大,建议按功能拆分成多个文件:

~/bin/lib/

├── mylib.sh# 主入口(负责加载其他库)

├── color.sh# 颜色输出相关

├── system.sh# 系统信息相关

├── file.sh# 文件操作相关

├── network.sh# 网络检测相关

└── gitlib.sh# Git 相关

然后mylib.sh改成这样:

bash

#!/bin/bash

# mylib.sh —— 主入口,自动加载所有子库

MYLIB_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

# 加载所有子库

for lib in"$MYLIB_DIR"/color.sh \

"$MYLIB_DIR"/system.sh \

"$MYLIB_DIR"/file.sh \

"$MYLIB_DIR"/network.sh; do

if [[ -f "$lib" ]]; then

source"$lib"

print_debug "已加载:$(basename "$lib")"

else

echo"⚠️找不到库文件:$lib" >&2

fi

done

readonly MYLIB_LOADED=1

print_debug "mylib 全部加载完成"

💡提示:${BASH_SOURCE[0]}获取当前脚本的路径,比 $0更可靠(0在source场景下是bash自身的路径,而0在source场景下是bash自身的路径,而{BASH_SOURCE[0]} 是当前被source 的文件的路径。)。

六、实用函数库模板——直接可用的版本

下面是一份精简但完整可用的函数库,可以直接保存到~/bin/lib/mylib.sh:

完整代码见上文第二节的mylib.sh示例,这里不再重复。建议把第二节的版本直接复制使用,它已经包含了:

彩色输出(6个函数)

系统信息(5个函数)

文件操作(3个函数)

确认提示(2个函数)

网络检测(2个函数)

共18个实用函数,覆盖日常脚本 80% 的需求。

七、让工具箱跟着走——dotfiles 思路预告

现在函数库已经很好用了,但还有一个问题没解决:换一台机器,所有东西都要重新配。

解决方案是用 Git 管理配置文件(dotfiles),把~/.bashrc、~/bin/这些内容推到 GitHub/Gitee,换机器时一条命令还原。

这涉及到:

哪些文件该纳入 Git 管理

怎么处理敏感信息(比如~/.ssh/不能推到公开仓库)

怎么用软链接让配置文件保持同步

怎么一键部署到新机器

这些内容比较多,我们下一篇聊。

八、本文速查表

函数库基础操作

操作

命令

加载函数库

source ~/bin/lib/mylib.sh 或 . ~/bin/lib/mylib.sh

检查是否已加载

[[ -n "$MYLIB_LOADED"   ]] && echo "已加载"

防止重复加载

在函数库开头加 [[ -n   "$MYLIB_LOADED" ]] && return 0

查看库里有哪些函数

grep -E   "^[a-zA-Z_][a-zA-Z0-9_]*$$" ~/bin/lib/mylib.sh

set选项说明

选项

作用

推荐场景

set -e

出错即停

所有脚本都建议开启

set -u

禁止未定义变量

建议开启,排错很有用

set -o pipefail

管道任一处失败即失败

建议开启

set -x

打印每条执行的命令(调试)

调试时临时开启

目录结构规范

~/bin/# 加入 PATH

├── lib/# 函数库(被 source)

│└── mylib.sh

└── scripts/# 可执行脚本

└── *.sh

下篇预告:《Linux多机器配置同步——dotfiles 管理与一键部署》,函数库建好了,脚本也好维护了,但换台机器还是要从零开始配,如何用 Git 管理所有配置文件,换机器一条命令还原全套环境,再也不重复劳动。

最新文章

随机文章