Mochiweb的设计分析

 

Mochiweb的设计分析

March 15th, 2009 :: refactor

Goto comments Leave a comment

转自：http://erlang-china.org/misc/mochiweb-inside.html

Web服务器的基本工作大致分3步： 

1. 接收HTTP请求； 
2. 处理HTTP请求，生成响应内容；
3. 发送响应

一、处理请求和发送响应 

模块mochiweb_request可说是Mochiweb处理HTTP请求的核心部分，它总共负责了第2步和第3步工作。因此参数化模块mochiweb_request的实例不像它的模块名那样单纯：它还负责将请求的响应（通过Socket连接，调用gen_tcp:send）发还（response）给浏览器。这个模块是一个参数化模块。这意味着它具有基于对象（Object-based）的特点，它的每个实例化对象代表一个用户请求，用户可以像OO那样操作HTTP请求：获取请求信息，生成响应内容等。 

对静态内容（如html文件，静态图片）来说，无非是读取文件系统中静态文件的内容作为响应消息体（Body）发送给客户端浏览器。 

对动态内容来说，生成响应内容的业务逻辑是用户通过编程实现的：解析请求（包括URL路径和HTTP请求头），然后生成相应的响应内容。用户编写业务逻辑处理函数，然后将函数插入到mochiweb中。此函数带有一参数，该参数是参数化模块mochiweb_request的实例（假设为Req），在这个定制函数中可以通过这个Req实例对象获取浏览器请求的所有信息（包括URL路径和HTTP请求头），处理后的响应数据也通过Req实例提供的函数发还给浏览器，有好几种方式： 

1. 通过Req实例对象直接发还给浏览器：

    

   a) 通过这个Req实例对象的response/1函数直接发还给浏览器：
   Req:response({Code, ResponseHeaders, Body})
   这个函数接收一个tuple参数，参数的第一个元素是HTTP状态码（比如200），第二个元素是响应消息头列表(一个二元tuple，key和value都是字符串，如{“Content-Type”, “image/jpeg”}），第三个元素即为HTTP响应内容；如果是动态内容，采用response函数直接发还响应数据还是比较方便的。

   b) 如果是静态文件，通过Req的serve_file(…)函数可以直接将文件发还给浏览器，告诉此函数文件的Web根目录（doc_root）和相对路径就可以将指定的静态文件发给浏览器了。doc_root目录一般在配置文件中设置，这个目录下的所有文件都可以通过HTTP访问。

   c) 一些常见的例行响应：
   不存在的URL请求返回404错误，可以直接调用Req:not_found() 若一切正常，调用Req:ok({…, Body})直接返回状态码为200的HTTP响应
   b,c两种情况的内部其实还是调用的Req:response()

2. 通过Response模块对象将响应发还给浏览器：

    

   Req:response函数会返回一个mochiweb_response参数化模块实例对象（假设为Response)，Response实例对象包含有对应的Req实例对象。通过Response对象可以得到响应的相关信息（如响应状态码，响应消息头，对应的Req对象），它还有一个send函数可以将响应数据发还给浏览器（它的实现其实还是调用Req对象的send函数进行的）。Response之所以还要有send函数是为了发送chunked数据（HTTP 1.1)的方便，在第一次响应完成后，后继的chunk数据就可以通过最初返回的Response对象继续进行发送了，为此Response有个函数write_chunk()专门干这事，write_chunk检查了请求消息头中的HTTP 版本消息后就调用Response:send。

   因此，响应内容最终都是由参数化模块mochiweb_request的response/1函数发送的。而这个response(…)函数内部最后调用了Req:send(Data)函数将响应通过socket连接（调用gen_tcp:send）返还给浏览器，这一发送过程又分成两个阶段：响应消息头（Headers）的发送和消息体（Body）的发送，这两步都是通过Req:send完成的。

