這 篇文章討論了如何使用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服務器應用程序:
在我使用的.NET開發工具中,無須指定任何庫的名字,在較老版本的.Net開發工具中,可能會需要使用/r參數添加對dll庫文件的引用。
要運行該Web服務器應用程序,只要如下圖那樣輸入程序的名字,並按回車鍵即可。
Now, let say user send the request, our web server will identify the default file name and sends to the browser.
現在,我們假設用戶發送了請求,我們的Web服務器應用程序將會決定使用缺省的文件,並將它返回給浏覽器。如下圖所示:
當然了,用戶也可以請求圖像文件
可能的改進
WebServer仍然有許多地方可以加以改進。它不支持嵌入式圖像和腳本,讀者可以自己編寫ISAPI過濾器,也可以使用IIS ISAPI過濾器。
結束語
本篇文章展示了開發Web服務器的基本原理,我們仍然可以對文章中的Web服務器應用程序進行許多改進,希望它能夠起到拋磚引玉的作用,對讀者有所啟迪。