在Bash脚本中获取自身所在目录的方法

技术背景

在使用Bash脚本时，有时需要获取脚本自身所在的目录。比如，当脚本作为另一个应用程序的启动器时，需要将工作目录更改为脚本所在的目录，以便对该目录中的文件进行操作。然而，由于脚本的调用方式多样（如绝对路径、相对路径、符号链接等），获取脚本所在目录并非总是 straightforward。

实现步骤

1. 使用dirname和$0

这是最基本的方法，$0代表脚本的名称，dirname用于提取路径中的目录部分。

#!/usr/bin/env bash

echo "The script you are running has:"
echo "basename: [$(basename "$0")]"
echo "dirname : [$(dirname "$0")]"
echo "pwd     : [$(pwd)]"

不过，这种方法有局限性。如果脚本通过符号链接执行，会得到链接所在的路径；如果脚本被source执行，$0的值可能不是预期的脚本名称。

2. 使用readlink -f

readlink -f可以将路径解析为绝对路径，结合dirname可以得到脚本所在的目录。

dirname -- "$( readlink -f -- "$0"; )";

示例脚本：

#!/usr/bin/env bash

echo "pwd: `pwd`"
echo "\$0: $0"
echo "basename: `basename -- "$0"`"
echo "dirname: `dirname -- "$0"`"
echo "dirname/readlink: $( dirname -- "$( readlink -f -- "$0"; )"; )"

但readlink -f是GNU扩展，在某些系统（如BSD）上可能不可用。

3. 使用BASH_SOURCE数组

BASH_SOURCE是一个数组，BASH_SOURCE[0]表示当前脚本的名称。结合dirname和realpath可以可靠地获取脚本所在目录。

#!/usr/bin/env bash

scriptdir="$( dirname -- "${BASH_SOURCE[0]}"; )";
scriptdir="$( realpath -e -- "$scriptdir"; )";

echo "Script directory: $scriptdir"

这种方法在脚本被source执行时也能正常工作。

4. 处理符号链接的多步骤方法

#!/usr/bin/env bash

SOURCE=${BASH_SOURCE[0]}
while [ -L "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
  SOURCE=$(readlink "$SOURCE")
  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
done
DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )

echo "Script directory: $DIR"

该方法可以处理各种复杂情况，如符号链接、别名等。

核心代码

简洁实用的单行程代码

SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

处理符号链接的多行程代码

#!/usr/bin/env bash

SOURCE=${BASH_SOURCE[0]}
while [ -L "$SOURCE" ]; do
  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
  SOURCE=$(readlink "$SOURCE")
  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE
done
DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )

echo "Script directory: $DIR"

最佳实践

• 跨平台兼容性：考虑使用的命令在不同系统上的兼容性，如readlink -f在某些系统上不可用，可以使用realpath替代。
• 处理特殊字符：在处理路径时，确保对路径进行正确的引号处理，以避免空格、特殊字符等导致的问题。
• 代码健壮性：在脚本开始处获取脚本所在目录，避免在脚本执行过程中因cd命令改变工作目录而导致结果错误。

常见问题

1. 脚本被source执行时$0的值不正确

当脚本被source执行时，$0通常会返回bash或当前执行的shell名称，而不是脚本的名称。此时应使用BASH_SOURCE[0]代替$0。

2. 路径中包含空格或特殊字符

如果路径中包含空格或特殊字符，未正确引号处理会导致命令执行错误。应始终使用双引号将路径括起来，如"$(dirname "${BASH_SOURCE[0]}")"。

3. 符号链接处理问题

如果脚本通过符号链接执行，简单的dirname $0可能返回符号链接所在的目录，而不是实际脚本所在的目录。可以使用readlink -f或多步骤方法来解析符号链接。

4. 不同系统命令兼容性问题

一些命令（如readlink -f、realpath）在不同系统上的可用性不同。在编写脚本时，需要考虑目标系统的环境，或者提供备用方案。