行为模式
gen_server代表的就是“行为模式”的一种,行为模式的目的在于为特定类型的进程提供一套模板。
启动服务器
用来启动服务器的有start/3
,start/4
,start_link/3
,start_link/4
这四个函数。 使用这些start函数之后,就会产生一个新的进程,也就是一个gen_server服务器。这些 start函数的正常情况下返回值是{ok,Pid}
,Pid
就是这个新进程的进程号。 带link与不带的区别在于是否跟父进程建立链接,换种说法是,新启动的进程死掉后,会不会通知启动他的进程(父进程)。
start函数可以四个参数(ServerName, Module, Args, Options)
:
- 第一个参数
ServerName
是服务名, 是可以省掉的。具有相同服务名的模块在一个节点中只能启动一次,重复启动会报错,为{error, {already_started, Pid}}
。具有服务名的服务进程可以使用服务名来调用, 没有服务名的只能通过进程号pid来调用了。通常有名字的服务进程会使用模块名做为 服务名,即上面模板中定义的宏-define(SERVER, ?MODULE)
,然后在需要使用服务名的 地方填入?SERVER
. - 第二个参数
Module
是模块名,一般而言API和回调函数是写在同一个文件里的,所以就用?MODULE
,表示本模块的模块名。 - 第三个参数
Args
是回调函数init/1
的参数,会原封不动地传给init/1
。 - 第四个参数
Options
是一些选项,可以设置debug、超时等东西。
start对应的回调函数是init/1
,一般来说是进行服务器启动后的一些初始化的工作, 并生成初始的状态State,正常返回是{ok, State}。这个State是贯穿整个服务器, 并把所有六个回调函数联系起来的纽带。它的值最初由init/1
生成, 此后可以由三个handle函数修改,每次修改后又要放回返回值中, 供下一个被调用的handle函数使用。 如果init/1
返回ignore
或{stop, Reason}
,则会中止服务器的启动。
有一点细节要注意的是,API函数和回调函数虽然习惯上是写在同一个文件中,但执行函数 的进程却通常是不一样的。在上面的模板中,start_link/0
中使用self()
的话,显示的是调用者的进程号,而在init/1
中使用self()
的话,显示的是服务器的进程号。
使用服务器
三个handle开头的回调函数对应着三种不同的使用服务器的方式。如下:
gen_server:call ------------- handle_call/3 gen_server:cast ------------- handle_cast/2 用!向服务进程发消息 ------------- handle_info/2
call是有返回值的调用;cast是无返回值的调用,即通知;而直接向服务器进程发的 消息则由handle_info处理。
call是有返回值的调用,也是所谓的同步调用,进程会在调用后一直等待直到回调函数返回为止。 它的函数形式是 gen_server:call(ServerRef, Request, Timeout) -> Reply
,
- 第一个参数
ServerRef
是被调用的服务器,可以是服务器名,或是服务器的pid。 - 第二个参数
Request
会直接传给回调函数handle_call。
- 最后一个参数
Timeout
是超时,是可以省略的,默认值是5秒。
call是用来指挥回调函数handle_call/3
干活的。具体形式为 handle_call(Request, From, State)
。
- 第一个参数
Request
是由call传进来的,是写程序时关注和处理的重点。 - 第二个参数
From
是gen_server传进来的,是调用的来源,也就是哪个进程执行了call。From
的形式是{Pid, Ref}
,Pid
是来源进程号,而Ref
是调用的标识,每一次调用 都不一样,用以区别。有了Pid,在需要向来源进程发送消息时就可以使用,但由于call 是有返回值的,一般使用返回值传递数据就好。 - 第三个参数
State
是服务器的状态,这是由init或是其他的handle函数生成的,可以根据需要进 行修改之后,再放回返回值中。
call
call对应的回调函数handle_call/3
在正常情况下的返回值是{reply, Reply, NewState}
, Reply
会作为call的返回值传递回去,NewState
则会作为服务器的状态。 另外还可以使用{stop, Reason, State}
中止服务器运行,这比较少用。
使用call要小心的是,两个服务器进程不能互相call,不然会死锁。
cast
cast是没有返回值的调用,一般把它叫做通知。它是一个“异步”的调用,调用后会直接收到 ok
,无需等待回调函数执行完毕。
它的形式是gen_server:cast(ServerRef, Request)
。参数含义 与call相同。由于不需要等待返回,所以没必要设置超时,没有第三个参数。
在多节点的情况下,可以用abcast
,向各节点上的具有指定名字的服务进程发通知。 (奇怪的是为啥为不叫multi_cast
,明明长得跟multi_call
很像的)
cast们对应的回调函数是handle_cast/2
,具体为:handle_cast(Msg, State)
。 第一个参数是由cast传进去的,第二个是服务器状态,和call类似,不多说。
handel_cast/2
的返回值通常是{noreply, NewState}
,这可以用来改变服务器状态, 或是{stop, Reason, NewState}
,这会停止服务器。通常来说,停止服务器的命令用 cast来实现比较多。
原生消息
原生消息是指不通过call或cast,直接发往服务器进程的消息,有些书上译成“带外消息”。 比方说网络套接字socket发来的消息、别的进程用!发过来的消息、跟服务器建立链接的进程死掉了, 发来{‘EXIT‘, Pid, Why}
等等。一般写程序要尽量用API,不要直接用!向服务器进程发消息, 但对于socket一类的依赖于消息的应用,就不得不处理原生消息了。
原生消息使用handle_info/2
处理,具体为handle_info(Info, State)
。其中Info是 发过来的消息的内容。回复和handle_cast
是一样的。
停止服务器
上面介绍的handle函数返回{stop,...},就会使用回调函数terminate/2
进行扫尾工作。 典型的如关闭已打开的资源、文件、网络连接,打log做记录,通知别的进程“我要死啦”, 或是“信春哥,满血复活”:利用传进来的状态State重新启动服务器。
最简单的就是啥都不干,返回ok就好了。