Shell函数怎么在大型项目中将公用函数抽离到独立文件并跨文件调用

秋静同学_2625

秋静同学_2625

2026-07-22

907人浏览

原创

函数库文件需只定义函数、不执行命令,通过加载守卫、local变量、小写下划线命名及显式初始化确保安全复用。

shell函数怎么在大型项目中将公用函数抽离到独立文件并跨文件调用

把公用函数抽离到独立文件并在多个脚本中复用,核心就两点:用 source 加载,靠 规范写法 避免冲突和污染。

函数库文件怎么写才安全可靠

独立函数文件(比如 lib_common.sh)不是随便堆函数,得遵守几个硬性习惯:

  • 只写函数定义,不执行任何命令(比如不直接调用 log_info "start",也不读取用户输入)
  • 函数名全小写+下划线,如 is_dir_empty、parse_config_line,避免和 ls、echo 等系统命令重名
  • 加加载守卫,防止重复 source 导致函数重定义:[[ ${LIB_COMMON_SH_LOADED} ]] && return; LIB_COMMON_SH_LOADED=1
  • 所有临时变量都用 local 声明,比如 local tmp_file=$(mktemp),否则不同函数用同名变量(如 i、ret)会互相覆盖
  • 不依赖未声明的全局变量;如果需要配置项(如日志路径),要么通过参数传入,要么提供单独的 init_logging() 函数由主脚本显式调用

主脚本里怎么正确引入和使用

加载必须放在脚本开头,且路径要写清楚:

  • 同目录:用 source ./lib_common.sh
  • 子目录:用 source ./lib/network.sh
  • 统一安装路径(如 /opt/myapp/lib/):用绝对路径 source /opt/myapp/lib/log.sh
  • 想走 PATH 查找(类似 which):可用 source "$(command -v mylib.sh 2>/dev/null)",前提是已把库路径加入 PATH

加载完成后,函数就和本地定义的一样,直接调用即可,比如 is_file_readable "/etc/passwd" 或 result=$(get_timestamp)。

疯火轮AI
疯火轮AI

一款AI办公效率工具,主要用于营销人的AI工作台,适合需要提升相关任务效率的用户。

下载

跨文件传参和结果传递的实际做法

Shell 没有“返回值对象”,函数间传数据靠两种方式,选哪种看场景:

  • 命令替换捕获输出:函数用 echo 输出结果,主脚本用 $(func_name arg1 arg2) 拿回字符串。适合返回路径、ID、状态文本等,例如:conf_path=$(find_config_file "db")
  • 全局变量中转:适用于多个函数协同处理同一组数据(比如 parse_ini 解析后把键值存进 INI_SECTIONS 数组,后续 get_ini_value 直接查)。注意变量名加前缀防冲突,如 MYAPP_TMP_DIR

别用 return 传业务数据——它只能返回 0–255 的整数,且 $? 一被下条命令覆盖就丢了。

大型项目里的路径与维护建议

脚本多了容易乱,建议固定结构:

  • 建 lib/ 目录放所有函数库,按功能分文件:lib/io.sh、lib/net.sh、lib/str.sh
  • 主脚本用相对路径加载,如 source "$(dirname "$0")/lib/io.sh",这样无论从哪启动都能定位
  • 每个库文件顶部加简短注释说明用途和依赖,比如 # 提供文件锁、临时目录管理、原子写入等IO工具
  • 上线前用 shellcheck 扫描所有 .sh 文件,重点检查未声明变量、未引号包裹的参数、local 缺失等问题

相关专题

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

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

2023.06.21

3890

4

如何安装LINUX
如何安装LINUX

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

2023.06.29

3333

10

linux find
linux find

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

2023.06.30

2473

5

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

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

2023.07.05

5990

7

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

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

2023.07.06

5622

7

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

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

2023.07.20

3313

8

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

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

2023.07.20

2805

4

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

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

2023.07.25

3039

6

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

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

2023.07.31

277

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
尚观shell视频教程
尚观shell视频教程

共8课时 | 1.9万人学习

Linux开发视频教程
Linux开发视频教程

共18课时 | 4.6万人学习

Perl 入门教程
Perl 入门教程

共29课时 | 31.2万人学习