如何减少不同Terraform模块中locals.tf文件的逻辑重复？

方案1：创建通用环境转换模块 #

这是Terraform中最规范的去重方式，把环境映射和转换逻辑封装成独立模块，所有需要转换值的模块统一调用它，彻底消除重复代码。

实现步骤： #

1. 创建名为env-converter的模块目录，结构如下：

env-converter/
├── main.tf
├── variables.tf
└── outputs.tf

2. 在env-converter/variables.tf定义输入变量：

variable "env" {
  type        = string
  description = "环境标识（如prd/stg/qa）"
}

3. 在env-converter/main.tf实现转换逻辑：

locals {
  environment_map = {
    prd = "Production"
    stg = "Staging"
    qa  = "QA"
  }
  subdomain_map = {
    prd = "www"
    stg = "stage"
    qa  = "test"
  }
}

locals {
  Environment = lookup(local.environment_map, var.env, var.env)
  subdomain = lookup(local.subdomain_map, var.env, "${var.env}.dev")
}

4. 在env-converter/outputs.tf定义输出：

output "Environment" {
  type        = string
  description = "格式化后的环境名称"
  value       = local.Environment
}

output "subdomain" {
  type        = string
  description = "对应环境的子域名"
  value       = local.subdomain
}

5. 在其他模块中调用该模块：

module "env" {
  source = "../env-converter" # 替换为实际模块路径
  env    = var.env
}

# 直接使用转换后的值
resource "aws_s3_bucket" "example" {
  bucket = "${module.env.Environment}-assets"
}

优点：逻辑完全集中，更新模块即可同步所有调用方；符合Terraform模块化最佳实践，可读性和可维护性强。

方案2：共享HCL配置文件+轻量本地值 #

如果不想创建独立模块，可以把映射规则集中在一个HCL文件里，每个模块仅通过少量代码加载并应用转换逻辑，减少重复的映射定义。

实现步骤： #

1. 在项目根目录创建env_config.hcl文件，集中存储映射规则：

environment_map = {
  prd = "Production"
  stg = "Staging"
  qa  = "QA"
}
subdomain_map = {
  prd = "www"
  stg = "stage"
  qa  = "test"
}
subdomain_default_suffix = ".dev"

2. 在每个模块的locals.tf中加载配置并计算值：

locals {
  env_config = hcldecode(file("../env_config.hcl")) # 替换为实际文件路径
  Environment = lookup(local.env_config.environment_map, var.env, var.env)
  subdomain = lookup(local.env_config.subdomain_map, var.env, "${var.env}${local.env_config.subdomain_default_suffix}")
}

优点：无需额外模块，配置数据集中管理；每个模块仅需几行重复代码，逻辑简单易懂。

方案3：根模块输出传递（不推荐） #

可以在根模块中定义转换逻辑并输出，子模块直接引用根模块的输出，但这种方式依赖固定的模块层级关系，灵活性较差，仅适合简单项目。

示例： #

在根模块的outputs.tf中定义转换后的值：

output "Environment" {
  type = string
  value = lookup({
    prd = "Production"
    stg = "Staging"
    qa  = "QA"
  }, var.env, var.env)
}

output "subdomain" {
  type = string
  value = lookup({
    prd = "www"
    stg = "stage"
    qa  = "test"
  }, var.env, "${var.env}.dev")
}

在子模块中引用根模块输出（需确保子模块是根模块的直接子节点）：

resource "aws_cloudfront_distribution" "example" {
  origin {
    domain_name = "${module.root.subdomain}.example.com"
  }
}

缺点：模块层级耦合严重，调整项目结构时容易出错；不适合复杂的多模块项目。

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