OCaml代码Unbound record field api_key错误排查求助

运行dune build时持续出现以下错误：

File "lib/ip2locationio.ml", line 25, characters 73-80:
25 |     let uri = Uri.of_string ("https://api.ip2location.io/?key=" ^ config.api_key ^ "&format=" ^ config.format ^ "&source=" ^ config.source ^ "&source_version=" ^ config.source_version ^ "&ip=" ^ ip ^ lang_str) in
                                                                              ^^^^^^^
Error: Unbound record field api_key

已在.mli文件中定义模块签名，但问题仍未解决，相关代码如下：

ip2locationio.ml 文件 #

open Lwt
open Cohttp
open Cohttp_lwt_unix
open Yojson

module Configuration = struct
  type config = {
    source_version : string;
    api_key : string;
    format: string;
    source: string
  }
  
  let init api_key = {
    source_version = "1.0.0";
    api_key = api_key;
    format = "json";
    source = "sdk-ocaml-iplio"
  }
end

module Ip_geolocation = struct
  let call_api config ip lang =
    let lang_str = if lang == "" then "" else "&lang=" ^ lang in
    let uri = Uri.of_string ("https://api.ip2location.io/?key=" ^ config.api_key ^ "&format=" ^ config.format ^ "&source=" ^ config.source ^ "&source_version=" ^ config.source_version ^ "&ip=" ^ ip ^ lang_str) in
    
    Lwt_main.run begin
      Client.get uri >>= fun (resp, body) ->
        let code = resp |> Response.status |> Code.code_of_status in
        let json_promise = body |> Cohttp_lwt.Body.to_string in
        json_promise >>= (fun json_string ->
          return (code, json_string)
        )
    end
  
  (** Call the API to get geolocation info *)
  let lookup config ip lang =
    let code, json_string = call_api config ip lang in
    let json = Basic.from_string json_string in
    (code, json)
end

ip2locationio.mli 文件 #

module Configuration :
  sig
    type config = {
      source_version : string;
      api_key : string;
      format: string;
      source: string;
    }
    val init : string -> config
  end
module Ip_geolocation :
  sig
    val lookup :
      Configuration.config -> string -> string -> int * Yojson.Basic.t
  end

问题原因 #

核心问题在于模块签名的抽象性：你在.mli中为Configuration模块定义了显式签名，即使签名里写出了config记录的字段结构，OCaml 编译器仍会将其视为抽象类型——外部模块（比如Ip_geolocation）无法直接访问该类型的字段，因为从外部视角看，这个类型的内部结构是不透明的。

解决方案 #

有两种常见的解决思路，可根据需求选择：

方式一：让记录类型在签名中透明化 #

修改.mli文件，明确保留config类型的完整结构，让编译器允许外部模块直接访问字段：

module Configuration :
  sig
    type config = {
      source_version : string;
      api_key : string;
      format: string;
      source: string;
    } [@@deriving show]  (* 可选，用于调试输出 *)
    val init : string -> config
  end

修改后，Ip_geolocation模块中直接访问config.api_key的代码就能正常编译。

方式二：添加字段访问器（保持类型抽象） #

如果希望隐藏config的内部结构、遵循封装原则，可以在Configuration模块中添加字段访问函数，通过函数间接获取字段值：

1. 在ip2locationio.ml的Configuration模块中添加访问器：

module Configuration = struct
  type config = {
    source_version : string;
    api_key : string;
    format: string;
    source: string
  }
  
  let init api_key = {
    source_version = "1.0.0";
    api_key = api_key;
    format = "json";
    source = "sdk-ocaml-iplio"
  }

  (* 添加字段访问器 *)
  let get_api_key { api_key; _ } = api_key
  let get_format { format; _ } = format
  let get_source { source; _ } = source
  let get_source_version { source_version; _ } = source_version
end

2. 在ip2locationio.mli的Configuration签名中声明这些访问器：

module Configuration :
  sig
    type config  (* 保持类型抽象 *)
    val init : string -> config
    val get_api_key : config -> string
    val get_format : config -> string
    val get_source : config -> string
    val get_source_version : config -> string
  end

3. 修改Ip_geolocation模块中的代码，通过访问器获取字段：

let uri = Uri.of_string ("https://api.ip2location.io/?key=" ^ Configuration.get_api_key config ^ "&format=" ^ Configuration.get_format config ^ "&source=" ^ Configuration.get_source config ^ "&source_version=" ^ Configuration.get_source_version config ^ "&ip=" ^ ip ^ lang_str) in

这种方式能避免外部模块依赖config的内部结构，后续修改记录字段时无需同步修改外部代码。

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