Elixir项目编译时Plug的init函数异常执行问题咨询
问题原因
- Plug 的
init/1函数设计上就是编译期执行的,作用是提前预处理插件配置,降低每次请求运行call/2函数的开销。你写在init/1内的所有代码都会在项目编译阶段直接运行,所以你会在编译输出中看到对应的 debug 日志。 - 你当前的写法还存在两个隐藏问题:
- 配置读取的 OTP 应用名不匹配:你在
config.exs中是给:api_server应用下的APIServer.APIKeyAuthPlug键写入配置,但是路由器中传参时调用的是Application.fetch_env(:probe_server, APIServer.APIKeyAuthPlug),两个应用名不一致,如果:probe_server下没有对应配置,会直接返回:error,和你init/1中写的{:ok, options}匹配就会抛出编译错误。 - 环境变量是编译期读取:你在
config.exs中直接用System.get_env读取配置,同时配置在编译期就被注入到 Plug 中,最终的 API 密钥会直接硬编码到编译产物里,如果你是部署阶段才注入环境变量,运行时的环境变量值不会生效,只会保留编译时的环境变量值。
- 配置读取的 OTP 应用名不匹配:你在
修复建议
- 如果要保留编译期初始化的逻辑,只需要修正应用名不匹配的问题即可,把路由器中
Application.fetch_env的第一个参数改为:api_server。 - 如果需要运行时读取 API 密钥(比如避免密钥硬编码到编译产物、支持运行时动态修改配置),可以改成如下写法:
- 路由器中不传静态配置:
plug APIKeyAuthPlug- Plug 中改为在 call 函数读取运行时配置:
同时建议把配置移到defmodule APIServer.APIKeyAuthPlug do require Logger alias APIServer.Util def init(_opts), do: nil def call(conn, _opts) do key = Application.get_env(:api_server, __MODULE__, [])[:apikey] Logger.debug("Registered key #{inspect(key)}") conn_key = Plug.Conn.get_req_header(conn, "x-api-key") |> hd # rest of the call function end endruntime.exs中读取,确保拿到运行时的环境变量:# config/runtime.exs config :api_server, APIServer.APIKeyAuthPlug, apikey: System.get_env("API_SERVER_APIKEY") || "XYZ"
内容的提问来源于stack exchange,提问作者mszmurlo
相关产品推荐
相关产品推荐