小结：对于程序员来说，他编写的服务器端处理HTTP请求的函数必须带有一个参数，这个参数代表了mochiweb_request参数化模块的一个实例对象。通过这个实例程序员可以得到HTTP请求的所有信息（包括路径、请求参数以及HTTP请求消息头），然后生成响应，他还可以通过该mochiweb_request实例对象将响应数据发还给浏览器。 

• 如果响应的是静态文件，可以通过Request:server_file()函数发送响应；
• 如果响应是动态生成的内容，通过Request:response()函数发送响应数据（文本数据和二进制数据都可以）；
• 如果是chunk响应，第一次调用Request:response()函数发送数据后，该函数会返回一个Response实例对象（参数化模块mochiweb_response的一个实例），以后的响应数据可以通过这个Response实例对象（调用Response:write_chunk(Data)）发送后续的响应数据。

二、Web服务器的业务处理逻辑如何嵌入到Mochiweb 

业务处理逻辑被程序员编写成一个函数（函数式编程中函数也是一种数据，以下称为HttpLoop），处理函数HttpLoop是作为mochiweb启动时的参数之一进入Mochiweb，Mochiweb是这样启动的： 

mochiweb_http : start ([ { loop ,  HttpLoop },... ])   

Request实例对象最终要调用gen_tcp:send(Socket,…)将响应数据由socket连接发给浏览器，因此，Request实例对象应该持有HTTP请求的socket连接。这个目标是这样实现的： 
在启动过程中，mochiweb_http又对用户的HttpLoop函数进行了重新包装 

Loop  =  fun   ( Socket )  ->
     mochiweb_http : loop ( Socket ,  HttpLoop )
end ,

每个浏览器连接请求对应着一个Socket连接，新的Loop函数以此Socket作为参数，然后通过mochiweb_http:loop函数对Socket连接和用户自定义的HttpLoop函数进行了处理，简单的说，这个函数做了如下工作： 

1. 将Socket连接设置成能处理HTTP数据包 （inet:setopts(Socket, [{packet, http}])）；
2. 准备接收socket连接传来的数据（gen_tcp:recv(Socket,…)）；

当收到数据时：

1. 将HTTP消息头数据提出（成为{HeaderName, HeaderValue}的tuple列表)
2. 生成一个参数化模块mochiweb_request的实例对象，并将Socket连接、HTTP请求信息（路径、请求方法、HTTP版本）以及请求消息头列表包装到此实例对象中，
3. 然后调用用户的HttpLoop对请求进行处理和响应（如前所述，处理得到的响应数据也在用户编写的HttpLoop函数中被发送给浏览器）
4. 最后根据HTTP请求信息决定是简单的关闭Socket连接，还是清理一下Req对象并保持连接（例如对keep-alive,chunk等类型的HTTP请求，以及还没完成数据传送的HTTP请求），以便继续让HttpLoop函数进行处理，

这都是在headers函数中进行的，还是看mochiweb_http模块的代码： 

1. headers(Socket, Request, Headers, HttpLoop, HeaderCount) -> 
2.     case gen_tcp:recv(Socket, 0, ?IDLE_TIMEOUT) of 
3.         {ok, http_eoh} -> 
4.             inet:setopts(Socket, [{packet, raw}]), 
5.             % 将Socket连接、HTTP请求信息（路径、请求方法、HTTP版本）以及请求消息头列表打包成参数化模块（mochiweb_request）的实例对象 
6.             Req = mochiweb:new_request({Socket, Request, 
7.                                         lists:reverse(Headers)}),   
8.             HttpLoop(Req), % 让用户编写的函数处理HTTP请求 
9.            case Req:should_close() of 
10.                 true ->  
11.                     gen_tcp:close(Socket), 
12.                     exit(normal); 
13.                 false ->  
14.                     Req:cleanup(), 
15.                     mochiweb_http:loop(Socket, HttpLoop) 
16.             end; 
17.         {ok, {http_header, _, Name, _, Value}} -> 
18.             headers(Socket, Request, [{