【运维】linux shell 编程之函数使用

淩亂°似流年 2023-10-02 22:08 75阅读 0赞

## 前言 ##

使用linux的shell编程，可以说函数是非常重要的内容，也是在编写各类shell脚本的时候经常用到的，本篇将介绍下函数相关的使用。

## shell 函数分类 ##

*  系统函数
 *  自定义函数

## 系统函数 ##

系统函数为linux自带的函数, 可以在shell编写中直接使用。下面介绍几种常用的系统函数

### 1、basename ###

> 用于获取文件名函数, 根据给出的文件路径截取出文件名；

#### 语法 ####

> basename \[string / pathname\] \[suffix\]

*  根据根据指定字符串或路径名进行截取文件名, 比如: 根据路径"/root/shells/aa.txt", 可以截取出aa.txt；
 *  suffix: 用于截取的时候去掉指定的后缀名；

#### 简单案例 ####

比如在当前目录下，有一个叫ch1.sh的文件，使用该命令的效果如下

![14dd486a60e64e74b3b2c01dd7f48d19.png][]

**该命令的用途**

*  遍历某个文件目录之后，可以使用该命令拿到该目录下的文件名称做后续处理；
 *  拿到文件名称之后，更改某个匹配的文件的权限等；

### 2、dirname ###

> 从指定文件的绝对路径, 去除文件名，返回剩下的前缀目录路径

#### 语法 ####

> dirname 文件绝对路径

#### 简单案例 ####

![c50aa3cbe7b94a36b1e7a125adb6d055.png][]

更多的系统函数，可以使用: declare -f 命令进行查看

## 自定义函数 ##

shell编程人员可以通过自定义开发函数,实现代码重用，提升模块的封装性、可读性以及可维护性；

### 语法 ###

> \# 函数的定义  
> \[ function \] funname ()  
> \{  
> 命令  
> \[return 返回值\]
> 
> \}
> 
> \# 调用函数  
> funname 传递参数1 传递参数2 ...

**语法说明**

*  可以带function fun() 定义，也可以直接fun() 定义,不带任何参数；
 *  参数返回，可以显示加：return 返回，如果不加，将以最后一条命令运行结果，作为返回值， return后跟数值n(0~255)；

**注意点**

> 必须在调用函数地方之前，先声明函数再调用，shell脚本是逐行运行的, 只有先运行了函数, 后面的动作才可以使用函数；

#### 案例1：**无参无返回值函数** ####

#!/bin/bash
    
    hello(){
    
            echo "hello func"
    
    }
    
    
    hello

调用下这个脚本，观察效果展示

![d2fd792a2db54af1949503b9dfe4728c.png][]

#### 案例2：无参有返回值函数 ####

#! /bin/bash
    
    function sum(){
    
        echo "求两个数的和..."
        read -p "请输入第一个数字: " n1
        read -p "请输入第二个数字: " n2
        echo "两个数字分别为 $n1 和 $n2 "
        return $(($n1+$n2))
    }
    
    sum
    
    echo "两个数字的和为: $? "  # 获取函数返回值

运行上面的shell，观察输出效果

![6cf8690aef6e49ac8fb8b7c04cee7454.png][]

#### 案例3：有参函数 ####

> 在Shell中，调用函数时可以向其传递参数。在函数体内部，通过 `$n` 的形式来获取参数的值，例如，`$1` 表示第一个参数，`$2` 表示第二个参数...

**其他参数介绍**

<table> 
 <thead> 
  <tr> 
   <th>参数处理</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>$#</td> 
   <td>传递到脚本或函数的参数个数</td> 
  </tr> 
  <tr> 
   <td>$*</td> 
   <td>以一个单字符串显示所有向脚本传递的参数</td> 
  </tr> 
  <tr> 
   <td>$$</td> 
   <td>脚本运行的当前进程ID号</td> 
  </tr> 
  <tr> 
   <td>$!</td> 
   <td>后台运行的最后一个进程的ID号</td> 
  </tr> 
  <tr> 
   <td>$@</td> 
   <td>与$*相同，但是使用时加引号，并在引号中返回每个参数。</td> 
  </tr> 
  <tr> 
   <td>$?</td> 
   <td>显示最后命令的退出状态。0表示没有错误，其他任何值表明有错误。</td> 
  </tr> 
 </tbody> 
</table>

#### 案例介绍 ####

使用上面的参数编写一个输出用户输入参数的示例

#!/bin/bash
    funParam(){
        echo "第一个参数为 $1 !"
        echo "第二个参数为 $2 !"
        echo "第十个参数为 $10 !"
        echo "第十个参数为 ${10} !"
        echo "第十一个参数为 ${11} !"
        echo "参数总数有 $# 个!"
        echo "作为一个字符串输出所有参数 $* !"
    }
    
    funParam 1 2 3 4 5 6 7 8 9 10 11 12 15

调用上面的脚本观察效果

![9e009b3aa7844fbdade40fbc4a58a7e3.png][]

##  ##

## 补充：Shell程序与函数的区别 ##

