MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

Bash中的脚本与代码审查

2024-08-093.4k 阅读

理解Bash脚本

Bash脚本基础

Bash脚本是一系列Bash命令按顺序排列组成的文本文件，其扩展名通常为.sh。通过编写脚本，我们可以将复杂的任务自动化，提高工作效率。例如，创建一个简单的脚本hello.sh：

#!/bin/bash
echo "Hello, World!"

第一行#!/bin/bash称为shebang，它告诉系统使用Bash解释器来执行该脚本。执行这个脚本，我们首先需要赋予它可执行权限：

chmod +x hello.sh

然后运行脚本：

./hello.sh

这样就会在终端输出Hello, World!。

变量

  1. 变量定义与使用 在Bash脚本中，变量不需要事先声明，直接赋值即可。例如：
name="John"
echo "My name is $name"

这里定义了变量name并赋值为John，然后在echo命令中使用$name来引用该变量的值。

  1. 环境变量 Bash有许多预定义的环境变量，例如$PATH，它包含了系统查找可执行文件的路径。我们可以通过echo命令查看环境变量的值，如：
echo $PATH

也可以在脚本中修改环境变量，不过这种修改只在当前脚本的执行环境中有效。例如：

export PATH=$PATH:/new/directory

这行代码将/new/directory添加到了$PATH环境变量中。

条件语句

  1. if - then - else语句 if - then - else语句用于根据条件执行不同的代码块。其基本语法如下：
if [ condition ]; then
    commands
elif [ another_condition ]; then
    other_commands
else
    fallback_commands
fi

例如，判断一个文件是否存在：

file="test.txt"
if [ -f $file ]; then
    echo "$file exists."
else
    echo "$file does not exist."
fi

这里-f是测试文件是否为普通文件的选项，如果文件test.txt存在，就会输出test.txt exists.，否则输出test.txt does not exist.。

  1. case语句 case语句用于根据不同的值执行不同的代码块，类似于其他编程语言中的switch - case语句。其语法如下：
case variable in
    pattern1)
        commands1
        ;;
    pattern2)
        commands2
        ;;
    *)
        default_commands
        ;;
esac

例如，根据用户输入执行不同的操作：

echo "Enter a number (1 - 3): "
read num
case $num in
    1)
        echo "You entered 1"
        ;;
    2)
        echo "You entered 2"
        ;;
    3)
        echo "You entered 3"
        ;;
    *)
        echo "Invalid input"
        ;;
esac

这个脚本会提示用户输入一个数字，然后根据输入的值输出相应的信息。如果输入的不是1 - 3之间的数字，则输出Invalid input。

循环语句

  1. for循环 for循环用于对一系列值进行迭代。其语法有两种常见形式：
  • 传统形式：
for var in list; do
    commands
done

例如，遍历一个文件列表并输出文件名：

for file in *.txt; do
    echo $file
done

这里*.txt是一个通配符，表示所有扩展名为.txt的文件，循环会依次将每个文件的文件名赋值给file变量，并执行echo命令输出文件名。

  • C语言风格形式：
for (( i = 0; i < 10; i++ )); do
    echo $i
done

这个循环从0开始，每次递增1，直到i小于10，循环体中会输出i的值。

  1. while循环 while循环会在条件为真时不断执行代码块。其语法如下：
while [ condition ]; do
    commands
done

例如，计算1到10的累加和：

sum=0
i=1
while [ $i -le 10 ]; do
    sum=$((sum + i))
    i=$((i + 1))
done
echo "Sum: $sum"

这里-le是小于等于的比较操作符，循环会在i小于等于10时不断执行，每次将i加到sum中，并将i加1。最后输出累加和。

  1. until循环 until循环与while循环相反，它会在条件为假时不断执行代码块。其语法如下：
until [ condition ]; do
    commands
done

例如，直到用户输入yes才停止循环：

