摘要
这 篇文章讨论了如何使用C#开发一个简单的web服务器应用程序。尽管我们可以使用任何一种支持.NET的编程语言开发,但我选择了C#。本篇文章中的代码 是使用微软的β2版的Visual C# Compiler Version 7.00.9254 [CLR version v1.0.2914]编译通过的,对代码作一些小的改动后,使用β1版也可能编译通过。该web服务器应用程序能够与IIS或其他任何web服务器软件同 时在一台服务器上运行,只要为它指定一个空闲的端口即可。在本篇文章中,我还假定读者对.NET、C#或Visual Basic .Net有一定的了解。
该web服务器应用程序能够向浏览器返回HTML格式的文件,而且支持图像,它不加载嵌入式图像或支持任何一种脚本语言。为了简单起见,我将它开发成一个命令行应用程序。
准备工作
首先,我们需要为这个web服务器应用程序定义一个根文件夹,例如,C:\MyPersonalwebServer,然后在该要根目录下创建一个数据目录,例如,C:\MyPersonalwebServer\Data;最后在数据目录下创建三个文件,例如:
Mimes.Dat
Vdirs.Dat
Default.Dat
Mime.Dat中将包含该web服务器支持的MIME类型,其格式为<扩展名>; ,例如:
.html;text/html
.htm;text/html
.bmp;image/bmp
VDirs.Dat中包含有虚拟目录的信息,格式为; <物理目录>,例如:
/; C:\myWebServerRoot/
test/; C:\myWebServerRoot\Imtiaz\
Default.Dat中包含有虚拟目录中文件的信息,例如:
default.html
default.htm
Index.html
Index.htm
为简单起见,我们将使用文本文件存储所有的信息,但我们也可以使用XML等其他的格式。在开始研究代码之前,我们先来看一下在登录网站时浏览器需要传递的头部信息。
我们以请求test.html为例进行说明。在浏览器的地址栏输入http://localhost:5050/test.html(记住,需要在URL中包括端口号),服务器将得到下面的信息:
〈/DRIVE:\PHYSICALDIR〉
GET /test.html HTTP/1.1
Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, */*
Accept-Language: en-usAccept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 4.0; .NET CLR 1.0.2914)
Host: localhost:5050Connection: Keep-Alive
开始编程
namespace Imtiaz
{
using System;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading ;
class MyWebServer
{
private TcpListener myListener ;
private int port = 5050 ; // 可以任意选择空闲的端口
//生成TcpListener的构建器开始监听给定的端口,它还启动调用StartListen()方法的一个线程
public MyWebServer()
{
try
{
//开始监听给定的端口
myListener = new TcpListener(port) ;
myListener.Start();
Console.WriteLine("Web Server Running... Press ^C to Stop...");
//启动调用StartListen方法的线程
Thread th = new Thread(new ThreadStart(StartListen));
th.Start() ;
}
catch(Exception e)
{
Console.WriteLine("An Exception Occurred while Listening :" +e.ToString());
}
}
我们定义了名字空间,包括应用程序必需的引用,初始化了构建器中的端口,启动了端口监听进程,创建了一个新的线程调用startlisten函数。
我们假设用户没有在URL中提供文件名,在这种情况下我们必须自己确定缺省的文件名,并将它返回给浏览器,就象在IIS中的文档标签中定义缺省的文档那样。
我们已经在default.dat中存储了缺省的文件名,并将文件存储在了数据目录中。GetTheDefaultFileName函数将目录路径作为输入参数,打开default.dat文件,在目录中查找文件,根据是否找到了文件返回文件名或一个空格。
public string GetTheDefaultFileName(string sLocalDirectory)
{
StreamReader sr;
String sLine = "";
try
{
//打开default.dat,获得缺省清单
sr = new StreamReader("data\\Default.Dat");
while ((sLine = sr.ReadLine()) != null)
{
//在web服务器的根目录下查找缺少文件
if (File.Exists( sLocalDirectory + sLine) == true)
break;
}
}
catch(Exception e)
{
Console.WriteLine("An Exception Occurred : " + e.ToString());
}
if (File.Exists( sLocalDirectory + sLine) == true)
return sLine;
else
return "";
}
象在IIS中那样,我们必须将虚拟目录解析为物理目录。在Vdir.Dat中,我们已经存储了实际的物理目录和虚拟目录之间的映像关系。需要记住的是,在任何情况下,文件的格式都是重要的。
public string GetLocalPath(string sMyWebServerRoot, string sDirName)
{
treamReader sr;
String sLine = "";
String sVirtualDir = "";
String sRealDir = "";
intiStartPos = 0;
//删除多余的空格
sDirName.Trim();
// 转换成小写
sMyWebServerRoot = sMyWebServerRoot.ToLower();
// 转换成小写
sDirName = sDirName.ToLower();
try
{
//打开Vdirs.dat文件,获得虚拟目录
sr = new StreamReader("data\\VDirs.Dat");
while ((sLine = sr.ReadLine()) != null)
{
//删除多余的空格
sLine.Trim();
if (sLine.Length > 0)
{
//找到分割符
iStartPos = sLine.IndexOf(";");
// 转换成小写
sLine = sLine.ToLower();
sVirtualDir = sLine.Substring(0,iStartPos);
sRealDir = sLine.Substring(iStartPos + 1);
if (sVirtualDir == sDirName)
{
break;
}
}
}
}
catch(Exception e)
{
Console.WriteLine("An Exception Occurred : " + e.ToString());
}
if (sVirtualDir == sDirName)
return sRealDir;
else
return "";
}
我们还必须使用用户提供的文件扩展名确定Mime类型。
public string GetMimeType(string sRequestedFile)
{
StreamReader sr;
String sLine = "";
String sMimeType = "";
String sFileExt = "";
String sMimeExt = "";
// 转换成小写
sRequestedFile = sRequestedFile.ToLower();
int iStartPos = sRequestedFile.IndexOf(".");
sFileExt = sRequestedFile.Substring(iStartPos);
try
{
//打开Vdirs.dat文件,获得虚拟目录
sr = new StreamReader("data\\Mime.Dat");
while ((sLine = sr.ReadLine()) != null)
{
sLine.Trim();
if (sLine.Length > 0)
{
//找到分割符
iStartPos = sLine.IndexOf(";");
// 转换成小写
sLine = sLine.ToLower();
sMimeExt = sLine.Substring(0,iStartPos);
sMimeType = sLine.Substring(iStartPos + 1);
if (sMimeExt == sFileExt)
break;
}
}
}
catch (Exception e)
{
Console.WriteLine("An Exception Occurred : " + e.ToString());
}
if (sMimeExt == sFileExt)
return sMimeType;
else
return "";
}
下面我们来编写建立和向浏览器(客户端)发送头部信息的函数。
public void SendHeader( string sHttpVersion,
string sMIMEHeader,
int iTotBytes,
string sStatusCode,
ref Socket mySocket)
{
String sBuffer = "";
//如果用户没有提供Mime类型,则将其缺省地设置为text/html
if (sMIMEHeader.Length == 0 )
{
sMIMEHeader = "text/html"; // Default Mime Type is text/html
}
sBuffer = sBuffer + sHttpVersion + sStatusCode + "\r\n";
sBuffer = sBuffer + "Server: cx1193719-b\r\n";
sBuffer = sBuffer + "Content-Type: " + sMIMEHeader + "\r\n";
sBuffer = sBuffer + "Accept-Ranges: bytes\r\n";
sBuffer = sBuffer + "Content-Length: " + iTotBytes + "\r\n\r\n";
Byte[] bSendData = Encoding.ASCII.GetBytes(sBuffer);
SendToBrowser( bSendData, ref mySocket);
Console.WriteLine("Total Bytes : " + iTotBytes.ToString());
}
SendToBrowser函数向浏览器发送信息,这是一个工作量比较大的函数。
public void SendToBrowser(String sData, ref Socket mySocket)
{
SendToBrowser (Encoding.ASCII.GetBytes(sData), ref mySocket);
}
public void SendToBrowser(Byte[] bSendData, ref Socket mySocket)
{
int numBytes = 0;
try
{
if (mySocket.Connected)
{
if (( numBytes = mySocket.Send(bSendData, bSendData.Length,0)) == -1)
Console.WriteLine("Socket Error cannot Send Packet");
else
{
Console.WriteLine("No. of bytes send {0}" , numBytes);
}
}
else
Console.WriteLine("Connection Dropped....");
}
catch (Exception e)
{
Console.WriteLine("Error Occurred : {0} ", e );
}
}
我们已经有了编写一个互联网服务器应用程序的一些部件,下面我们将讨论互联网服务器应用程序中的关健函数。
public void StartListen()
{
int iStartPos = 0;
String sRequest;
String sDirName;
String sRequestedFile;
String sErrorMessage;
String sLocalDir;
String sMyWebServerRoot = "C:\\MyWebServerRoot\\";
String sPhysicalFilePath = "";
String sFormattedMessage = "";
String sResponse = "";
while(true)
{
//接受一个新的连接
Socket mySocket = myListener.AcceptSocket() ;
Console.WriteLine ("Socket Type " +mySocket.SocketType );
if(mySocket.Connected)
{
Console.WriteLine("\nClient Connected!!\n==================\n
CLient IP {0}\n", mySocket.RemoteEndPoint) ;
//生成一个字节数组,从客户端接收数据
Byte[] bReceive = new Byte[1024] ;
int i = mySocket.Receive(bReceive,bReceive.Length,0) ;
//将字节型数据转换为字符串
string sBuffer = Encoding.ASCII.GetString(bReceive);
//上前我们将只处理GET类型
if (sBuffer.Substring(0,3) != "GET" )
{
Console.WriteLine("Only Get Method is supported..");
mySocket.Close();
return;
}
// 查找HTTP请求
iStartPos = sBuffer.IndexOf("HTTP",1);
// 获取“HTTP”文本和版本号,例如,它会返回“HTTP/1.1”
string sHttpVersion = sBuffer.Substring(iStartPos,8);
//解析请求的类型和目录/文件
sRequest = sBuffer.Substring(0,iStartPos - 1);
//如果存在\符号,则使用/替换
sRequest.Replace("\\","/");
//如果提供的文件名中没有/,表明这是一个目录,我们解危需要查找缺省的文件名
if ((sRequest.IndexOf(".") <1) && (!sRequest.EndsWith("/")))
{
sRequest = sRequest + "/";
}
//解析请求的文件名
iStartPos = sRequest.LastIndexOf("/") + 1;
sRequestedFile = sRequest.Substring(iStartPos);
//解析目录名
sDirName = sRequest.Substring(sRequest.IndexOf("/"), sRequest.LastIndexOf("/")-3);
上面的代码无须多加解释,它接收用户的请求,将用户的请求由字节型数据转换为字符串型数据,然后查找请求的类型,解析HTTP的版本号、文件和目录信息。
// 确定物理目录
if ( sDirName == "/")
sLocalDir = sMyWebServerRoot;
else
{
//获得虚拟目录
sLocalDir = GetLocalPath(sMyWebServerRoot, sDirName);
}
Console.WriteLine("Directory Requested : " + sLocalDir);
//如果物理目录不存在,则显示出错信息
if (sLocalDir.Length == 0 )
{
sErrorMessage = "〈H2〉Error!! Requested Directory does not exists〈/H2〉〈Br〉";
//sErrorMessage = sErrorMessage + "Please check data\\Vdirs.Dat";
//对信息进行格式化
SendHeader(sHttpVersion, "", sErrorMessage.Length, " 404 Not Found", ref mySocket);
//向浏览器发送信息
SendToBrowser(sErrorMessage, ref mySocket);
mySocket.Close();
continue;
}
提 示:微软的IE浏览器一般情况下总会显示一个比较“友好”一点的HTTP错误网页,如果要显示我们的Web服务器应用程序的错误信息,需要禁用IE中“显 示友好HTTP错误信息”的功能,方法是依次点击“工具”->“互联网工具”,然后在其中的“高级”标签中即可以看到该选项。
如 果用户没有提供目录名,Web服务器应用程序会使用GetLocalPath函数获取物理目录的信息,如果目录不存在(或者没有映射为Vdir.Dat中 的条目),就会向浏览器发送错误信息。接下来Web服务器应用程序会确定文件名,如果用户没有提供文件名,Web服务器应用程序可以调用 GetTheDefaultFileName函数获取文件名,如果有错误发生,则会将错误信息发送到浏览器。
//如果文件名不存在,则查找缺省文件列表
if (sRequestedFile.Length == 0 )
{
// 获取缺省的文件名
sRequestedFile = GetTheDefaultFileName(sLocalDir);
if (sRequestedFile == "")
{
sErrorMessage = "〈H2〉Error!! No Default File Name Specified〈/H2〉";
SendHeader(sHttpVersion, "", sErrorMessage.Length, " 404 Not Found",
ref mySocket);
SendToBrowser ( sErrorMessage, ref mySocket);
mySocket.Close();
return;
}
}
下面我们来识别Mime类型:
String sMimeType = GetMimeType(sRequestedFile);
//构建物理路径
sPhysicalFilePath = sLocalDir + sRequestedFile;
Console.WriteLine("File Requested : " + sPhysicalFilePath);
最后一个步骤是打开被请求的文件,并将它发送给浏览器。
if (File.Exists(sPhysicalFilePath) == false)
{
sErrorMessage = "〈H2〉404 Error! File Does Not Exists...〈/H2〉";
SendHeader(sHttpVersion, "", sErrorMessage.Length, " 404 Not Found", ref mySocket);
SendToBrowser( sErrorMessage, ref mySocket);
Console.WriteLine(sFormattedMessage);
}
else
{
int iTotBytes=0;
sResponse ="";
FileStream fs = new FileStream(sPhysicalFilePath, FileMode.Open,FileAccess.Read,
FileShare.Read);
// 创建一个能够从FileStream中读取字节数据的reader
BinaryReader reader = new BinaryReader(fs);
byte[] bytes = new byte[fs.Length];
int read;
while((read = reader.Read(bytes, 0, bytes.Length)) != 0)
{
// 从文件中读取数据,并将数据发送到网络上
sResponse = sResponse + Encoding.ASCII.GetString(bytes,0,read);
iTotBytes = iTotBytes + read;
}
reader.Close();
fs.Close();
SendHeader(sHttpVersion, sMimeType, iTotBytes, " 200 OK", ref mySocket);
SendToBrowser(bytes, ref mySocket);
//mySocket.Send(bytes, bytes.Length,0);
}
mySocket.Close();
}
}
}
}
}
编译和执行
可以使用下图所示的命令编译我们的Web服务器应用程序:
![](https://i-blog.csdnimg.cn/blog_migrate/251d290f47b139b6d7eccae0904eb038.gif)
在我使用的.NET开发工具中,无须指定任何库的名字,在较老版本的.NET开发工具中,可能会需要使用/r参数添加对dll库文件的引用。
要运行该Web服务器应用程序,只要如下图那样输入程序的名字,并按回车键即可。
![](https://i-blog.csdnimg.cn/blog_migrate/e5ae0d96ee39a1d6dec93dbde46fea40.gif)
Now, let say user send the request, our web server will identify the default file name and sends to the browser.
现在,我们假设用户发送了请求,我们的Web服务器应用程序将会决定使用缺省的文件,并将它返回给浏览器。如下图所示:
![](https://i-blog.csdnimg.cn/blog_migrate/9999627878e47bd3e02934cd370a936b.gif)
当然了,用户也可以请求图像文件
![](https://i-blog.csdnimg.cn/blog_migrate/855d2243ad379d28cecebd2b5d5e507a.gif)
可能的改进
WebServer仍然有许多地方可以加以改进。它不支持嵌入式图像和脚本,读者可以自己编写ISAPI过滤器,也可以使用IIS ISAPI过滤器。
结束语
本篇文章展示了开发Web服务器的基本原理,我们仍然可以对文章中的Web服务器应用程序进行许多改进,希望它能够起到抛砖引玉的作用,对读者有所启迪。