如何在 Linux Shell 編程中定義和使用函數

本文我們將討論諸多關於函數的內容和一些使用技巧。為了方便演示，我將在 Ubuntu 系統上使用 Bourne Again SHell (Bash)。

調用函數

在 Shell 中調用函數和調用其它命令是一模一樣的。例如，如果你的函數名稱為 my_func，你可以在命令行中像下面這樣執行它：

$ my_func

如果你的函數接收多個參數，那麼可以像下面這樣寫（類似命令行參數的使用）：

$ my_func arg1 arg2 arg3

定義函數

我們可以用下面的語法去定義一個函數：

function function_name {
    Body of function
}

函數的主體可以包含任何有效的命令、循環語句和其它函數或腳本。現在讓我們創建一個簡單的函數，它向屏幕上顯示一些消息（註：直接在命令行里寫）。

function print_msg {
    echo "Hello, World"
}

現在，讓我們執行這個函數：

$ print_msg
Hello, World

不出所料，這個函數在屏幕上顯示了一些消息。

在上面的例子中，我們直接在終端里創建了一個函數。這個函數也可以保存到文件中。如下面的例子所示。

#!/bin/bash
function print_msg {
    echo "Hello, World"
}
print_msg

我們已經在 function.sh 文件中定義了這個函數。現在讓我們執行這個腳本：

$ chmod +x function.sh
$ ./function.sh
Hello, World

你可以看到，上面的輸出和之前的是一模一樣的。

更多函數用法

在上一小節中我們定義了一個非常簡單的函數。然而在軟體開發的過程中，我們需要更多高級的函數，它可以接收多個參數並且帶有返回值。在這一小節中，我們將討論這種函數。

向函數傳遞參數

我們可以像調用其它命令那樣給函數提供參數。我們可以在函數里使用美元 $ 符號訪問到這些參數。例如，$1 表示第一個參數，$2 代表第二個參數，以此類推。

讓我們修改下之前的函數，讓它以參數的形式接收信息。修改後的函數就像這樣：

function print_msg {
    echo "Hello $1"
}

在上面的函數中我們使用 $1 符號訪問第一個參數。讓我們執行這個函數：

$ print_msg "LinuxTechi"

執行完後，生成如下信息：

Hello LinuxTechi

從函數中返回數值

跟其它編程語言一樣，Bash 提供了返回語句讓我們可以向調用者返回一些數值。讓我們舉例說明：

function func_return_value {
    return 10
}

上面的函數向調用者返回 10。讓我們執行這個函數：

$ func_return_value
$ echo "Value returned by function is: $?"

當你執行完，將會產生如下的輸出結果：

Value returned by function is: 10

提示：在 Bash 中使用 $? 去獲取函數的返回值。

函數技巧

目前我們已經對 Bash 中的函數有了一些了解。現在讓我們創建一些非常有用的 Bash 函數，它們可以讓我們的生活變得更加輕鬆。

Logger

讓我們創建一個 logger 函數，它可以輸出帶有日期和時間的 log 信息。

function log_msg {
    echo "[`date '+ %F %T'` ]: $@"
}

執行這個函數：

$ log_msg "This is sample log message"

執行完，就會生成如下信息：

[ 2018-08-16 19:56:34 ]: This is sample log message

顯示系統信息

讓我們創建一個顯示 GNU/Linux 信息的函數

function system_info {
    echo "### OS information ###"
    lsb_release -a

    echo
    echo "### Processor information ###"
    processor=`grep -wc "processor" /proc/cpuinfo`
    model=`grep -w "model name" /proc/cpuinfo  | awk -F: '{print $2}'`
    echo "Processor = $processor"
    echo "Model     = $model"

    echo
    echo "### Memory information ###"
    total=`grep -w "MemTotal" /proc/meminfo | awk '{print $2}'`
    free=`grep -w "MemFree" /proc/meminfo | awk '{print $2}'`
    echo "Total memory: $total kB"
    echo "Free memory : $free kB"
}

執行完後會生成以下信息：

### OS information ###
No LSB modules are available.
Distributor ID:           Ubuntu
Description:   Ubuntu 18.04.1 LTS
Release:         18.04
Codename:    bionic

### Processor information ###
Processor = 1
Model     =  Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz

### Memory information ###
Total memory: 4015648 kB
Free memory : 2915428 kB

在當前目錄下查找文件或者目錄

下面的函數從當前目錄下查找文件或者目錄：

function search {
    find . -name $1
}

讓我們使用下面的命令查找 dir4 這個目錄：

$ search dir4

當你執行完命令後，將會產生如下輸出：

./dir1/dir2/dir3/dir4

數字時鐘

下面的函數在終端里創建了一個簡單的數字時鐘：

function digital_clock {
    clear
    while [ 1 ]
    do
        date +'%T'
        sleep 1
        clear
    done
}

函數庫

庫是函數的集合。將函數定義在文件里並在當前環境中導入那個文件，這樣可以創建函數庫。

假設我們已經在 utils.sh 中定義好了所有函數，接著在當前的環境下使用下面的命令導入函數：

$ source utils.sh

之後你就可以像調用其它 Bash 命令那樣執行庫中任何的函數了。

總結

本文我們討論了諸多可以提升效率的實用技巧。我希望這篇文章能夠啟發你去創造自己的技巧。

via: https://www.linuxtechi.com/define-use-functions-linux-shell-script/

作者：Pradeep Kumar 選題：lujun9972 譯者：LuuMing 校對：pityonline

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive