Linux Shell——函数的使用

文/一介书生，一枚码农。

scripts are for lazy people.

函数是存在内存里的一组代码的命名的元素。函数创建于脚本运行环境之中，并且可以执行。
函数的语法结构为：

function <function-name> {
    <code to execute>
}

创建函数不需要do或 done这些关键字，只需要大括号来界定函数的作用范围。
我们可以在命令行中创建一个简单的函数：

function show_system {
	echo "The uptime is:"
	uptime
	echo
	
	echo "Current dir:"
	pwd
	echo
	
	echo "Date:"
	date
}

在命令行定义上面的函数：

然后执行函数：

最后，我们可以使用type命令查看函数的定义：

方法可以有传递的参数。在此之前，我们先简单介绍 sed命令，下面的脚本用来移除文件中的注释行和空白行。

sed -i.bak '/^s*#/d;/^$/d' <filename>

详细介绍一下上面的脚本：

• sed -i.bak：sed 命令会创建一个以.bak结尾的备份文件，用来备份原始的文件。
• /^：表示行首。
• s*：匹配任何不可见字符，包括空格、制表符、换页符等。
• #/：shell 脚本中的注释标记。 /^s*#/一起使用用来查找注释行和带有不可见字符的注释行。
• d：用来删除匹配的行。
• ;/^$/d：;是表达式的分隔符，后面的表达式跟前面的表达式意思很像，用来删除空白行, "$"匹配输入字符串的结束位置。

我们把上面的脚本移到函数中，创建一个名为clean_file的函数：

function clean_file {
  sed -i.bak '/^s*#/d;/^$/d' "$1"
}

上面的代码中，我们使用位置参数$1来接收命令行里传递的参数，需要注意的是$1 用大括号来括起来。

下面，我们完善clean_file方法，新建一个脚本文件 clean.sh。代码如下：

#!/bin/bash
# Script will prompt for filename
# And remove commented and blank lines

function is_file {
    if [ ! -f "$1" ] ; then
        echo "$1 does not seem to be a file"
        exit 2
    fi
}

function clean_file {
    is_file "$1"
    BEFORE=$(wc -l "$1")
    echo "The file $1 starts with $BEFORE"
    sed -i.bak '/^s*#/d;/^$/d' "$1"
    AFTER=$(wc -l "$1")
    echo "The file $1 is now $AFTER"
}

read -p "Enter a file to clean: "
clean_file "$REPLY"
exit 1

其中，wc -l命令用来打印文件行数。
现在，我们新建一个用来测试的文件 test.txt，里面随便写些内容：

# This file is just for testing.

Hello.

World.

# new comment.

$

The end.

在 test 文件所在的目录下，执行 clean.sh脚本：

然后查看 test 文件和 test.bak 文件，发现空白行和注释行已经删除。

这里需要注意的是，shell 脚本是从上至下来执行的，如果在一个函数中调用了另一个函数，那么被调用的函数要定义在调用函数的前面。

当然，除了函数可以传递参数外，还可以有返回值。默认情况下，在执行完函数内的最后一行代码后，方法会返回一个状态的数字，你可以使用$?变量来查看函数执行的状态。如果返回值为0，表示方法正常退出，非0表示程序发生错误或其他非正常退出。
我们使用return关键字来返回一个整数。这里需要注意两点：

• 函数一旦执行完就会返回状态代码。
• 状态代码的范围为0到255。

如果不想返回函数的状态代码，而是想返回一个字符串或是其他类型，可以使用 echo 变量的方式来返回值。

下面创建脚本文件 translate.sh，用来把文件中的大写字符转换为小写字符：

#!/bin/bash
# Script that translates upper letter to low letter

function to_lower ()
{
    input="$1"
    output=$(tr '[A-Z]' '[a-z]' <<< "$input")
    echo $output
}

while true
do
    read -p "Enter c to continue or q to exit: "
    result=$(to_lower $REPLY)
    echo "After translate: $result"
    
    if [ $result = "q" ] ; then
        break
    fi

done
echo "Finished"

代码会把输入的大写字符变成小写字符，当输入"Q"或"q"时程序退出。