GenServer

OTP server 是一个模块，包含了 GenServer 的主要行为，外加一系列的 callbacks。GenServer 最核心的内容是这样一个循环：每次迭代处理一个带有目标状态的请求。

为了演示 GenServer 的 API，我们将实现一个简单的 queue，来存储和获取值。

最开始，我们要先启动和初始化 GenServer，一般情况下，我们需要链接进程，所以还要使用 GenServer.start_link/3。传递给 GenServer 的参数包括：我们所在的模块，初始状态，以及其他 GenServer 参数。GenServer.init/1 的参数用来设置初始的状态，比如在下面的例子中，初始状态为 []:

defmodule SimpleQueue do
  use GenServer

  @doc """
  Start our queue and link it.  This is a helper function
  """
  def start_link(state \\ []) do
    GenServer.start_link(__MODULE__, state, name: __MODULE__)
  end

  @doc """
  GenServer.init/1 callback
  """
  def init(state), do: {:ok, state}
end

同步函数

有时候需要和 GenServers 进行同步的交互：调用一个函数，然后等待它的响应返回。要处理同步请求，我们需要实现 GenServer.handle_call/3 函数，接受的参数是：请求、调用者的 PID，初始的状态，期望的返回值是 {:reply, response, state} 三元组。

使用模式匹配，我们可以为不同的请求和状态定义不同的 callbacks，能够接受的所有返回值列表可以前往 GenServer.handle_call/3 文档处查看。

为了演示同步请求，我们添加这样的功能：返回现在队列的状态以及删除队列中的一个值：

defmodule SimpleQueue do
  use GenServer

  ### GenServer API

  @doc """
  GenServer.init/1 callback
  """
  def init(state), do: {:ok, state}

  @doc """
  GenServer.handle_call/3 callback
  """
  def handle_call(:dequeue, _from, [value | state]) do
    {:reply, value, state}
  end

  def handle_call(:dequeue, _from, []), do: {:reply, nil, []}

  def handle_call(:queue, _from, state), do: {:reply, state, state}

  ### Client API / Helper functions

  def start_link(state \\ []) do
    GenServer.start_link(__MODULE__, state, name: __MODULE__)
  end

  def queue, do: GenServer.call(__MODULE__, :queue)
  def dequeue, do: GenServer.call(__MODULE__, :dequeue)
end

我们来测试一下 SimpleQueue 刚完成的 dequeue 功能：

iex> SimpleQueue.start_link([1, 2, 3])
{:ok, #PID<0.90.0>}
iex> SimpleQueue.dequeue
1
iex> SimpleQueue.dequeue
2
iex> SimpleQueue.queue
[3]

异步函数

handle_cast/2 是处理异步函数的， 这个函数和 handle_call/3 的用法一样，除了它不接受调用者作为参数而且没有返回值。

我们把 enqueue 功能设计成异步的：更新 queue 的内容，但并不阻塞当前程序的运行：

defmodule SimpleQueue do
  use GenServer

  ### GenServer API

  @doc """
  GenServer.init/1 callback
  """
  def init(state), do: {:ok, state}

  @doc """
  GenServer.handle_call/3 callback
  """
  def handle_call(:dequeue, _from, [value | state]) do
    {:reply, value, state}
  end

  def handle_call(:dequeue, _from, []), do: {:reply, nil, []}

  def handle_call(:queue, _from, state), do: {:reply, state, state}

  @doc """
  GenServer.handle_cast/2 callback
  """
  def handle_cast({:enqueue, value}, state) do
    {:noreply, state ++ [value]}
  end

  ### Client API / Helper functions

  def start_link(state \\ []) do
    GenServer.start_link(__MODULE__, state, name: __MODULE__)
  end

  def queue, do: GenServer.call(__MODULE__, :queue)
  def enqueue(value), do: GenServer.cast(__MODULE__, {:enqueue, value})
  def dequeue, do: GenServer.call(__MODULE__, :dequeue)
end

现在使用一下这个新功能：

iex> SimpleQueue.start_link([1, 2, 3])
{:ok, #PID<0.100.0>}
iex> SimpleQueue.queue
[1, 2, 3]
iex> SimpleQueue.enqueue(20)
:ok
iex> SimpleQueue.queue
[1, 2, 3, 20]

可以前往官方的 GenServer 文档了解更多的信息。

Caught a mistake or want to contribute to the lesson? Edit this lesson on GitHub!