项目地址:https://github.com/lanofblue/SimpleWebServer
本文实现的文件在源码中的SimpleWebServer/http_writer
目录下
本文内容
目标:生成请求报文
- 应答报文
- HTTP响应的几种状态码
- 生成请求报文
当Web服务器解析完一个HTTP请求之后,如果母庙文档存在且客户具有读取该文档的权限,那么它就需要发送一个HTTP应答来传输该文档。这个HTTP应答包含1个状态行、多个头部字段、1个空行和文档问哪。其中,前3部分的内容可能被Web服务器放置在一块内存中,而文档的内容则通常被读到另一块单独的内存中(通过read
函数或mmap
函数)。我们并不需要把这两部分内容拼接到一起再发送,而是可以使用writev
函数将它们同时写出
上一文中我们已经得到了文件的内容,下面我们将完成应答报文的生成
应答报文
响应报文也由4个部分组成,分别是:状态行、消息报头、空行和响应报文
HTTP/1.1 200 OK
Date: Fri, 22 May 2009 06:07:21 GMT
Content-Type: text/html; charset=UTF-8
空行
<html>
<head></head>
<body>
<!--body goes here-->
</body>
</html>
- 状态行,由HTTP协议版本号, 状态码, 状态消息 三部分组成。
第一行为状态行,(HTTP/1.1)表明HTTP版本为1.1版本,状态码为200,状态消息为OK。- 消息报头,用来说明客户端要使用的一些附加信息。
第二行和第三行为消息报头,Date:生成响应的日期和时间;Content-Type:指定了MIME类型的HTML(text/html),编码类型是UTF-8。- 空行,消息报头后面的空行是必须的。
- 响应正文,服务器返回给客户端的文本信息。空行后面的html部分为响应正文。
HTTP响应的几种状态码
状态码 | 描述 |
---|---|
200 | OK:请求成功 |
400 | BAD REQUEST:客户端请求报文错误 |
403 | FORBIDDEN:客户没有权限读取文件 |
404 | NOT FOUND:客户请求的文件不存在 |
500 | INTERNAL ERROR:服务器内部错误 |
我们定义几种状态码要返回给客户端的内容:
const char* ok_200_title = "OK";
const char* error_400_title = "Bad Request";
const char* error_400_form = "Your request has bad syntax or is inherently impossible to satisfy.\n";
const char* error_403_title = "Forbidden";
const char* error_403_form = "You do not have permission to get file from this server.\n";
const char* error_404_title = "Not Found";
const char* error_404_form = "The requested file was not found on this server.\n";
const char* error_500_title = "Internal Error";
const char* error_500_form = "There was an unusual problem serving the requested file.\n";
当客户请求成功时,将状态码200写入HTTP请求报文。并将文件传输给客户端
当客户请求失败时,将状态码写入HTTP请求报文,并将对应的error_xxx_form
内容发送给客户端
生成请求报文
写入状态行、消息报头、空行
用4个函数分别向写缓冲区写入状态行、消息报头、空行、响应报文
bool add_status_line(int status, const char* title);
bool add_content(const char* content);
bool add_headers(int content_length);
bool add_blank_line();
VA_LIST
VA_LIST
是在C语言中解决变参问题的一组宏,变参问题是指参数的个数不定,可以是传入一个参数也可以是多个;可变参数中的每个参数的类型可以不同,也可以相同;可变参数的每个参数并没有实际的名称与之相对应,用起来是很灵活。
va_list
的用法:- 首先在函数里定义一具VA_LIST型的变量,这个变量是指向参数的指针;
- 然后用VA_START宏初始化变量刚定义的VA_LIST变量;
- 然后用VA_ARG返回可变的参数,VA_ARG的第二个参数是你要返回的参数的类型最后用VA_END宏结束可变参数的获取。
我们使用va_list来封装add_response函数,上述4个函数调用add_response
来添加内容
bool http_writer::add_response(const char *format, ...) {
if (m_write_idx >= WRITE_BUFFER_SIZE) {
return false;
}
va_list arg_list;
va_start(arg_list, format);
int len = vsnprintf(m_write_buf + m_write_idx, WRITE_BUFFER_SIZE - 1 - m_write_idx, format, arg_list);
if (len >= (WRITE_BUFFER_SIZE - 1 - m_write_idx)) {
return false;
}
m_write_idx += len;
va_end(arg_list);
return true;
}
add_status_line
调用add_response
函数写入状态行
bool http_writer::add_status_line(int status, const char *title) {
return add_response("%s %d %s\r\n", "HTTP/1.1", status, title);
}
组合各个模块。注意如果状态码是200,我们需要在请求消息体写入文件数据,也就是将文件数据暂时保存到写缓冲区
bool http_writer::write_package(HTTP_CODE ret) {
switch (ret) {
case INTERNAL_ERROR: {
add_status_line(500, error_500_title);
add_headers(strlen(error_500_form));
if (!add_content(error_500_form)) {
return false;
}
break;
}
case BAD_REQUEST: {
...
}
...
}
}
写入文件数据
在上一文中,文件在内存中的起始位置保存在m_file_address
中,文件大小保存在m_file_stat.st_size
可使用struct loved
来将文件写入请求报文
struct iovec
struct iovec
定义了一个向量元素。通常,这个结构用作一个多元素的数组。对于每一个传输的元素,指针成员iov_base
指向一个缓冲区,这个缓冲区是存放的是readv
所接收的数据或是writev
将要发送的数据。成员iov_len
在各种情况下分别确定了接收的最大长度以及实际写入的长度
m_iv[0].iov_base = m_write_buf;
m_iv[0].iov_len = m_write_idx;
m_iv[1].iov_base = m_file_address;
m_iv[1].iov_len = m_file_stat.st_size;
m_iv_count = 2;