echo "Enter yes to stop: "
while true; do
    read input
    until [ "$input" = "yes" ]; do
        echo "Invalid input. Enter yes to stop: "
        read input
    done
    break
done

这个脚本会不断提示用户输入，直到用户输入yes。

函数

函数定义与调用

在Bash脚本中，函数是一段可重用的代码块。函数定义的基本语法如下：

function_name() {
    commands
    [ return value ]
}

例如，定义一个简单的函数来计算两个数的和：

add() {
    sum=$(( $1 + $2 ))
    echo $sum
}
result=$(add 3 5)
echo "The result is $result"

这里定义了add函数，它接受两个参数$1和$2，计算它们的和并输出。然后通过$(add 3 5)调用函数并将结果赋值给result变量，最后输出结果。

函数参数与返回值

  1. 函数参数 函数可以接受多个参数，在函数内部通过$1, $2, $3等变量来访问这些参数。例如，定义一个函数来打印所有参数：
print_args() {
    for arg in "$@"; do
        echo $arg
    done
}
print_args apple banana cherry

这里$@表示所有参数，函数会遍历并输出每个参数。

  1. 函数返回值 函数可以通过return语句返回一个整数值（0表示成功，非0表示失败）。例如：
check_file() {
    if [ -f $1 ]; then
        return 0
    else
        return 1
    fi
}
check_file test.txt
if [ $? -eq 0 ]; then
    echo "File exists."
else
    echo "File does not exist."
fi

这里check_file函数检查文件是否存在，如果存在返回0，不存在返回1。在函数调用后，通过$?获取函数的返回值，并根据返回值输出相应的信息。

处理文件与目录

文件操作

  1. 创建文件 可以使用touch命令创建一个新文件。在脚本中，可以这样使用：
filename="new_file.txt"
touch $filename
if [ -f $filename ]; then
    echo "$filename created successfully."
else
    echo "Failed to create $filename."
fi

这段代码创建一个名为new_file.txt的文件，并检查文件是否创建成功。

  1. 读取文件内容 可以使用cat命令读取文件内容并输出到终端，也可以在脚本中逐行读取文件。例如：
file="example.txt"
while read line; do
    echo $line
done < $file

这里通过while read循环逐行读取example.txt文件的内容，并输出每一行。

  1. 写入文件 可以使用echo命令结合重定向符号>或>>将内容写入文件。>会覆盖文件内容，>>会追加内容。例如：
content="This is some text."
file="output.txt"
echo $content > $file
echo "Content written to $file."

这段代码将content变量的值写入output.txt文件，如果文件已存在，会覆盖原有内容。如果要追加内容，可以使用echo $content >> $file。

目录操作

  1. 创建目录 使用mkdir命令创建目录。在脚本中：
dirname="new_directory"
mkdir $dirname
if [ -d $dirname ]; then
    echo "$dirname created successfully."
else
    echo "Failed to create $dirname."
fi

这里创建一个名为new_directory的目录，并检查目录是否创建成功。-d选项用于测试目录是否存在。

  1. 切换目录 使用cd命令切换目录。例如，在脚本中切换到/tmp目录：
cd /tmp
echo "Current directory: $(pwd)"

这里pwd命令用于显示当前工作目录，通过$(pwd)获取其输出并输出到终端。

  1. 删除目录 使用rm -r命令删除目录及其所有内容（如果目录不为空）。例如：
dirname="old_directory"
rm -r $dirname
if [ ! -d $dirname ]; then
    echo "$dirname deleted successfully."
else
    echo "Failed to delete $dirname."
fi

这里删除old_directory目录，并检查目录是否删除成功。! -d表示目录不存在的测试。

代码审查基础

代码审查的重要性

  1. 发现错误 在Bash脚本开发过程中，即使是经验丰富的开发者也可能会犯错误。例如，在变量赋值时可能会遗漏空格，导致语法错误。代码审查可以帮助发现这些潜在的错误，避免脚本在运行时出现异常。比如下面这个脚本：
