如何在 Linux Shell 编程中定义和使用函数

函数是一段可复用的代码。我们通常把重复的代码放进函数中并且在不同的地方去调用它。库是函数的集合。我们可以在库中定义经常使用的函数,这样其它脚本便可以不再重复代码而使用这些函数。

本文我们将讨论诸多关于函数的内容和一些使用技巧。为了方便演示,我将在 Ubuntu 系统上使用 Bourne Again SHell (Bash)

调用函数

在 Shell 中调用函数和调用其它命令是一模一样的。例如,如果你的函数名称为 my_func,你可以在命令行中像下面这样执行它:

  1. <span class="pln">$ my_func</span>

如果你的函数接收多个参数,那么可以像下面这样写(类似命令行参数的使用):

  1. <span class="pln">$ my_func arg1 arg2 arg3</span>

定义函数

我们可以用下面的语法去定义一个函数:

  1. <span class="kwd">function</span><span class="pln"> function_name </span><span class="pun">{</span>
  2. <span class="typ">Body</span><span class="pln"> of </span><span class="kwd">function</span>
  3. <span class="pun">}</span>

函数的主体可以包含任何有效的命令、循环语句和其它函数或脚本。现在让我们创建一个简单的函数,它向屏幕上显示一些消息(注:直接在命令行里写)。

  1. <span class="kwd">function</span><span class="pln"> print_msg </span><span class="pun">{</span>
  2. <span class="kwd">echo</span><span class="str">"Hello, World"</span>
  3. <span class="pun">}</span>

现在,让我们执行这个函数:

  1. <span class="pln">$ print_msg</span>
  2. <span class="typ">Hello</span><span class="pun">,</span><span class="typ">World</span>

不出所料,这个函数在屏幕上显示了一些消息。

在上面的例子中,我们直接在终端里创建了一个函数。这个函数也可以保存到文件中。如下面的例子所示。

  1. <span class="com">#</span><span class="pun">!</span><span class="str">/bin/</span><span class="kwd">bash</span>
  2. <span class="kwd">function</span><span class="pln"> print_msg </span><span class="pun">{</span>
  3. <span class="kwd">echo</span><span class="str">"Hello, World"</span>
  4. <span class="pun">}</span>
  5. <span class="pln">print_msg</span>

我们已经在 function.sh 文件中定义了这个函数。现在让我们执行这个脚本:

  1. <span class="pln">$ </span><span class="kwd">chmod</span><span class="pun">+</span><span class="pln">x </span><span class="kwd">function</span><span class="pun">.</span><span class="pln">sh</span>
  2. <span class="pln">$ </span><span class="pun">./</span><span class="kwd">function</span><span class="pun">.</span><span class="pln">sh</span>
  3. <span class="typ">Hello</span><span class="pun">,</span><span class="typ">World</span>

你可以看到,上面的输出和之前的是一模一样的。

更多函数用法

在上一小节中我们定义了一个非常简单的函数。然而在软件开发的过程中,我们需要更多高级的函数,它可以接收多个参数并且带有返回值。在这一小节中,我们将讨论这种函数。

向函数传递参数

我们可以像调用其它命令那样给函数提供参数。我们可以在函数里使用美元 $ 符号访问到这些参数。例如,$1 表示第一个参数,$2 代表第二个参数,以此类推。

让我们修改下之前的函数,让它以参数的形式接收信息。修改后的函数就像这样:

  1. <span class="kwd">function</span><span class="pln"> print_msg </span><span class="pun">{</span>
  2. <span class="kwd">echo</span><span class="str">"Hello $1"</span>
  3. <span class="pun">}</span>

在上面的函数中我们使用 $1 符号访问第一个参数。让我们执行这个函数:

  1. <span class="pln">$ print_msg </span><span class="str">"LinuxTechi"</span>

执行完后,生成如下信息:

  1. <span class="typ">Hello</span><span class="typ">LinuxTechi</span>

从函数中返回数值

跟其它编程语言一样,Bash 提供了返回语句让我们可以向调用者返回一些数值。让我们举例说明:

  1. <span class="kwd">function</span><span class="pln"> func_return_value </span><span class="pun">{</span>
  2. <span class="kwd">return</span><span class="lit">10</span>
  3. <span class="pun">}</span>

上面的函数向调用者返回 10。让我们执行这个函数:

  1. <span class="pln">$ func_return_value</span>
  2. <span class="pln">$ </span><span class="kwd">echo</span><span class="str">"Value returned by function is: $?"</span>

当你执行完,将会产生如下的输出结果:

  1. <span class="typ">Value</span><span class="pln"> returned by </span><span class="kwd">function</span><span class="kwd">is</span><span class="pun">:</span><span class="lit">10</span>

提示:在 Bash 中使用 $? 去获取函数的返回值。

函数技巧

目前我们已经对 Bash 中的函数有了一些了解。现在让我们创建一些非常有用的 Bash 函数,它们可以让我们的生活变得更加轻松。

Logger

让我们创建一个 logger 函数,它可以输出带有日期和时间的 log 信息。

  1. <span class="kwd">function</span><span class="pln"> log_msg </span><span class="pun">{</span>
  2. <span class="kwd">echo</span><span class="str">"[`date '+ %F %T'` ]: $@"</span>
  3. <span class="pun">}</span>

执行这个函数:

  1. <span class="pln">$ log_msg </span><span class="str">"This is sample log message"</span>

执行完,就会生成如下信息:

  1. <span class="pun">[</span><span class="lit">2018</span><span class="pun">-</span><span class="lit">08</span><span class="pun">-</span><span class="lit">16</span><span class="lit">19</span><span class="pun">:</span><span class="lit">56</span><span class="pun">:</span><span class="lit">34</span><span class="pun">]:</span><span class="typ">This</span><span class="kwd">is</span><span class="pln"> sample log message</span>

