LinuxShell函数封装方法_脚本复用设计思路【教程】

应将重复逻辑封装为Shell函数以提升复用性与可维护性，具体包括：基础定义调用、函数文件分离、参数校验、局部变量隔离及模块化命名规范。

如果您希望在多个Shell脚本中重复使用某段逻辑，避免代码冗余与维护困难，则需要将该逻辑封装为可调用的函数。以下是实现Linux Shell函数封装与脚本复用的设计方法：

一、基础函数定义与调用

Shell函数通过function关键字或直接使用函数名加括号的方式声明，其作用域默认为当前脚本，便于局部逻辑抽象和复用。

1、在脚本开头或逻辑块前定义函数，语法为：函数名() { 命令序列; }

2、在脚本任意位置调用该函数，仅需写入函数名并传入参数，如：my_log "info" "service started"

3、函数内使用$1、$2等访问参数，使用$#获取参数个数，使用$?捕获上一条命令退出状态。

二、函数文件分离与source引入

将常用函数集中存放在独立的.sh文件中，通过source命令加载，实现跨脚本共享，避免重复定义。

1、新建公共函数文件lib_utils.sh，内容包含多个函数定义，如log_info()、check_file_exists()等。

2、在主脚本顶部添加：source ./lib_utils.sh

3、确保lib_utils.sh具有读取权限：chmod +r lib_utils.sh

三、参数校验与错误处理封装

为提升函数健壮性，将参数合法性检查与错误响应逻辑统一封装，使各业务函数调用时自动具备防御能力。

1、定义通用校验函数require_arg()，接收参数名与实际值，若为空则打印错误并退出。

2、在业务函数内部首行调用：require_arg "config_path" "$1"

3、设置set -e使脚本在任一命令失败时终止，配合函数内return 1实现可控中断。

四、环境隔离与作用域控制

使用local关键字声明变量，防止函数内部变量污染全局命名空间，保障多函数并发调用时的状态独立性。

1、在函数体起始处声明所需局部变量：local result timeout_val

2、对所有非返回值用途的中间变量均加local前缀，包括循环计数器、临时路径等。

3、避免在函数中直接修改全局变量，如需输出结果，统一通过echo返回，并由调用方用$(...)捕获。

五、模块化函数分组与命名规范

按功能领域对函数分类命名，采用前缀+动词+名词结构，增强可读性与可检索性，支撑大型脚本工程化组织。

1、网络相关函数统一以net_开头，如net_wait_port()、net_is_reachable()。

2、文件操作函数以fs_开头，如fs_backup_file()、fs_ensure_dir()。

3、在函数注释头部标明用途、参数说明及示例调用，格式为：# @desc: 检查端口是否就绪；@param: $1=host $2=port；@example: net_wait_port localhost 8080