name=John
echo "My name is $name"

如果写成name=John，中间没有空格，就会导致变量赋值错误。通过代码审查可以及时发现并纠正这类问题。

  1. 提高代码质量 代码审查有助于提高代码的可读性、可维护性和可扩展性。例如，在脚本中使用有意义的变量名和函数名，可以使代码更易读。审查者可以建议开发者修改不恰当的命名，如将var1改为更具描述性的user_name。同时，审查过程中还可以检查代码结构是否合理，是否符合模块化设计原则，从而提高代码的可维护性和可扩展性。

代码审查流程

  1. 准备阶段 在进行代码审查之前，开发者需要确保脚本已经完成了基本的功能开发，并且进行了初步的自我检查。这包括检查语法错误，通过运行脚本来验证功能是否正常等。例如，开发者可以在本地运行脚本多次，输入不同的测试数据，确保脚本在各种情况下都能正确运行。同时，开发者还应该整理好代码的注释，使审查者能够快速理解代码的功能和逻辑。

  2. 审查阶段 审查者开始对脚本进行详细审查。审查者首先会关注脚本的整体结构，包括函数的定义和调用是否合理，变量的作用域是否清晰等。然后，审查者会逐行检查代码，查找语法错误、逻辑错误以及潜在的安全风险。例如，审查者会检查是否存在未经验证的用户输入，因为这可能导致脚本遭受注入攻击。在审查过程中，审查者可以使用工具辅助，如shellcheck，它可以帮助发现常见的Bash脚本错误。

  3. 反馈与改进阶段 审查者将审查过程中发现的问题反馈给开发者。反馈应该清晰、具体，指出问题所在的代码行以及问题的性质。开发者根据反馈进行代码修改，然后再次提交代码进行审查，直到代码通过审查。这个过程可能需要多次迭代，以确保代码质量达到较高水平。

代码审查要点

语法与格式

  1. 语法正确性 审查Bash脚本时，首先要确保语法正确。这包括检查变量定义、命令使用、条件语句和循环语句的语法是否符合Bash的规范。例如，在if语句中，条件表达式必须用方括号括起来，并且方括号与条件之间要有空格。下面是一个正确的if语句示例：
if [ -f $file ]; then
    echo "$file exists."
else
    echo "$file does not exist."
fi

如果写成if[-f $file]; then，就会导致语法错误。

  1. 格式规范 良好的代码格式有助于提高代码的可读性。代码应该有适当的缩进，通常使用4个空格进行缩进。函数定义、条件语句和循环语句的代码块应该用花括号或do - done块清晰地界定。例如：
function_name() {
    for (( i = 0; i < 10; i++ )); do
        if [ $i -eq 5 ]; then
            echo "i is 5"
        fi
    done
}

这样的格式使代码结构一目了然，便于阅读和维护。

逻辑与功能

  1. 逻辑正确性 审查脚本的逻辑是否正确是代码审查的关键。这包括检查条件判断是否合理，循环是否能正确终止，函数的功能是否符合预期等。例如，在一个计算阶乘的脚本中：
factorial() {
    num=$1
    result=1
    while [ $num -gt 0 ]; do
        result=$((result * num))
        num=$((num - 1))
    done
    echo $result
}

审查时需要确认循环是否能正确计算阶乘，当num为0时循环是否能正确终止，以及函数返回的结果是否正确。

  1. 功能完整性 检查脚本是否实现了所有预期的功能。例如，如果一个脚本的功能是备份指定目录下的所有文件，并将备份文件存储到另一个目录，那么审查时需要确认脚本是否正确地遍历了源目录下的所有文件，是否正确地进行了文件复制操作，以及是否处理了可能出现的错误情况，如目标目录不存在等。

