Elixir的Phoenix框架：请求处理之道

本文基于Phoenix1.3，但请求的处理流程跟1.2基本一致，只是模块的命名和目录结构有所差异。

简单介绍，phoenix是一个网站框架，本质就是http请求处理。这篇文章主要就是讲一个请求，在结果回到用户之前，走过了哪些路。通过这种方式，介绍phoenix框架中各个组成部分（包括endpoint、routing、controller、view、template、channel）。仅作phoenix框架入门之用，未涉及底层cowboy框架。

上图（我很丑也并不温柔，手残作者 ==! ）：

以上是基本上所有的请求走的路，绿色部分表示正儿八经的请求，其他的杂色则表示连接、加入频道等前期准备工作。

请求主要分三类：静态资源、动态资源或http请求、websocket请求。其中前两类均为一次性连接，每次请求均启动一个新进程进行处理，回复完成后会话结束。而websocket方式则是长期存在的连接，可进行双向通信。

一、请求静态资源

静态资源即不用经过任何处理，可以直接返回给用户的资源。如图，静态资源进入endpoint即返回。在endpoint.ex中有下面这段，这一段就定义了可以直接返回给用户的静态资源，资源放在priv/static/目录下。这类资源直接以文件形式返回给用户，不经过后续处理流程。

plug Plug.Static,
  at: "/", from: :my_app, gzip: false,
  only: ~w(css fonts images js index.html)

二、动态资源或http请求

这部分指的是非web_socket的请求，通常是需要进行一定的处理和渲染才能返回给客户端的资源或数据。在图中的下半部分有所展示，主要涵盖router、controller、view、template部分。

1.消息首先经过endpoint进行一些初始化处理，如解码等，endpoint就是一个流水线，流水线的最后一步走入router中进行路由。

2.在router中也可以定义不同的流水线，根据请求路径和请求方式，对请求方进行权限验证或其他自定义的数据初始化。所有验证通过后，会根据定义的路由，分发进入不同的controller中进行最终处理。

3.controller是实际处理请求的地方，服务端请求处理逻辑所在处。在controller中处理完成后，可以调用不同的接口，直接回复给用户（如： text(conn, "ok") ），或者调用渲染方法（如：render(conn, "homePage.html", param: param) ），并传入返回参数。

4.渲染主要在与controller的前缀相同的view中进行，如果是文件模板，则会从 templates/xyz 目录下找对应的模板，然后用传入参数进行渲染。渲染完后发送给用户。

三、websocket请求

这部分是图中的上半部分，主要涵盖socket、channel部分。Phoenix框架的websocket中有一个channel的概念，可围绕channel做消息转发、广播等，甚至也可以做api请求。

1. 连接socket

加入socket的url，在endpoint.ex中有定义，如下：

socket "/socket", AppWeb.XyzSocket

即，通过websocket连接 www.example.com/socket 可对应到AppWeb.XyzSocket模块进行连接处理。处理连接的是新生的一个进程，该进程调用AppWeb.XyzSocket模块的 connect/2 函数进行初始化，该函数返回:error则表示连接失败，{:ok, socket}则表示连接成功。失败的话进程退出，成功则进程保留，用以用户消息的收发。此过程为图中红色线所示。

2.加入channel

在连接socket的时候，AppWeb.XyzSocket模块中会定义可连接的channel及对应处理模块，如下：

channel "abc:*", AppWeb.AbcChannel

当用户加入"abc:"开头的channel时，会启动一个channel进程，调用 AppWeb.AbcChannel.join/2 函数进行处理，该函数中可做一些权限验证和频道的初始化。如果该函数返回{:ok, socket}则表示加入成功，进程保留为该用户在此频道中的数据交流之用。返回{:error, reason}则加入失败，进程退出。此过程为图中蓝色线所示。

3.channel消息

用户加入channel后，可往channel发送消息（如图中上半部分绿线流程），channel也可以主动往客户端推送消息（如图中橙色线所示）。如图所示，其消息收发都是要经过socket进程，不过socket进程的转发属于隐形的过程，写代码时涉及不多。

用户向channel发送消息时，会在对应的channel进程调用 AppWeb.AbcChannel.handle_in/2 函数进行消息处理。处理完后函数返回 {:reply, reply, socket} 即可把reply返回给用户（底层经由socket进程）。

channel通过调用 push 或 broadcast 接口（详见官方文档）可以主动向用户发送消息。

结束语

所谓的XX之道多半是讲“道”，而我的“道”是道路的“道”。哈哈哈，总感觉一不小心起了个大名字。