显示系统信息

让我们创建一个显示 GNU/Linux 信息的函数

  1. <span class="kwd">function</span><span class="pln"> system_info </span><span class="pun">{</span>
  2. <span class="kwd">echo</span><span class="str">"### OS information ###"</span>
  3. <span class="pln">lsb_release </span><span class="pun">-</span><span class="pln">a</span>
  4. <span class="kwd">echo</span>
  5. <span class="kwd">echo</span><span class="str">"### Processor information ###"</span>
  6. <span class="pln">processor</span><span class="pun">=</span><span class="str">`grep -wc "processor" /proc/cpuinfo`</span>
  7. <span class="pln">model</span><span class="pun">=</span><span class="str">`grep -w "model name" /proc/cpuinfo  | awk -F: '{print $2}'`</span>
  8. <span class="kwd">echo</span><span class="str">"Processor = $processor"</span>
  9. <span class="kwd">echo</span><span class="str">"Model    = $model"</span>
  10. <span class="kwd">echo</span>
  11. <span class="kwd">echo</span><span class="str">"### Memory information ###"</span>
  12. <span class="pln">total</span><span class="pun">=</span><span class="str">`grep -w "MemTotal" /proc/meminfo | awk '{print $2}'`</span>
  13. <span class="pln">free</span><span class="pun">=</span><span class="str">`grep -w "MemFree" /proc/meminfo | awk '{print $2}'`</span>
  14. <span class="kwd">echo</span><span class="str">"Total memory: $total kB"</span>
  15. <span class="kwd">echo</span><span class="str">"Free memory : $free kB"</span>
  16. <span class="pun">}</span>

执行完后会生成以下信息:

  1. <span class="com">### OS information ###</span>
  2. <span class="typ">No</span><span class="pln"> LSB modules are available</span><span class="pun">.</span>
  3. <span class="typ">Distributor</span><span class="pln"> ID</span><span class="pun">:</span><span class="pln">          </span><span class="typ">Ubuntu</span>
  4. <span class="typ">Description</span><span class="pun">:</span><span class="pln">  </span><span class="typ">Ubuntu</span><span class="lit">18.04</span><span class="pun">.</span><span class="lit">1</span><span class="pln"> LTS</span>
  5. <span class="typ">Release</span><span class="pun">:</span><span class="pln">        </span><span class="lit">18.04</span>
  6. <span class="typ">Codename</span><span class="pun">:</span><span class="pln">    bionic</span>
  7. <span class="com">### Processor information ###</span>
  8. <span class="typ">Processor</span><span class="pun">=</span><span class="lit">1</span>
  9. <span class="typ">Model</span><span class="pln">    </span><span class="pun">=</span><span class="pln">  </span><span class="typ">Intel</span><span class="pun">(</span><span class="pln">R</span><span class="pun">)</span><span class="typ">Core</span><span class="pun">(</span><span class="pln">TM</span><span class="pun">)</span><span class="pln"> i7</span><span class="pun">-</span><span class="lit">7700HQ</span><span class="pln"> CPU </span><span class="pun">@</span><span class="lit">2.80GHz</span>
  10. <span class="com">### Memory information ###</span>
  11. <span class="typ">Total</span><span class="pln"> memory</span><span class="pun">:</span><span class="lit">4015648</span><span class="pln"> kB</span>
  12. <span class="typ">Free</span><span class="pln"> memory </span><span class="pun">:</span><span class="lit">2915428</span><span class="pln"> kB</span>

在当前目录下查找文件或者目录

下面的函数从当前目录下查找文件或者目录:

  1. <span class="kwd">function</span><span class="pln"> search </span><span class="pun">{</span>
  2. <span class="kwd">find</span><span class="pun">.</span><span class="pun">-</span><span class="pln">name $1</span>
  3. <span class="pun">}</span>

让我们使用下面的命令查找 dir4 这个目录:

  1. <span class="pln">$ search dir4</span>

当你执行完命令后,将会产生如下输出:

  1. <span class="pun">.</span><span class="str">/dir1/</span><span class="pln">dir2</span><span class="pun">/</span><span class="pln">dir3</span><span class="pun">/</span><span class="pln">dir4</span>

数字时钟

下面的函数在终端里创建了一个简单的数字时钟:

  1. <span class="kwd">function</span><span class="pln"> digital_clock </span><span class="pun">{</span>
  2. <span class="kwd">clear</span>
  3. <span class="kwd">while</span><span class="pun">[</span><span class="lit">1</span><span class="pun">]</span>
  4. <span class="kwd">do</span>
  5. <span class="kwd">date</span><span class="pun">+</span><span class="str">'%T'</span>
  6. <span class="kwd">sleep</span><span class="lit">1</span>
  7. <span class="kwd">clear</span>
  8. <span class="kwd">done</span>
  9. <span class="pun">}</span>

函数库

库是函数的集合。将函数定义在文件里并在当前环境中导入那个文件,这样可以创建函数库。

假设我们已经在 utils.sh 中定义好了所有函数,接着在当前的环境下使用下面的命令导入函数:

  1. <span class="pln">$ source utils</span><span class="pun">.</span><span class="pln">sh</span>

之后你就可以像调用其它 Bash 命令那样执行库中任何的函数了。

总结

本文我们讨论了诸多可以提升效率的实用技巧。我希望这篇文章能够启发你去创造自己的技巧。


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

作者:Pradeep Kumar 选题:lujun9972 译者:LuuMing 校对:pityonline

本文由 LCTT 原创编译,Linux中国 荣誉推出

相关推荐