用C++实现HTTP服务器 - Windows平台

转自
http://blog.csdn.net/querw/article/details/6593328


用C++实现HTTP服务器 - Windows平台
软件名: Que's HTTP Server
源码：https://github.com/TedQue/QPPHTTPServer
作者: 阙荣文 - Que's C++ Studio  
版权说明: 免费,开放源代码,禁止用作商业用途.
日期: 2011.7.8

1. 目的和用途

    用C++实现一个Windows下的,简单的HTTP服务器模型,用作局域网内的文件共享工具.
我以前在公司里,同事之间经常要共享一些大文件(超过2G),如果直接共享Windows目录,非常不安全不说,经常还因为各种各样的问题导致无法访问:比如guest用户被禁用,防火墙拦截等.现在,我只要开启这个程序(一个非常简单的程序,只有一个几百K大小的EXE文件),对方就可以用浏览器(IE,Firefox等都可以,还有比浏览器安装范围更广的客户端吗?)访问到我共享的文件,还支持断点续传,多么惬意.
    另外,这是一个符合协议要求的HTTP服务器,理论上说,放到公网上也是完全可以的,只是功能没有成熟的Apache, IIS等丰富,安全性能也不足,但是作为一个学习的模型,提供文件下载服务还是没问题的.

2. 原理说明
(1) 关于HTTP协议.
    我个人非常非常喜欢HTTP协议,这是一个简洁的,基于文本的,应答式的协议.
