gen_server补充基础学习

news2024/11/18 5:40:40

学习gen_server的回调结构

gen_server:start_link(Name, Mod, InitArgs, Opts)这个调用是所有事物的起点。它
会创建一个名为Name的通用服务器，回调模块是Mod，Opts则控制通用服务器的行为。在这里可以指定消息记录、函数调试和其他行为。通用服务器通过调用Mod:init(InitArgs)启动。

init([]).

start_link() ->
  gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).

上面的语句会调用gen_server回调模块中下面的方法，如果在状态栏需要一些字段可以在这里进行初始化

init([]) ->
  {ok, #state{}}.

handle_call/3.

要调用服务器，客户端程序需要执行gen_server:call(Name, Request)。它最终调用的
是回调模块里的handle_call/3。

handle_call(_Request, _From, State) ->
  {reply, ok, State}.

handle_call 用于处理那些期望得到响应的消息。发送方会阻塞直到接收到一个回复,如果需要回调函数处理完相应逻辑之后得到返回值，应该调用该函数。

handle_cast/2.

gen_server:cast(Name, Msg)则实现了一个播发（cast），也就是没有返回值的调用（实际上就是一个消息，但习惯上称它为播发来与远程过程调用相区分）

handle_cast(_Msg, State) ->
  {noreply, State}.

handle_cast 用于处理那些不需要响应的消息，即发送方发送消息后不会等待接收方的回复。因此相当于发起了一个异步事件，在handle_cast中如果出现问题不会影响主线程的，因此该方法可以处理一些需要逻辑处理但是不需要得到返回值的需求。例如对数据库或ets表进行操作。

handle_info/2

handle_info用于处理系统信息消息。这些消息通常是由系统自动发送的，例如定时器触发的消息或其他系统事件。

handle_info(_Info, State) ->
  {noreply, State}.

handle_info(timeout, State) ->
  {noreply, State};

handle_info时常用于处理定时器触发的消息，例如需要定时统计人数，或定时需要进行什么操作时，就会使用gen_server给自己发送定时器任务进行相应的逻辑处理

完整代码示例

下面时完整实例，实现了gen_server1与gen_server2之间的通信

-module(gen_server1).
-behaviour(gen_server).

-export([start_link/0]).
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
  terminate/2, code_change/3, stop/0, check/0]).

start_link() ->
  gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
init(_Args) ->
  reset_timer(),
  {ok, []}.
handle_call(crash, _From, State) ->
  %% 当接收到 crash 消息时，使 gen_server1 崩溃
  io:format("gen_server1 crash~n"),
  exit(normal),
  {reply, ok, State};
handle_call(_Request, _From, State) ->
  {reply, ok, State}.

handle_cast(_Msg, State) ->
  {noreply, State}.

handle_info(msg, State) ->
  io:format("gen_server1 send msg~n"),
  %%调用gen_server2的cast方法用来重置gen_server2中的计时器
  gen_server:cast(whereis(gen_server2), msg),
  reset_timer(),
  {noreply, State};
handle_info(_Info, State) ->
  {noreply, State}.
reset_timer() ->
  %%每五秒钟向自己发送一条msg消息
  erlang:start_timer(5000,self(),msg).
terminate(_Reason, _ServerState) ->
  ok.

code_change(_OldVsn, State, _Extra) ->
  {ok, State}.

stop() -> gen_server:call(?MODULE, crash).

check() ->
  case whereis(gen_server2) of
    undefined -> io:format("gen_server2 has crashed~n");
    Pid -> io:format("gen_server2 is running pid is: ~p~n", [Pid])
  end.

-module(gen_server2).

-export([start_link/0]).
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
  terminate/2, code_change/3]).

start_link() ->
  gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).

init(_Args) ->
  reset_timer(),
  {ok, []}.

handle_call(_Request, _From, State) ->
  {reply, ok, State}.

handle_cast(msg, State) ->
  %% 当接收到消息时，重置计时器
  io:format("gen_server2 get msg"),
  reset_timer(),
  {noreply, State};
handle_cast(_Msg, State) ->
  {noreply, State}.

handle_info(timeout, State) ->
  %% 当超时未收到消息时，使 gen_server2 崩溃
  io:format("gen_server2 timeout~n"),
  {noreply, State};
handle_info(_Info, State) ->
  {noreply, State}.
reset_timer() ->
  %%每15秒钟如果没有重置该定时器，则发送超时消息给自己
  erlang:start_timer(15000,self(),timeout).
terminate(_Reason, _ServerState) ->
  ok.

code_change(_OldVsn, State, _Extra) ->
  {ok, State}.