第五章 记录
OCaml 最好的特性之一就是其简捷且富有表达力的用以声明新数据类型的系统,记录是这个系统的一个关键要素。在第一章导览中我们简要讨论了一下记录,但本章会更深入,覆盖记录类型的工作原理,以及如何在软件设计中有效使用它们的建议。
记录表示一组存储在一起的值,每个组件由一个不同的字段名标识。记录类型的基本语法如下所示:
type <record-name> =
{ <field> : <type> ;
<field> : <type> ;
...
}
(* Syntax ∗ records/record.syntax ∗ all code *)
注意记录的字段名必须以小写字母开头。
这里有一个简单例子,记录host_info
是一个计算机的信息摘要:
# type host_info =
{ hostname : string;
os_name : string;
cpu_arch : string;
timestamp : Time.t;
};;
type host_info = {
hostname : string;
os_name : string;
cpu_arch : string;
timestamp : Time.t;
}
(* OCaml Utop ∗ records/main.topscript ∗ all code *)
我们可以同样容易地构建一个host_info
。下面的代码中使用了Core_extended
中的Shell
模块,用以将命令转发给 shell 以提取所需的当前系统信息。也使用了Core
的Time
模块的Time.now
:
# #require "core_extended";;
# open Core_extended.Std;;
# let my_host =
let sh = Shell.sh_one_exn in
{ hostname = sh "hostname";
os_name = sh "uname -s";
cpu_arch = sh "uname -p";
timestamp = Time.now ();
};;
val my_host : host_info =
{hostname = "ocaml-www1"; os_name = "Linux"; cpu_arch = "unknown";
timestamp = 2013-08-18 14:50:48.986085+01:00}
(* OCaml Utop ∗ records/main.topscript , continued (part 1) ∗ all code *)
你可能会问编译器是如何知道my_host
是host_info
类型的。这里编译器用以推断类型的方法就是根据记录的字段名。本章稍后我们会讨论当一个作用域中出现多个有相同字段名的记录类型时会如何。
有了记录值,我们就可以使用点号.
来从中提取字段:
# my_host.cpu_arch;;
- : string = "unknown"
(* OCaml Utop ∗ records/main.topscript , continued (part 2) ∗ all code *)
当声明一个 OCaml 类型时,你总是可以用一个多态类型将其参数化。记录在这方面并无二致。所以,下面的例子中是一个类型,可以给任意物品加时间戳:
# type 'a timestamped = { item: 'a; time: Time.t };;
type 'a timestamped = { item : 'a; time : Time.t; }
(* OCaml Utop ∗ records/main.topscript , continued (part 3) ∗ all code *)
然后我们就可以写出操作这个参数化类型的多态函数了:
# let first_timestamped list =
List.reduce list ~f:(fun a b -> if a.time < b.time then a else b)
;;
val first_timestamped : 'a timestamped list -> 'a timestamped option = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 4) ∗ all code *)
模式和穷尽性
从记录获取信息的另一种方法是使用模块匹配,就像下面host_info_to_string
的定义所示:
# let host_info_to_string { hostname = h; os_name = os;
cpu_arch = c; timestamp = ts;
} =
sprintf "%s (%s / %s, on %s)" h os c (Time.to_sec_string ts);;
val host_info_to_string : host_info -> string = <fun>
# host_info_to_string my_host;;
- : string = "ocaml-www1 (Linux / unknown, on 2013-08-18 14:50:48)"
(* OCaml Utop ∗ records/main.topscript , continued (part 5) ∗ all code *)
注意我们使用的模块只有一种情况,而不是由|
分割的多种情况。我们只需要一个模式,是因为记录类型的模式是 不可辩驳的(irrefutable),就是说一个记录的模式匹配在运行时永远都不会失败。这是有道理的,因为记录中的字段总是相同的。通常,固定结构类型的模式都是不会失败的,如记录和元组,而列表和变体这种可变结构的类型就不是。
记录模式的另一个特点是它们不需要是完整的:一个模式可以只包含记录的一部分字段。这会带来方便,但也容易出错。特别是,这意味着当向记录中添加新字段时,编译器不会提示必须要更新代码以反映这些新字段。
举个例子,假如我们向记录host_info
添加一个叫作os_release
的字段,如下所示:
# type host_info =
{ hostname : string;
os_name : string;
cpu_arch : string;
os_release : string;
timestamp : Time.t;
} ;;
type host_info = {
hostname : string;
os_name : string;
cpu_arch : string;
os_release : string;
timestamp : Time.t;
}
(* OCaml Utop ∗ records/main.topscript , continued (part 6) ∗ all code *)
这时host_info_to_string
的代码不经修改也仍然可以编译。但这种情况下,很明显你可能是希望更新host_info_to_string
以包含os_release
的,编译器最好能针对这种改变给出一个警告。
幸运的是,OCaml 的确提供了一个可选的警告用以提示一个记录模式中有字段缺失。打开这个警告(在 toplevel 中键入#warning "+9"
),编译器就会警告缺失的字段:
# #warnings "+9";;
# let host_info_to_string { hostname = h; os_name = os;
cpu_arch = c; timestamp = ts;
} =
sprintf "%s (%s / %s, on %s)" h os c (Time.to_sec_string ts);;
Characters 24-139:
Warning 9: the following labels are not bound in this record pattern:
os_release
Either bind these labels explicitly or add '; _' to the pattern.val host_info_to_string : host_info -> string = <fun>
对于给定的模式,如果确定要忽略其余的字段,可以禁止这个警告。在模式最后加一个下划线即可:
# let host_info_to_string { hostname = h; os_name = os;
cpu_arch = c; timestamp = ts; _
} =
sprintf "%s (%s / %s, on %s)" h os c (Time.to_sec_string ts);;
val host_info_to_string : host_info -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 8) ∗ all code *)
打开不完整记录匹配的警告,然后在需要的地方用_
显式禁止它是个好主意。
编译器警告
OCaml 编译器有许多有用的警告,可以分别使能或禁止。编译器自身就有这方面文档,所以我们可以像下面这样查看 9 号警告:
$ ocaml -warn-help | egrep '\b9\b' 9 Missing fields in a record pattern. R Synonym for warning 9. # Terminal ∗ records/warn_help.out ∗ all code
你应该把 OCaml 的警告当成一组功能强大的静态分析工具,要在你的构建环境中积极使用它们。当然你通常不可能打开所有警告,编译器默认的就已经很好了。
构建本书示例所用的警告是使用下面的标志指定的:
-w @A-4-33-41-42-43-34-44
。上面这个语法可以运行
ocaml -help
查看,除了A
后面显式列出的数字,这个标志会把所有警告都视为错误。把警告当成错误(即,触发警告时 OCaml 停止编译任何代码)是一个很好的实践,因为要不这样,开发过程中就很容易忽略警告。然而,准备要发行一个包时,这确不是个好主意,因为编译器版本升级,警告可能会增加,这就可能使你的包在新版本编译器下编译失败。
字段双关(Field Punning)
当变量名和记录的字段名一致时,OCaml 提供了一些方便的快捷语法。如下面的函数,其中的模式把所有字段都绑定到同名变量上。这叫作 字段双关 :
# let host_info_to_string { hostname; os_name; cpu_arch; timestamp; _ } =
sprintf "%s (%s / %s) <%s>" hostname os_name cpu_arch
(Time.to_string timestamp);;
val host_info_to_string : host_info -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 9) ∗ all code *)
字段双关也可以用于构造一个记录。考虑下面的代码,它创建了一个host_info
记录:
# let my_host =
let sh cmd = Shell.sh_one_exn cmd in
let hostname = sh "hostname" in
let os_name = sh "uname -s" in
let cpu_arch = sh "uname -p" in
let os_release = sh "uname -r" in
let timestamp = Time.now () in
{ hostname; os_name; cpu_arch; os_release; timestamp };;
val my_host : host_info = {hostname = "flick.local"; os_name = "Darwin"; cpu_arch = "i386"; os_release = "13.0.0"; timestamp = 2013-11-05 08:49:41.499579-05:00}
(* OCaml Utop ∗ records/main.topscript , continued (part 10) ∗ all code *)
上面的代码中,我们根据记录字段定义了相关变量,然后记录声明就可以自己简单地列出所需的字段。
当从标签参数构造记录时,你可以同时获得字段双关和标签双关带来的好处:
# let create_host_info ~hostname ~os_name ~cpu_arch ~os_release =
{ os_name; cpu_arch; os_release;
hostname = String.lowercase hostname;
timestamp = Time.now () };;
val create_host_info : hostname:string -> os_name:string -> cpu_arch:string -> os_release:string -> host_info = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 11) ∗ all code *)
这比不使用双关要简明得多:
# let create_host_info
~hostname:hostname ~os_name:os_name
~cpu_arch:cpu_arch ~os_release:os_release =
{ os_name = os_name;
cpu_arch = cpu_arch;
os_release = os_release;
hostname = String.lowercase hostname;
timestamp = Time.now () };;
val create_host_info : hostname:string -> os_name:string -> cpu_arch:string -> os_release:string -> host_info = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 12) ∗ all code *)
标签参数、字段名以及字段和标签双关,这些加在一起,鼓励你的代码库中传递相同的名称。这通常一种好的实践,因为它鼓励一致的命名,这使源代码更易驾驭。
字段名复用
使用相同名字的字段定义记录是有问题的。让我们看一个简单例子:构建一些类型用以表示一个日志服务器使用的协议。
我们将描述三类消息:log_entry
,heartheat
和logon
。log_entry
消息用以向服务器传递一条日志;logon
消息用以初始化连接,包含连接用户的身份标识和认证证书;heartbeat
消息由客户端定期发给服务器以表明该客户还活动并且已连接。所有这些消息都包含一个会话 ID 和一个消息创建时间:
# type log_entry =
{ session_id: string;
time: Time.t;
important: bool;
message: string;
}
type heartbeat =
{ session_id: string;
time: Time.t;
status_message: string;
}
type logon =
{ session_id: string;
time: Time.t;
user: string;
credentials: string;
}
;;
type log_entry = {
session_id : string;
time : Time.t;
important : bool;
message : string;
}
type heartbeat = {
session_id : string;
time : Time.t;
status_message : string;
}
type logon = {
session_id : string;
time : Time.t;
user : string;
credentials : string;
}
(* OCaml Utop ∗ records/main.topscript , continued (part 13) ∗ all code *)
复用相同的字段名会引发一些歧义。举个例子,如果我们想从一个记录中提取session_id
,那么它的类型是什么呢?
# let get_session_id t = t.session_id;;
val get_session_id : logon -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 14) ∗ all code *)
这种情况下,OCaml 只会采用该字段最近的定义。我们可以使用类型注释来强制 OCaml 认为我们在处理不同的类型(如heartheat
):
# let get_heartbeat_session_id (t:heartbeat) = t.session_id;;
val get_heartbeat_session_id : heartbeat -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 15) ∗ all code *0
尽管可以使用类型注释解决字段名歧义,这种歧意还是有点迷惑人。看下面这个函数,从一个heartbeat
中提取会话 ID 和状态:
# let status_and_session t = (t.status_message, t.session_id);;
val status_and_session : heartbeat -> string * string = <fun>
# let session_and_status t = (t.session_id, t.status_message);;
Characters 44-58:
Error: The record type logon has no field status_message
# let session_and_status (t:heartbeat) = (t.session_id, t.status_message);;
val session_and_status : heartbeat -> string * string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 16) ∗ all code *)
为什么第一个定义不用类型注释就可以成功而第二个却失败了呢?不同点就在于第一种情况时,类型检查会先处理status_message
字段并确定这个记录是一个heartbeat
。当顺序改变时,session_id
被先考虑,因此类型被推导成logon
,这t.status_message
就不再有意义了。
通过不使用重复的字段名,或更一般的,通过为每个类型创建一个模块,我们就可以完全避免这种歧义。把类型包装在模块中是一个非常有用的惯用法(Core
中大量使用这种技术),为每个类型提供一个命名空间,在其中放置相关的值。使用这种风格时,标准的实践就将模块相关的类型命名为t
。使用这种风格我们可以这样写:
# module Log_entry = struct
type t =
{ session_id: string;
time: Time.t;
important: bool;
message: string;
}
end
module Heartbeat = struct
type t =
{ session_id: string;
time: Time.t;
status_message: string;
}
end
module Logon = struct
type t =
{ session_id: string;
time: Time.t;
user: string;
credentials: string;
}
end;;
module Log_entry :
sig
type t = {
session_id : string;
time : Time.t;
important : bool;
message : string;
}
end
module Heartbeat :
sig
type t = { session_id : string; time : Time.t; status_message : string; }
end
module Logon :
sig
type t = {
session_id : string;
time : Time.t;
user : string;
credentials : string;
}
end
(* OCaml Utop ∗ records/main.topscript , continued (part 17) ∗ all code *)
现在,我们的创建日志条目的函数可以像下面这样呈现:
# let create_log_entry ~session_id ~important message =
{ Log_entry.time = Time.now (); Log_entry.session_id;
Log_entry.important; Log_entry.message }
;;
val create_log_entry :
session_id:string -> important:bool -> string -> Log_entry.t = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 18) ∗ all code *)
因为此函数在定义记录类型的Log_entry
模块之外,所以需要使用模块名Log_entry
来限定字段。但是 OCaml 只要求限定一个记录字段,因此我们可以写得更简洁。注意模块路径和字段名之间允许加空白:
# let create_log_entry ~session_id ~important message =
{ Log_entry.
time = Time.now (); session_id; important; message }
;;
val create_log_entry :
session_id:string -> important:bool -> string -> Log_entry.t = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 19) ∗ all code *)
这不限于构造一个记录,我们也可以在模式匹配时使用相同的技巧:
# let message_to_string { Log_entry.important; message; _ } =
if important then String.uppercase message else message
;;
val message_to_string : Log_entry.t -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 20) ∗ all code *)
当使用点号访问记录字段时,我们可以直接使用模块来限定字段:
# let is_important t = t.Log_entry.important;;
val is_important : Log_entry.t -> bool = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 21) ∗ all code *)
第一次见到这样语法会使你大吃一惊。只要记清楚一件事就行了,就是点号用了两种使用方法:第一个点是记录字段存取,右边的所有东西都会被解释为一个字段名;第二个点号是访问模块内容,指向Log_entry
模块的important
字段。Log_entry
是大写字母开头的,不能作为字段名,这使得两种用途不会被混淆。
对于记录定义所在模块中的函数定义而言,模块限定完全不需要。
函数式更新
经常地,你会想要创建一个新的记录,这个记录和另一个已经存在的记录的差别只是某几个字段不一样。例如,想像一下我们的日志服务器有一个表示客户端状态的记录,包含了最后一次收到此客户端心跳包的时间。下面定义了一个表示这个信息的类型,以及一个收到新的心跳包时更新此客户端信息的函数:
# type client_info =
{ addr: Unix.Inet_addr.t;
port: int;
user: string;
credentials: string;
last_heartbeat_time: Time.t;
};;
type client_info = { addr : UnixLabels.inet_addr; port : int; user : string; credentials : string; last_heartbeat_time : Time.t; }
# let register_heartbeat t hb =
{ addr = t.addr;
port = t.port;
user = t.user;
credentials = t.credentials;
last_heartbeat_time = hb.Heartbeat.time;
};;
val register_heartbeat : client_info -> Heartbeat.t -> client_info = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 22) ∗ all code *)
这相当啰唆,我们其实只想改变一个字段,其它的字段都是直接从t
拷贝过去的。使用 OCaml 的函数式更新语法,我们可以做得更简洁。函数式更新的语法如下:
{ <record> with <field> = <value>;
<field> = <value>;
...
}
(* Syntax ∗ records/functional_update.syntax ∗ all code *)
这种语法的作用就是基于已有的记录,只改变几个字段来创建新记录。
有了这个,我们就可以更简洁地重写register_heartbeat
:
# let register_heartbeat t hb =
{ t with last_heartbeat_time = hb.Heartbeat.time };;
val register_heartbeat : client_info -> Heartbeat.t -> client_info = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 23) ∗ all code *)
函数式更新使你的代码独立于记录中未改变的字段。这通常会如你所愿,但也是有缺点的。如果你修改了记录定义,添加了更多的字段,类型系统不会提示你重新考虑你的代码是否需要修改以容纳新的字段。考虑如果你要添加一个字段表示最后收到的心跳包的状态信息,会发生什么:
# type client_info =
{ addr: Unix.Inet_addr.t;
port: int;
user: string;
credentials: string;
last_heartbeat_time: Time.t;
last_heartbeat_status: string;
};;
type client_info = { addr : UnixLabels.inet_addr; port : int; user : string; credentials : string; last_heartbeat_time : Time.t; last_heartbeat_status : string; }
(* OCaml Utop ∗ records/main.topscript , continued (part 24) ∗ all code *)
register_heartbeat
的原始版本现在无效了,因此编译器会及时警告你考虑如何处理新的字段。但是使用函数式更新的版本会继续编译通过,即使它错误地忽略了新的字段。正确的做法是像下面这样更新代码:
# let register_heartbeat t hb =
{ t with last_heartbeat_time = hb.Heartbeat.time;
last_heartbeat_status = hb.Heartbeat.status_message;
};;
val register_heartbeat : client_info -> Heartbeat.t -> client_info = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 25) ∗ all code *)
可变字段
和 OCaml 的大多数值一样,记录默认是不可变的。然而,你还是可以把记录的字段分别声明成可变的。在下面的代码中,我们使client_info
的最后两个字段可变:
# type client_info =
{ addr: Unix.Inet_addr.t;
port: int;
user: string;
credentials: string;
mutable last_heartbeat_time: Time.t;
mutable last_heartbeat_status: string;
};;
type client_info = { addr : UnixLabels.inet_addr; port : int; user : string; credentials : string; mutable last_heartbeat_time : Time.t; mutable last_heartbeat_status : string; }
(* OCaml Utop ∗ records/main.topscript , continued (part 26) ∗ all code *)
<-
操作符用以设置可变字段。register_heartbeat
的副作用版本如下:
# let register_heartbeat t hb =
t.last_heartbeat_time <- hb.Heartbeat.time;
t.last_heartbeat_status <- hb.Heartbeat.status_message
;;
val register_heartbeat : client_info -> Heartbeat.t -> unit = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 27) ∗ all code *)
注意在初始化时是不需要可变赋值(即<-
操作符)的,因为记录的所有字段,包括可变的,都会在记录创建时指定。
OCaml 默认不可变的策略是好的,但命令式编程也是 OCaml 编程的一个重要部分。我们会在“命令式编程”一章深入讨论如何(以及何时)使用 OCaml 的命令式特性。(原文中引用位置是第一章,这应该是错误的。 by clark。)
字段作为一等公民
考虑下面这个函数,从Logon
消息列表中提取用户名:
# let get_users logons =
List.dedup (List.map logons ~f:(fun x -> x.Logon.user));;
val get_users : Logon.t list -> string list = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 28) ∗ all code *)
这里我们写了一个小函数(fun x -> x.Logon.user)
来访问user
字段。这种访问器是非常常用的模式,如果自动生成会方便很多。Core
提供的fieldslib
(下面的这部分不如直接看原文档,by clark。)语法扩展就是用来干这个的。
记录类型声明之后的with fields
注解会引发扩展,应用到给定的类型声明上。所以,举个例子, 我们可以像下面这样定义Logon
:
# module Logon = struct
type t =
{ session_id: string;
time: Time.t;
user: string;
credentials: string;
}
with fields
end;;
module Logon :
sig type t = {
session_id : string;
time : Time.t;
user : string;
credentials : string;
}
val credentials : t -> string
val user : t -> string
val time : t -> Time.t
val session_id : t -> string
module Fields :
sig
val names : string list
val credentials :
([< `Read | `Set_and_create ], t, string) Field.t_with_perm
val user :
([< `Read | `Set_and_create ], t, string) Field.t_with_perm
val time :
([< `Read | `Set_and_create ], t, Time.t) Field.t_with_perm
val session_id : ([< `Read | `Set_and_create ], t, string) Field.t_with_perm
[ ... many definitions omitted ... ]
end
end
(* OCaml Utop ∗ records/main-29.rawscript ∗ all code *)
注意这会产生大量的输出,因为fieldslib
产生了一大堆处理记录字段的辅助函数。我们只讨论其中的少数几个;剩下的你可以从fieldslib
的文档学习。
其中一个要提及的函数就是Logon.user
,用以从一个logon
消息中提取user
字段:
# let get_users logons = List.dedup (List.map logons ~f:Logon.user);;
val get_users : Logon.t list -> string list = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 30) ∗ all code *)
除了生成段访问器函数,fieldslib
还创建了一个名为Fields
的子模块,此模块包含了每一个字段的一等公民表示,形式是一个类型为Field.t
的值。Field
模块提供了下列函数:
Field.name
返回一个字段名
Field.get
返回一个字段内容
Field.fset
函数式更新一个字段
Field.setter
当字段不可变时返回None
,可变时返回Some f
,其中f
是一个修改此字段的函数
Field.t
有两个类型参数:第一参数是记录类型,第二个是相关字段的类型。因此,Logon.Fields.session_id
的类型是(Logon.t, string) Field.t
,而Logon.Fields.time
的类型是(Logon.t, Time.t) Field.t
。因此,如果你对Logon.Fields.user
调用Field.get
,将会得到一个从Logon.t
中提取user
字段的函数:
# Field.get Logon.Fields.user;;
- : Logon.t -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 31) ∗ all code *)
因此,Field.t
的第一参数是关于你传入的记录的,第二个参数是关于字段中包含的值的类型的, 这同时也是get
的返回值类型。
Field.get
的类型比你之前遇到的都要复杂一些:
# Field.get;;
- : ('b, 'r, 'a) Field.t_with_perm -> 'r -> 'a = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 32) ∗ all code *)
类型是Field.t_with_perm
而不是Field.t
是因为有时字段会有访问控制,所以我们只是暴露从记录中读取一个字段的能力,而不是创建一个新的记录的能力,因此我们不能暴露函数式更新。(这段第二遍大体上看懂了。by clark)
使用作为一等公民的字段,我们可以写出一个显示一个记录字段的通用函数:
# let show_field field to_string record =
let name = Field.name field in
let field_string = to_string (Field.get field record) in
name ^ ": " ^ field_string
;;
val show_field :
('a, 'b, 'c) Field.t_with_perm -> ('c -> string) -> 'b -> string = <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 33) ∗ all code *)
它接收三个参数:Field.t
,一个把字段内容转换成字符串的函数,和一个从中提取字段的记录。
下面是一个使用show_field
的例子:
# let logon = { Logon.
session_id = "26685";
time = Time.now ();
user = "yminsky";
credentials = "Xy2d9W"; }
;;
val logon : Logon.t =
{Logon.session_id = "26685"; time = 2013-11-05 08:49:43.946365-05:00;
user = "yminsky"; credentials = "Xy2d9W"}
# show_field Logon.Fields.user Fn.id logon;;
- : string = "user: yminsky"
# show_field Logon.Fields.time Time.to_string logon;;
- : string = "time: 2013-11-05 08:49:43.946365-05:00"
(* OCaml Utop ∗ records/main.topscript , continued (part 34) ∗ all code *)
要指出的是,上面的例子中我们首次使用了Fn
模块(“function”的缩写),它提供了一组有用的原语来操作函数。Fn.id
是标识函数。
fieldslib
也提供了一些高级操作符,如Fields.fold
和Fields.iter
,让你可以遍历一个记录的字段。举个例子,使用Logon.t
时,字段迭代器类型如下:
# Logon.Fields.iter;;
- : session_id:(([< `Read | `Set_and_create ], Logon.t, string)
Field.t_with_perm -> 'a) ->
time:(([< `Read | `Set_and_create ], Logon.t, Time.t) Field.t_with_perm ->
'b) ->
user:(([< `Read | `Set_and_create ], Logon.t, string) Field.t_with_perm ->
'c) ->
credentials:(([< `Read | `Set_and_create ], Logon.t, string)
Field.t_with_perm -> 'd) ->
'd
= <fun>
(* OCaml Utop ∗ records/main.topscript , continued (part 35) ∗ all code *)
这看起来有点唬人,主要是因为访问控制标记的缘故,但其实结构是相当简单的。每一个标签参数都是一个函数,接收一个相关类型的一等公民字段作为参数。注意iter
把Field.t
传给回调函数,而不是字段的内容。而字段内容可以通过组合记录和Field.t
获取。
现在,让我们使用Logon.Fields.iter
和show_field
来打印出Logon
记录的所有字段:
# let print_logon logon =
let print to_string field =
printf "%s\n" (show_field field to_string logon)
in
Logon.Fields.iter
~session_id:(print Fn.id)
~time:(print Time.to_string)
~user:(print Fn.id)
~credentials:(print Fn.id)
;;
val print_logon : Logon.t -> unit = <fun>
# print_logon logon;;
session_id: 26685
time: 2013-11-05 08:49:43.946365-05:00
user: yminsky
credentials: Xy2d9W
- : unit = ()
(* OCaml Utop ∗ records/main.topscript , continued (part 36) ∗ all code *)
这种方法的一个额外好处是可以帮助你的代码适应记录字段的变化。如果你向Logon.t
添加一个字段,Logon.Fields.iter
的类型也会随之变化,要求一个新的参数。任何使用了Logon.Fields
的代码都要针对新参数修改后才能通过编译。
字段迭代器对于大量记录相关的任务都很有用,这些任务从构建记录验证函数到从一个记录类型搭建一个 web 表单。此类应用都会从“保证记录字段都获得处理”这件事中获益。