函数和shell程序比较相似，区别在于：

*  Shell 程序(内置命令和外部脚本文件), 外部脚本文件是在子Shell中运行, 会开启独立的进程运行；
 *  Shell函数在当前Shell的进程中运行；

## linux shell编程常用案例介绍 ##

以下结合前面关于shell编程技术点的介绍，列举常用的一些可以使用shell编程来处理的场景

### 1、日志（数据）备份 ###

比如生产环境下，为了保留每天的核心日志，可以使用定时任务，调度某个shell脚本，在脚本中编写程序用于备份日志数据

![758254ac11de42f8b24c5f82e93ff8b9.png][]

**参考示例**

#!/bin/bash  
    
    tar  -zcvf  log-`date +%Y-%m-%d`.tar.gz log-`date +%Y-%m-%d` /var/log

### 2、监控内存和磁盘容量，小于给定值时报警 ###

当生产服务器的内存和磁盘容量不足时，可以通过编写shell进行监控报警

**参考示例**

#!/bin/bash  
      
      
    # 提取根分区剩余空间  
    disk_size=$(df / | awk '/\//{print $4}')  
      
    # 提取内存剩余空间  
    mem_size=$(free | awk '/Mem/{print $4}')  
    while :  
    do  
    # 注意内存和磁盘提取的空间大小都是以 Kb 为单位  
    if  [  $disk_size -le 512000 -a $mem_size -le 1024000  ]  
    then  
        mail  ‐s  "Warning"  root  <<EOF  
      Insufficient resources,资源不足  
    EOF  
    fi  
    done

### 3、查看有多少远程 IP 连接本机 ###

#### 参考示例 ####

#!/bin/bash  
      
    # 查看多少远程 IP 连接本机(不管是通过 ssh 还是 web 还是 ftp 都统计)   
    # 使用 netstat ‐atn 可以查看本机所有连接的状态,‐a 查看所有,  
    # -t仅显示 tcp 连接的信息,‐n 数字格式显示  
    # Local Address(第四列是本机的 IP 和端口信息)  
    # Foreign Address(第五列是远程主机的 IP 和端口信息)  
    # 使用 awk 命令仅显示第 5 列数据,再显示第 1 列 IP 地址的信息  
    # sort 可以按数字大小排序,最后使用 uniq 将多余重复的删除,并统计重复的次数  
    
    netstat -atn  |  awk  '{print $5}'  | awk  '{print $1}' | sort -nr  |  uniq -c

### 4、编写nginx启动脚本 ###

在实际的运维中，很多中间件服务，为了方便管理各个中间件服务，可以考虑将其做成各类启动脚本，统一维护，下面以nginx为例说明（其他的，比如redis，zk等可以类似的参考进行编写）；

#!/bin/bash  
      
    # 脚本编写完成后,放置在/etc/init.d/目录下,就可以被 Linux 系统自动识别到该脚本  
    # 如果脚本名为/etc/init.d/nginx,则 service nginx start 就可以启动该服务  
    # service nginx stop 就可以关闭服务  
    # service nginx restart 可以重启服务  
    # service nginx status 可以查看服务状态  
    program=/usr/local/nginx/sbin/nginx  
    pid=/usr/local/nginx/logs/nginx.pid  
    start(){  
    if [ -f $pid ];then  
      echo  "nginx 服务已经处于开启状态"  
    else  
      $program  
    fi  
    stop(){  
    if [ -! -f $pid ];then  
      echo "nginx 服务已经关闭"  
    else  
      $program -s stop  
      echo "关闭服务 ok"  
    fi  
    }  
    status(){  
    if [ -f $pid ];then  
      echo "服务正在运行..."  
    else  
      echo "服务已经关闭"  
    fi  
    }  
      
    case $1 in  
    start)  
      start;;  
    stop)  
      stop;;  
    restart)  
      stop  
      sleep 1  
      start;;  
    status)  
      status;;  
    *)  
      echo  "你输入的语法格式错误"  
    esac

[14dd486a60e64e74b3b2c01dd7f48d19.png]: https://img-blog.csdnimg.cn/14dd486a60e64e74b3b2c01dd7f48d19.png
[c50aa3cbe7b94a36b1e7a125adb6d055.png]: https://img-blog.csdnimg.cn/c50aa3cbe7b94a36b1e7a125adb6d055.png
[d2fd792a2db54af1949503b9dfe4728c.png]: https://img-blog.csdnimg.cn/d2fd792a2db54af1949503b9dfe4728c.png
[6cf8690aef6e49ac8fb8b7c04cee7454.png]: https://img-blog.csdnimg.cn/6cf8690aef6e49ac8fb8b7c04cee7454.png
[9e009b3aa7844fbdade40fbc4a58a7e3.png]: https://img-blog.csdnimg.cn/9e009b3aa7844fbdade40fbc4a58a7e3.png
[758254ac11de42f8b24c5f82e93ff8b9.png]: https://img-blog.csdnimg.cn/758254ac11de42f8b24c5f82e93ff8b9.png