如何更优地为多目录批量创建公共文件symlink符号链接

问题描述 #

现有项目目录结构如下，需要为公共文件 common/provider.tf 在所有环境目录、模块目录下创建指向该文件的符号链接：

/
├─ common
│  ├─ provider.tf
├─ environments/
│  ├─ prod/
│  │  ├─ module/

初始实现靠硬编码目录层级的Shell脚本完成软链创建，代码如下：

if [ -e "../../../common/provider.tf" ]; then  # 判断当前在 environments/prod/module 目录
    ln -s ../../../common/provider.tf provider.tf
else  # 判断当前在项目根目录
    ln -s common/provider.tf $environment/provider.tf  # $environment 为 environments/prod 类的环境路径
fi

该实现硬编码了相对路径层级，新增目录、调整目录嵌套深度时都需要修改脚本判断逻辑，扩展性差。实际场景中存在大量环境目录、多层嵌套的模块目录，需要支持递归批量执行软链创建逻辑。

实现方案 #

方案1：通用Shell脚本（无硬编码，自适应任意目录深度） #

核心思路是固定从项目根目录执行脚本，递归遍历environments下的所有子目录，自动计算每个目录到公共provider.tf的相对路径后创建软链，无需手动维护路径层级：

#!/bin/bash
set -e

# 校验执行位置与公共文件存在性
ROOT_DIR=$(pwd)
COMMON_FILE="$ROOT_DIR/common/provider.tf"
if [ ! -f "$COMMON_FILE" ]; then
    echo "执行错误：请在项目根目录运行本脚本，确保common/provider.tf存在"
    exit 1
fi

# 递归遍历environments下所有目录
find "$ROOT_DIR/environments" -type d | while read -r target_dir; do
    link_target="$target_dir/provider.tf"
    # 跳过已存在的软链/文件，避免覆盖冲突
    if [ -L "$link_target" ] || [ -f "$link_target" ]; then
        continue
    fi
    # 自动计算相对路径，兼容任意嵌套深度
    rel_path=$(realpath --relative-to="$target_dir" "$COMMON_FILE")
    ln -s "$rel_path" "$link_target"
    echo "创建软链成功：$link_target -> $rel_path"
done

该方案优势：

• 无任何硬编码的路径层级，支持任意深度的模块嵌套，新增环境、新增模块时无需修改脚本，重复执行即可自动补全新目录的软链
• 自动跳过已存在的文件，不会出现覆盖、重复创建报错的问题，可以直接接入项目初始化流程，每次拉取代码后自动执行
• 创建的软链为相对路径，项目目录整体移动位置后软链不会失效

方案2：Terraform原生优化（从根源消除软链需求） #

如果是Terraform项目，完全可以不用维护软链：

• 统一在根模块声明provider配置块（包含鉴权、区域、endpoint等实际参数）
• 子模块、各环境目录只需要通过required_providers声明依赖的provider版本约束即可，不需要重复写provider初始化配置，直接继承根模块的provider实例
• 多环境差异可以通过Terraform工作区、var变量区分，不需要每个目录单独放provider文件

内容的提问来源于stack exchange，提问作者emboole