基于文本的一大好处是调试特别方便,因为所有的数据都是可以直接读出的文本,程序结果正确与否一目了然,另外还有很多其它好处,可以参考<<UNIX编程艺术>>,里面有一章专门讲基于文本的协议的好处,深以为然.
    HTTP协议的交流过程可以简单的描述为:双方建立TCP连接,客户端(通常是浏览器)发送一段固定格式的文本(所谓的请求),服务器根据客户端请求的内容,生成并回应一段固定格式的文本(所谓的回应头)和文件内容(如果客户端请求的是文件下载的话),数据发送完毕后,断开连接.
    这就是我们今天网络世界的基础,没错,就这么简单.
    当然,客户端的请求和服务器的回应头都有格式要求,可以读一读W3C关于HTTP协议的文档.(Que's HTTP Server发行包内也包含了一份,请点击文章开头的链接下载.)

(2) Windows的网络模型.
    Windows系统中,当属完成端口模型的网络性能最好.作为可能面临巨大网络压力的HTTP服务器,完成端口模型是唯一的选择.
完成端口模型用一种类似于回调的方式处理网络操作,所有的网络操作都不会阻塞,而是排队后直接返回,等到操作完成,系统会触发一个完成端口事件以通知应用程序.所以应用程序只要用一个线程一直检查对应的完成端口就可以得到网络操作的结果.和回调不同的是,系统允许多个线程同时等待同一个完成端口事件,Windows系统确保对于一个完成端口时间,只有一个等待线程被唤醒.这样,对于有多个CPU的机器,我们可以创建多个线程(一个CPU对应一个线程)等待同一个完成端口事件以并行的方式处理网络事件以充分发挥机器的性能.
    关于完成端口编程方面的指导请参考<<Windows网络编程技术>>(微软出版,Anthony Jones著)第八章.


3. 程序结构介绍

CHTTPServer对象
    CHTTPServer对象代表了整个HTTP服务器在内存中的存在,负责创建完成端口模型,创建所需的线程,监控完成端口事件并且维持URL和服务器上的真实文件的对应关系.除了维护网络模块外,CHTTPServer对象还要根据接收到的客户端请求生成正确的服务器响应.它的角色和ASP.NET或者JSP编程中用到的预定义Server对象是类似的.

CHTTPRequest对象
    CHTTPRequest对象是对客户端请求的包装,由于客户端请求是一段带格式的文本,用编程语言说就是一个字符串,为了编程方便,我创建了CHTTPRequest对象管理这个字符串,CHTTPRequest对象提供了若干方法,可以很方便的访问到客户端请求的各个参数.它的角色和ASP.NET或者JSP编程中用到的预定义Request对象是类似的.

CHTTPResponse对象
    CHTTPResponse对象是对服务器响应的包装,CHTTPServer对象根据CHTTPRequest对象的内容,设置CHTTPResponse对象的参数,最后由CHTTPResponse对象把这些参数输出为符合HTTP协议要求的文本.它的角色和ASP.NET或者JSP编程中用到的预定义Response对象是类似的.

CHTTPContent对象
    CHTTPContent对象代表了客户端所请求的资源(URL).它可能是一个文件,也可能就是一段服务器即时生成的HTML/TEXT文本,比如某个目录的文件列表,或者是一个出错信息,如HTTP404文件未找到的提示.

程序运行的流程如下:
    CHTTPServer对象启动并监控网络模块,当一个新的客户端连接建立以后,CHTTPServer对象开始读取这个新连接,直到接收到一个完整的请求头为止.
当CHTTPServer对象收到一个完整的请求头后,它就以之为参数,建立一个新的CHTTPRequest对象,然后分析这个CHTTPRequest对象,生成正确的CHTTPResponse对象和CHTTPContent对象,然后把CHTTPResponse对象输出的文本和CHTTPContent对象的内容按顺序发送给客户端,并在数据发送完成后关闭连接,回收上述的各个对象.

4. 核心代码分析
    下面贴一段CHTTPServer对象根据CHTTPRequest对象的内容,生成CHTTPResponse对象和CHTTPContent对象的关键代码.

// 已经完整接收到了一个请求头,处理之
// 目的: 通过分析Request对象,准备好Response对象,并在可能的情况下生成一个Content对象并关联到Response对象中.
void CHTTPServer::OnRequest(PCLIENTINF pSockInf)
{
	ASSERT(pSockInf); 
	ASSERT(pSockInf->pRequest); 
	ASSERT(pSockInf->pResponse);
	std::wstring strUrlObject(L"");
	std::wstring strServerFilePath(L"");

	// 是否是有效的请求头
	if(!pSockInf->pRequest->Verify())
	{
		// 请求头格式不正确,返回HTTP 400和一段关于400的预定义说明文本
		pSockInf->pResponse->SetServerCode(SC_BADREQUEST);  // HTTP 400
		CHTTPContent *pContent = new CHTTPContent;
		pContent->OpenText(g_HTTP_Bad_Request, strlen(g_HTTP_Bad_Request));
		pSockInf->pResponse->AttachContent(pContent);
		goto exit;
	}
	
	// 请求的方法是否是 GET 或者 HEAD
	HTTP_METHOD method = pSockInf->pRequest->GetMethod();
	pSockInf->pResponse->SetMethod(method);
	if(method != METHOD_GET && method != METHOD_HEAD)
	{
		// 目前只支持两种HTTP方法
		pSockInf->pResponse->SetServerCode(SC_BADMETHOD); // HTTP 405
		CHTTPContent *pContent = new CHTTPContent;
		pContent->OpenText(g_HTTP_Bad_Method, strlen(g_HTTP_Bad_Method));
		pSockInf->pResponse->AttachContent(pContent);
		goto exit;
	}
	
	// 获取客户端请求的对象
	strUrlObject = pSockInf->pRequest->GetUrlObject();
	if(strUrlObject.size() <= 0)
	{
		// URL Object 为空,说明客户端的请求有问题.
		pSockInf->pResponse->SetServerCode(SC_BADREQUEST); // 请求头格式错误 HTTP 400
		CHTTPContent *pContent = new CHTTPContent;
		pContent->OpenText(g_HTTP_Bad_Request, strlen(g_HTTP_Bad_Request));
		pSockInf->pResponse->AttachContent(pContent);
		goto exit;
	}
	
	// 映射为服务器文件名.
	MapServerFile(strUrlObject, strServerFilePath);

	// 如果 URL 的最后一个字符是 '/' 说明请求文件列表,否则是请求一个具体的文件.
	if(strUrlObject.back() == L'/')
	{
		// 浏览目录创建目录列表的内容对象,并关联给Response对象
		CHTTPContent *pContent = new CHTTPContent;
		if(m_bNavDir)
		{
			if(pContent->OpenDir(strUrlObject, strServerFilePath))
			{
				pSockInf->pResponse->SetServerCode(SC_OK); // HTTP 200
			}
			else
			{
				// 无法列出目录的文件列表.
				pContent->OpenText(g_HTTP_Server_Error, strlen(g_HTTP_Server_Error));
				pSockInf->pResponse->SetServerCode(SC_SERVERERROR); // HTTP 500
			}
		}
		else
		{
			// 禁止浏览目录
			pContent->OpenText(g_HTTP_Forbidden, strlen(g_HTTP_Forbidden));
			pSockInf->pResponse->SetServerCode(SC_FORBIDDEN); // HTTP 403
		}
		pSockInf->pResponse->AttachContent(pContent);
	}
	else
	{
		// 客户端请求了服务器上的一个文件
		// 1.客户端是否请求了断点续传的内容
		// 2.创建文件内容对象并关联给Response对象
		__int64 lFrom = 0;
		__int64 lTo = -1;
		if(pSockInf->pRequest->GetRange(lFrom, lTo))
		{
			pSockInf->pResponse->SetServerCode(SC_PARTIAL); //HTTP 206
		}
		else
		{
			pSockInf->pResponse->SetServerCode(SC_OK); // HTTP 200
		}

		CHTTPContent *pContent = new CHTTPContent;
		if(pContent->OpenFile(WtoA(strServerFilePath.c_str()).c_str(), lFrom, lTo))
		{
			// 文件打开成功.
		}
		else
		{
			// 文件不存在或者其它什么原因,打开失败.
			pContent->OpenHtml(g_HTTP_Content_NotFound, strlen(g_HTTP_Content_NotFound));
			pSockInf->pResponse->SetServerCode(SC_NOTFOUND); // HTTP 404
		}
		pSockInf->pResponse->AttachContent(pContent);
	}

exit:
	/////////// 准备响应头
	pSockInf->pResponse->CookResponse();  // 把上面设置的参数输出为一段符合HTTP协议的文本.

    // 写日志.
	LOGGER_CINFO(theLogger, _T("连接[%s:%d]请求资源[%s],回应[HTTP %d].\r\n"), 
		AtoW(pSockInf->pRequest->GetIP().c_str()).c_str(), pSockInf->pRequest->GetPort(), 
		strUrlObject.c_str(),
		pSockInf->pResponse->GetServerCode());  
		
	return;
}

5. 使用说明
这是一个非常轻量级的程序,不需要安装,只有一个EXE文件,运行后可以设置作为HTTP服务器的根目录的位置和服务端口.如果选中了"允许浏览目录"的复选框,则允许客户端浏览器列出服务器上某个目录下的所有文件,比如客户浏览器输入 "http://xxxxx/汽车图片/" 那么将会看到服务器根目录下"汽车图片"子目录下的所有文件的列表.如果不选中,则显示"403 Forbidden"的提示.

程序运行的效果如下图所示:


用Firefox浏览目录的效果如下:



=====================================================================
更新日志
说明:V1.51之前的代码结构不好,很杂乱,界面也很简陋,只是在公司内部作为一个方便文件共享的小工具使用,没有发布.

V1.51 Beta
1. 启用新界面.
2. 重新编写内核,开始出现 CHTTPContent对象.
3. 启用新的日志系统.

V1.52 Beta
现在服务器支持超过2G的大文件的下载了, 内部使用64位长的整数(之前使用32位整数,只能支持到2G的文件)来记录文件长度.

V1.52 Beta Build 15279
浏览目录时,现在不再列出系统文件和隐藏文件,并且所有的子目录都在前面出现.

V1.52 Beta Build 152710
新增: 在状态栏显示当前使用的带宽(每2秒刷新一次).
新增: 在状态栏显示当前一共有多少个连接(实时).
修正: 在浏览目录时,现在超过2G的文件可以正确显示大小.
修改: 现在,超出的日志每次只移除前面100行(原来移除200行).
新增: 每个连接在关闭时,在日志里有体现服务器为处理该连接所用的时间.
新增: 现在允许设置服务器的最大连接数.
修改: 内核做了一小部分修改,使程序逻辑更清晰明了.

V1.52 Beta Build 152711
修正: 改正了一个内部同步错误,现在带宽计算结果更精确了.

V1.52 Beta Build 152712
修正: 当一个连接发送数据超过2G时,现在在日志中可以正确显示了.

V1.52 Beta Build 152713
修正: 修正了下行带宽统计的一个错误.

V1.52 Beta Build 152714
新增: 现在可以设置会话超时了.
新增: 如果一个连接在指定时间内没有发送或者接收任何数据,则会被判定为死连接而被移除.这个时间可以在设置界面设置.
修改: 浏览目录时,如果一个文件超过1G,则会显示为"XXX GB" 而不是原来的 "XXXX MB".
修改: 一些界面提示性文本作了小修改.

V1.52 Beta Build 152715
修改: 重新绘制工具条图标.
新增: 现在可以设置每个客户(以IP为准)最多可以有多少个连接.
新增: 现在可以设置每个连接的最大带宽. 注意:为保持连接的活跃性,每个连接的最小带宽不会小于 250B/s.
修改: 不再为侦听套接字单独创建一个线程,而是使用AcceptEx调用,以节省服务器系统资源并提高效率.
新增: 连接关闭时,会在日志中显示该连接所用的平均带宽.
修正: 当一个请求头被分为多次接收时,会导致连接被关闭.
新增: 支持文件日志,并可以在设置界面中禁用/启用.日志文件和EXE文件在同一个文件夹内,文件名为 HTTPServerLOG(年月日).TXT,每个日志文件最大5MB.
新增: 在禁止浏览目录的情况下,允许设置默认文件名(多个文件名以逗号分隔,最长260个字符).
修改: 现在内核使用3个定时器队列分别对应3中应用,以提高性能.
注: V1.5X版本将不再增加新功能,而继续测试以发现和修复BUG为主.

V1.52 Build 152716
修正: 停止服务器时,如果还有连接,不再提示定时器删除错误.

V1.52 Build 152717
修改: 连接结束时,日志中的平均速度显示为 "XXX MB/s"等
v1.52 Build 152718
修改: 调整了一些日志文本的格式,使之更有条理.
开放源代码.