Bash中的脚本与代码重构模式
2021-10-144.8k 阅读
一、Bash脚本基础回顾
（一）脚本结构与执行
Bash脚本本质上是一个包含一系列Bash命令的文本文件。通常，脚本的第一行是一个shebang（也称为Hashbang），用于指定运行脚本的解释器。例如，#!/bin/bash 表示使用 /bin/bash 来解释执行该脚本。
下面是一个简单的Bash脚本示例：
#!/bin/bash
echo "Hello, World!"
要执行这个脚本，首先需要确保脚本文件具有可执行权限，可以使用 chmod +x script.sh 命令赋予执行权限，然后通过 ./script.sh 来运行脚本。
（二）变量与数据类型
- 变量定义：在Bash中，定义变量非常简单，不需要声明变量类型。例如：
name="John"
这里定义了一个名为 name 的变量，并赋值为 John。变量名必须以字母或下划线开头，后面可以跟字母、数字或下划线。
2. 变量引用：使用变量时，需要在变量名前加上 $ 符号。例如：
echo $name
这将输出 John。如果变量名与其他字符相连，需要使用花括号将变量名括起来。例如：
message="Hello, ${name}!"
echo $message
- 数据类型：Bash主要处理字符串类型的数据，但在某些情况下也能进行简单的数值运算。例如，整数运算可以使用
let命令或((...))结构：
a=5
b=3
let result=a+b
echo $result
((result=a - b))
echo $result
二、Bash脚本的初始开发模式
（一）简单命令序列脚本
许多Bash脚本最初都是简单的命令序列，用于完成一些重复性的任务。例如，一个用于备份文件的脚本：
#!/bin/bash
cp important_file.txt backup/important_file_$(date +%Y%m%d).txt
这个脚本将 important_file.txt 复制到 backup 目录，并在文件名中添加当前日期作为后缀。虽然简单，但这种脚本对于一次性或短期的任务非常实用。
（二）基于条件判断的脚本
if - then - else结构：当需要根据不同条件执行不同操作时，if - then - else结构就派上用场了。例如，检查一个文件是否存在并执行相应操作：
#!/bin/bash
file="test.txt"
if [ -f $file ]; then
echo "$file exists."
else
echo "$file does not exist."
fi
这里 [ -f $file ] 是一个测试条件，-f 用于检查文件是否存在且为普通文件。
2. case - esac 结构：当需要根据不同的值执行不同的操作时，case - esac 结构更为合适。例如，根据用户输入执行不同的命令：
#!/bin/bash
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
（三）循环脚本
for循环：for循环常用于遍历列表或执行固定次数的操作。例如，遍历一个目录下的所有文件：
#!/bin/bash
for file in *; do
if [ -f $file ]; then
echo "$file is a file."
elif [ -d $file ]; then
echo "$file is a directory."
fi
done
while循环：while循环基于条件判断来决定是否继续执行。例如，读取文件内容逐行处理：
#!/bin/bash
while read line; do
echo "Line: $line"
done < test.txt
三、代码重构的必要性
（一）提高可读性
随着脚本功能的增加，简单的命令序列会变得复杂且难以理解。例如，一个包含大量文件操作和条件判断的脚本：
#!/bin/bash
mkdir new_dir
cp file1.txt new_dir/
cp file2.txt new_dir/
if [ -f new_dir/file1.txt ] && [ -f new_dir/file2.txt ]; then
echo "Files copied successfully."
rm file1.txt
rm file2.txt
else
echo "Copy failed."
rm -r new_dir
fi
这段脚本虽然功能明确，但代码结构不清晰，尤其是对于不熟悉该脚本逻辑的人来说。通过重构，可以将不同功能的代码分离，使用函数来封装操作，提高代码的可读性。
（二）增强可维护性
当脚本需要修改或扩展功能时，如果代码结构混乱，修改可能会引入新的问题。例如，在上述脚本中，如果需要添加对更多文件的处理，直接在现有代码上修改会使代码更加混乱。而通过重构，将文件复制、检查和清理等操作封装成函数，修改和扩展功能时只需修改相应的函数，而不会影响其他部分的代码。
（三）减少重复代码
在一些复杂的脚本中，可能会出现重复的代码片段。例如，在多个地方进行文件存在性检查：
if [ -f file1.txt ]; then
echo "file1 exists."
fi
if [ -f file2.txt ]; then
echo "file2 exists."
fi
通过重构，可以将文件存在性检查封装成一个函数，减少重复代码，提高代码的简洁性。
四、Bash脚本重构模式
（一）函数封装
- 基本函数定义：将相关的代码片段封装成函数是重构的常用方法。例如，将文件复制操作封装成函数：
#!/bin/bash
copy_files() {
local source=$1
local target=$2
cp $source $target
if [ $? -eq 0 ]; then
echo "Files copied successfully."
else
echo "Copy failed."
fi
}
source_dir="src"
target_dir="dst"
copy_files $source_dir/* $target_dir
这里 copy_files 函数接受两个参数，分别是源文件或目录和目标目录，函数内部执行复制操作并检查是否成功。
2. 函数的递归使用：在处理目录结构时，函数的递归使用非常有用。例如，递归复制一个目录及其子目录：
#!/bin/bash
recursive_copy() {
local source=$1
local target=$2
if [ -d $source ]; then
mkdir -p $target
for item in $source/*; do
local new_target=$target/$(basename $item)
recursive_copy $item $new_target
done
else
cp $source $target
if [ $? -eq 0 ]; then
echo "File copied successfully."
else
echo "Copy failed."
fi
fi
}
source_dir="src"
target_dir="dst"
recursive_copy $source_dir $target_dir
这个函数首先判断源路径是否为目录，如果是，则创建目标目录并递归调用自身处理子目录和文件；如果是文件，则直接复制。
（二）模块化
- 将脚本拆分为多个文件：对于大型脚本，可以将不同功能模块拆分为不同的文件。例如，一个包含文件操作、网络操作和数据库操作的脚本，可以拆分为
file_operations.sh、network_operations.sh和database_operations.sh。然后在主脚本中通过source命令引入这些模块：
#!/bin/bash
source file_operations.sh
source network_operations.sh
source database_operations.sh
# 主脚本逻辑，调用各个模块的函数
file_operation_function
network_operation_function
database_operation_function
- 模块间的依赖管理：在拆分模块时，需要注意模块间的依赖关系。例如，如果
network_operations.sh依赖于file_operations.sh中的一些配置，那么在主脚本中引入模块时，需要先引入file_operations.sh。同时，可以在模块文件中添加注释说明依赖关系，方便维护。
（三）使用数组和关联数组优化代码
- 数组的使用：当需要处理多个相关的数据项时，数组非常有用。例如，存储多个文件路径并进行统一操作：
#!/bin/bash
files=("file1.txt" "file2.txt" "file3.txt")
for file in ${files[@]}; do
if [ -f $file ]; then
echo "$file exists."
else
echo "$file does not exist."
fi
done
- 关联数组：Bash 4.0 及以上版本支持关联数组，它允许使用字符串作为索引。例如，存储文件及其权限信息：
#!/bin/bash
declare -A file_permissions
file_permissions["file1.txt"]="rw-r--r--"
file_permissions["file2.txt"]="rwxr-xr-x"
for file in ${!file_permissions[@]}; do
echo "$file has permissions ${file_permissions[$file]}"
done
（四）错误处理与日志记录的重构
- 改进错误处理：在脚本中，合理的错误处理非常重要。可以通过设置
set -e使脚本在遇到错误时立即退出。例如：
#!/bin/bash
set -e
cp non_existent_file.txt destination/
echo "This line will not be reached if the copy fails."
同时，可以自定义错误处理函数，在错误发生时执行一些清理操作或输出详细的错误信息：
#!/bin/bash
error_handler() {
local error_code=$?
echo "An error occurred with code $error_code. Cleaning up..."
# 执行清理操作，如删除临时文件等
rm -f temp_file.txt
}
trap error_handler ERR
cp non_existent_file.txt destination/
- 日志记录：为了便于调试和监控脚本的运行，添加日志记录功能。可以使用
echo结合时间戳输出日志信息到文件：
#!/bin/bash
log_message() {
local message=$1
echo "$(date +%Y-%m-%d %H:%M:%S) $message" >> script.log
}
log_message "Script started."
cp file.txt destination/
if [ $? -eq 0 ]; then
log_message "File copied successfully."
else
log_message "File copy failed."
fi
log_message "Script ended."
五、重构案例分析
（一）初始脚本
假设我们有一个用于部署Web应用的脚本，初始版本如下：
#!/bin/bash
echo "Starting web app deployment..."
git clone https://github.com/user/repo.git
cd repo
npm install
npm build
sudo cp -r dist /var/www/html
sudo chown -R www-data:www-data /var/www/html
echo "Web app deployed successfully."
这个脚本虽然能完成基本的部署任务，但存在一些问题。首先，代码结构不清晰，各个操作没有进行合理的封装。其次，没有错误处理，如果其中某个步骤失败，脚本会继续执行，可能导致错误的部署状态。
（二）重构过程
- 函数封装：将每个主要操作封装成函数：
#!/bin/bash
clone_repo() {
git clone https://github.com/user/repo.git
if [ $? -ne 0 ]; then
echo "Git clone failed."
exit 1
fi
}
install_dependencies() {
cd repo
npm install
if [ $? -ne 0 ]; then
echo "npm install failed."
exit 1
fi
}
build_app() {
npm build
if [ $? -ne 0 ]; then
echo "npm build failed."
exit 1
fi
}
deploy_app() {
sudo cp -r dist /var/www/html
if [ $? -ne 0 ]; then
echo "Copy to web root failed."
exit 1
fi
sudo chown -R www-data:www-data /var/www/html
if [ $? -ne 0 ]; then
echo "Change ownership failed."
exit 1
fi
}
echo "Starting web app deployment..."
clone_repo
install_dependencies
build_app
deploy_app
echo "Web app deployed successfully."
- 错误处理增强：通过在每个函数中添加错误检查和退出机制，确保脚本在遇到错误时能及时终止，并输出相应的错误信息。
- 日志记录添加：为了更好地跟踪部署过程，可以添加日志记录功能：
#!/bin/bash
log_message() {
local message=$1
echo "$(date +%Y-%m-%d %H:%M:%S) $message" >> deployment.log
}
clone_repo() {
git clone https://github.com/user/repo.git
if [ $? -ne 0 ]; then
log_message "Git clone failed."
echo "Git clone failed."
exit 1
else
log_message "Git clone successful."
fi
}
install_dependencies() {
cd repo
npm install
if [ $? -ne 0 ]; then
log_message "npm install failed."
echo "npm install failed."
exit 1
else
log_message "npm install successful."
fi
}
build_app() {
npm build
if [ $? -ne 0 ]; then
log_message "npm build failed."
echo "npm build failed."
exit 1
else
log_message "npm build successful."
fi
}
deploy_app() {
sudo cp -r dist /var/www/html
if [ $? -ne 0 ]; then
log_message "Copy to web root failed."
echo "Copy to web root failed."
exit 1
else
log_message "Copy to web root successful."
fi
sudo chown -R www-data:www-data /var/www/html
if [ $? -ne 0 ]; then
log_message "Change ownership failed."
echo "Change ownership failed."
exit 1
else
log_message "Change ownership successful."
fi
}
log_message "Starting web app deployment..."
echo "Starting web app deployment..."
clone_repo
install_dependencies
build_app
deploy_app
log_message "Web app deployed successfully."
echo "Web app deployed successfully."
（三）重构后的效果
重构后的脚本代码结构更清晰，每个操作都有对应的函数，便于理解和维护。错误处理机制更加完善，能及时发现并处理部署过程中的问题。日志记录功能使得可以方便地跟踪部署过程，排查可能出现的问题。
六、持续重构与代码质量提升
（一）随着需求变化进行重构
随着项目的发展，对脚本的需求可能会发生变化。例如，在上述Web应用部署脚本中，如果需要支持多个不同的仓库进行部署，就需要对脚本进行进一步重构。可以将仓库地址作为函数参数，而不是硬编码在脚本中：
#!/bin/bash
log_message() {
local message=$1
echo "$(date +%Y-%m-%d %H:%M:%S) $message" >> deployment.log
}
clone_repo() {
local repo_url=$1
git clone $repo_url
if [ $? -ne 0 ]; then
log_message "Git clone failed for $repo_url."
echo "Git clone failed for $repo_url."
exit 1
else
log_message "Git clone successful for $repo_url."
fi
}
install_dependencies() {
cd $(basename $(echo $1 | cut -d'/' -f -1))
npm install
if [ $? -ne 0 ]; then
log_message "npm install failed."
echo "npm install failed."
exit 1
else
log_message "npm install successful."
fi
}
build_app() {
npm build
if [ $? -ne 0 ]; then
log_message "npm build failed."
echo "npm build failed."
exit 1
else
log_message "npm build successful."
fi
}
deploy_app() {
sudo cp -r dist /var/www/html
if [ $? -ne 0 ]; then
log_message "Copy to web root failed."
echo "Copy to web root failed."
exit 1
else
log_message "Copy to web root successful."
fi
sudo chown -R www-data:www-data /var/www/html
if [ $? -ne 0 ]; then
log_message "Change ownership failed."
echo "Change ownership failed."
exit 1
else
log_message "Change ownership successful."
fi
}
repos=("https://github.com/user/repo1.git" "https://github.com/user/repo2.git")
for repo in ${repos[@]}; do
log_message "Starting deployment for $repo."
echo "Starting deployment for $repo."
clone_repo $repo
install_dependencies $repo
build_app
deploy_app
log_message "Deployment completed for $repo."
echo "Deployment completed for $repo."
done
（二）代码审查与重构
定期进行代码审查是发现代码中潜在问题并进行重构的有效方法。在代码审查过程中，可以检查代码的可读性、可维护性、错误处理等方面。例如，发现某个函数代码过于复杂，可以考虑进一步拆分函数；发现某个变量命名不清晰，可以进行重命名。通过代码审查和重构，可以不断提高脚本的质量，使其更健壮、更易于维护。
（三）引入自动化测试
为了确保重构后的脚本功能正常，可以引入自动化测试。在Bash中，可以使用一些测试框架，如 bats（Bash Automated Testing System）。例如，对于上述Web应用部署脚本中的 clone_repo 函数，可以编写如下测试：
#!/usr/bin/env bats
@test "Clone repo successfully" {
run clone_repo https://github.com/user/repo.git
[ "$status" -eq 0 ]
}
将上述测试代码保存为 test_deployment.bats 文件，然后使用 bats test_deployment.bats 命令运行测试。通过自动化测试，可以在每次重构后快速验证脚本的功能是否正常，避免引入新的问题。