变量与函数

  1. 变量命名与作用域 变量命名应该具有描述性，能够清晰地表达变量的用途。避免使用含义模糊的变量名，如a, b, tmp等。同时，要注意变量的作用域，确保变量在其使用范围内有正确的定义和值。例如，在函数内部定义的变量，其作用域应该仅限于函数内部，不应该意外地影响到函数外部的代码。

  2. 函数设计与调用 函数应该具有单一、明确的功能，避免函数过于复杂。函数的参数应该合理，并且在函数内部对参数进行必要的验证。函数调用时，要确保传递的参数数量和类型正确。例如，在一个计算两个数平均值的函数中：

average() {
    if [ $# -ne 2 ]; then
        echo "Usage: average num1 num2"
        return 1
    fi
    sum=$(( $1 + $2 ))
    avg=$((sum / 2))
    echo $avg
}

这里函数首先检查参数数量是否为2，如果不是则输出使用提示并返回错误。这样的设计可以增强函数的健壮性。

安全性

  1. 输入验证 如果脚本接受用户输入，必须对输入进行严格验证，以防止注入攻击。例如，在一个接受用户输入文件名并读取文件内容的脚本中：
echo "Enter a file name: "
read filename
if [[ $filename =~ ^[a-zA-Z0-9_. -]+$ ]]; then
    cat $filename
else
    echo "Invalid file name."
fi

这里使用正则表达式^[a-zA-Z0-9_. -]+$来验证文件名是否只包含合法字符，防止用户输入恶意代码。

  1. 文件与目录操作安全 在进行文件和目录操作时，要注意权限设置和操作的安全性。例如，在创建文件或目录时，要确保设置了合适的权限，避免文件或目录的权限过于宽松导致安全风险。同时，在删除文件或目录时，要确认操作的必要性，避免误删重要文件。

代码审查工具

shellcheck

  1. 安装与使用 shellcheck是一个广泛使用的Bash脚本静态分析工具，可以帮助发现脚本中的语法错误、潜在的逻辑错误以及一些风格问题。在大多数Linux系统上，可以通过包管理器安装，例如在Ubuntu上：
sudo apt-get install shellcheck

安装完成后，使用shellcheck非常简单，只需在命令行中指定要检查的脚本文件即可：

shellcheck my_script.sh

shellcheck会输出详细的检查结果，指出错误所在的行号、错误类型以及建议的修正方法。

  1. 检查示例 假设有一个脚本test.sh内容如下：
#!/bin/bash
name=John
echo "My name is $name"

运行shellcheck test.sh，它会指出name=John这一行的错误：

In test.sh line 3:
name=John
^-- SC2086: Double quote to prevent globbing and word splitting.

它提示我们应该将name=John改为name="John"，以避免潜在的问题。

shfmt

  1. 安装与使用 shfmt是一个Bash脚本格式化工具，可以将脚本格式化为符合规范的样式，有助于提高代码的可读性。在Linux系统上，可以通过以下方式安装：
go install mvdan.cc/shfmt/cmd/shfmt@latest

安装完成后，使用shfmt格式化脚本非常方便：

shfmt -w my_script.sh

-w选项表示将格式化后的内容写回到原文件中。如果不想覆盖原文件，可以使用shfmt my_script.sh > formatted_script.sh将格式化后的内容输出到新文件。

  1. 格式化示例 假设有一个格式混乱的脚本unformatted.sh：
#!/bin/bash
name="John"
echo "My name is $name"
if [ -f test.txt ]; then echo "File exists."; else echo "File does not exist."; fi

运行shfmt -w unformatted.sh后，脚本会被格式化为：

#!/bin/bash

name="John"
echo "My name is $name"

if [ -f test.txt ]; then
    echo "File exists."
else
    echo "File does not exist."
fi

可以看到，代码的格式变得更加清晰易读。

通过掌握Bash脚本的编写技巧以及深入理解代码审查的要点和工具，开发者能够编写出高质量、可靠且安全的Bash脚本，提高工作效率和代码的可维护性。在实际项目中，持续进行代码审查是保证脚本质量的重要手段，有助于减少错误，提升整个项目的稳定性。