Typesafe config HOCON - 环境变量替换列表的指南？

Question

这是我最终使用的，因为我似乎无法以良好的顺序进行变量替换。鉴于 CORS Allowed Origins 的 Play Framework HOCON 部分，它允许本地、开发、阶段和生产部署，并且不符合 12 因素：

play {
  # https://www.playframework.com/documentation/2.5.x/resources/confs/filters-helpers/reference.conf
  filters {
    # use default values for gzip, csrf & security headers
    # setup cors
    cors {
      # whitelist all paths
      pathPrefixes = ["/"]
      allowedOrigins = [
        "http://localhost:8080"
        "http://app.127.0.0.1.nip.io:8080"
        "http://app.192.168.64.2.nip.io"
        "http://app.192.168.42.173.nip.io"
        "http://app.terradatum.local"
        "http://app.dev.terradatum.com"
        "https://app.dev.terradatum.com"
        "http://app.stage.terradatum.com"
        "https://app.stage.terradatum.com"
        "http://app.terradatum.com"
        "https://app.terradatum.com"
      ]
    }
  }
}

以下两种HOCON我都试过了，环境设置也如图：

# HOCON
allowedOrigins = ${?APP_ALLOWED_ORIGINS}
# ENV
export APP_ALLOWED_ORIGINS='"http://app.127.0.0.1.nip.io:8080","http://app.192.168.64.2.nip.io","http://app.192.168.42.173.nip.io","http://app.terradatum.local","http://app.dev.terradatum.com","https://app.dev.terradatum.com","http://app.stage.terradatum.com","https://app.stage.terradatum.com","http://app.terradatum.com","https://app.terradatum.com"'

还有……

# HOCON
allowedOrigins = [
  ${?APP_ALLOWED_ORIGINS}
  "http://app.127.0.0.1.nip.io:8080"
  "http://app.192.168.64.2.nip.io"
  "http://app.192.168.42.173.nip.io"
  "http://app.terradatum.local"
  "http://app.dev.terradatum.com"
  "https://app.dev.terradatum.com"
  "http://app.stage.terradatum.com"
  "https://app.stage.terradatum.com"
  "http://app.terradatum.com"
  "https://app.terradatum.com"
]
# ENV
export APP_ALLOWED_ORIGINS="http://some-new-cors.terradatum.com\nhttps://some-new-cors.terradatum.com\n"

许多其他的 CORS 实现都允许使用正则表达式，而 WTH 不能播放？

除此之外，列表的 HOCON 处理对我来说非常成问题......上面的第一个实现工作，但是任何迭代我在 application.conf 中有一个现有的默认列表失败......

通过环境变量替换向 HOCON 添加列表或列表项的推荐方法是什么？

Answer 1

如果我正确阅读了您的帖子（我没有在其中看到真正的“问题”），那么您正在尝试找到一种方法来将不同的值添加到您的 CORS 列表中，具体取决于您的应用运行的环境。

我建议从另一个角度解决这个问题： 创建不同的配置文件，其中包含您要自定义的值并包含通用 application.conf 文件。在您的部署配置中，让 play 加载您的暂存配置而不是 application.conf。

例如如果您创建了您的开发阶段，请将其添加到您的部署配置中（假设您将 sbt-native-packager 与 docker 一起使用）

javaOptions in Universal ++= Seq(
  "-Dconfig.resource=application.dev.conf"
)

您的 application.dev.conf 文件如下所示：

include "application.conf"
play.filters.cors {
      # whitelist all paths
      pathPrefixes = ["/"]
      allowedOrigins = [
        "http://localhost:8080"
        "http://app.127.0.0.1.nip.io:8080"
        "http://app.192.168.64.2.nip.io"
        "http://app.192.168.42.173.nip.io"
        "http://app.terradatum.local"
        "http://app.dev.terradatum.com"
        "https://app.dev.terradatum.com"

      ]
    }

问题是，您的环境变量不是一个列表，而是一个字符串。HOCON 中没有可以将您的字符串拆分为列表的转换方法。

要遵循 12 因素方法，您可以尝试将列表（的变化部分）拆分为类似

ORIGIN_1=http://localhost:8080
ORIGIN_2=http://app.127.0.0.1.nip.io:8080

然后将它们包含在您的配置中，例如

play.filters.cors.allowedOrigins = [${?ORIGIN_1}] ${play.filters.cors.allowedOrigins}
play.filters.cors.allowedOrigins = [${?ORIGIN_2}] ${play.filters.cors.allowedOrigins}