Ktor项目中.env文件位置、多配置环境实现及变量解析问题

Ktor基于HOCON格式配置文件，可通过以下几种方式实现多环境切换：

• 方式1：配置文件内定义环境块+环境变量切换
  在resources/application.conf中定义不同环境的配置块，通过环境变量指定激活的环境：

// 公共配置
common {
    appName = "MyKtorApp"
}

// 开发环境配置
development {
    connectionString = "jdbc:mysql://localhost:3306/dev_db"
    port = 8080
}

// 生产环境配置
production {
    connectionString = "jdbc:mysql://prod-host:3306/prod_db"
    port = 80
}

// 指定激活的环境，默认development
ktor {
    deployment {
        environment = ${ENVIRONMENT:-development}
    }
}

// 引用当前环境的配置
connectionString = ${${ktor.deployment.environment}.connectionString}
port = ${${ktor.deployment.environment}.port}

启动时通过环境变量切换环境：

# 激活生产环境
ENVIRONMENT=production ./gradlew run

• 方式2：单独的环境配置文件+命令行参数加载
  创建resources/application-development.conf和resources/application-production.conf，启动时通过命令行参数指定加载的配置文件：

# 加载生产环境配置文件
./gradlew run -Dconfig.file=src/main/resources/application-production.conf

Ktor本身不原生支持.env文件，需要借助第三方库加载环境变量，再让HOCON配置解析这些变量：

1. 解决变量解析失败步骤 #

步骤1：添加依赖 #

以Gradle为例，在build.gradle.kts中添加dotenv库依赖：

dependencies {
    implementation("com.github.dotenv:dotenv-kotlin:6.4.1")
}

步骤2：加载.env并注入系统环境变量 #

在项目启动类（如Application.kt）中，先加载.env文件，将变量注入系统环境变量，这样HOCON就能解析${CONNECTION_STRING}：

import io.github.cdimascio.dotenv.dotenv
import io.ktor.server.engine.*
import io.ktor.server.netty.*

fun main() {
    // 加载项目根目录的.env文件
    val dotenv = dotenv {
        directory = "./"
        filename = ".env"
    }
    // 将.env变量注入系统属性
    dotenv.entries().forEach { System.setProperty(it.key, it.value) }

    // 启动Ktor服务
    embeddedServer(Netty, port = 8080, host = "0.0.0.0") {
        // 配置你的模块
    }.start(wait = true)
}

2. .env文件的正确位置 #

.env文件放在项目根目录（与src文件夹同级）是正确的，只要确保运行项目时的工作目录是项目根：

• IDEA默认会以项目根作为工作目录，直接运行即可；
• 命令行执行./gradlew run时，也是在项目根目录执行，能正确读取.env；
• 如果自定义了工作目录，需要在dotenv配置中指定正确的.env文件路径。

另外，也可以不使用.env，直接在启动时通过环境变量传递：

CONNECTION_STRING="jdbc:mysql://localhost:3306/mydb" ./gradlew run

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