使用C#開發自己的web伺服器(圖)

web|web服務|web伺服器

摘要

這 篇文章討論了如何使用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伺服器應用程式進行許多改進，希望它能夠起到拋磚引玉的作用，對讀者有所啟迪。