實現自己的ASP.NET宿主系統

asp.net 實現自己的ASP.NET宿主系統

楊山河

一、 宿主概念
託管是.NET的一個很基礎的概念，所有的.NET應用程式代碼要完全發揮作用需要進入託管的環境（CLR --Common Language Runtime），而這個環境實際上就是稱作宿主(Host)為將要啟動的.NET代碼準備的。目前來講windows系統上，能夠擔負這個重任的有3類已存程式：
1、 shell(通常是Explorer)，提供從使用者案頭啟動.NET程式,建立一個進程，啟動此進程建立CLR
2、 瀏覽器宿主（Internet Explorer），處理從web下載的.NET代碼執行。
3、 伺服器宿主（如IIS的輔助進程ASPnet_wp.exe）
通常來講，我們開發的ASP.NET的程式運行在IIS的環境下（實際上由一個ISAPI控制啟動CLR），但實際上ASP.NET程式可以擺脫IIS單獨在任何託管環境下運行。本文討論了ASP.NET程式如何在自訂的環境中啟動，希望有助於我們瞭解ASP.NET的執行原理，同時使我們開發的ASP.NET能夠在任何.NET環境下執行，不管是伺服器作業系統還是普通的案頭作業系統。

二、 IIS宿主中ASP.NET的執行分析
關於IIS中ASP.NET的執行細節，很多文章做了詳盡權威的分析，本文不打算贅述，在此給出一些參考：
http://www.yesky.com/SoftChannel/72342380468043776/20030924/1731387.shtml
http://chs.gotdotnet.com/quickstart/ASPplus/doc/procmodel.ASPx
這些文章大致重點分析了：宿主環將如何啟動、ASP.NET應用程式如何產生程式集、如何載入，同宿主的互動等細節。

三、 構造自己的ASP.NET宿主程式
ASP.NET是作為微軟ASP的替代技術出現的，所以我們重點討論如何通過web方式應用ASP.NET（顯然還有其他方式），具體就是：我們用.NET平台的語言編寫一個控制台程式，這個程式啟動一個ASP.NET應用環境，執行關於ASPx的請求。具體來講，需要做以下工作：
1、實現一個Web Server，監聽所有的web請求，實現Http web hosting
2、啟動一個應用程式定義域，建立一個ASP.NET的ApplicationHost，建立一個ASP.NET的應用程式定義域，另外還建立一個HttpWorkerRequest的具體實作類別，該類可以處理ASPx請求，編譯ASPx頁，編譯後的Managed 程式碼緩衝入當前應用程式定義域，然後執行代碼，得到執行結果。建議在繼續閱讀下文前，仔細翻查MSDN中的關於這兩個類得參考說明。
System.Web.Hosting.ApplicationHost類用於建立一個獨立的應用程式定義域。當然不是普通的應用程式定義域，而是為ASP.NET建立執行環境，準備需要的空間、資料結構等。僅有一個靜態方法static object CreateApplicationHost(
Type host //具體的使用者實作類別，就是ASP.NET應用域需要載入的類
string virtualDir, //此應用域在整個web中的執行目錄，虛擬目錄
string physicalDir //對應的物理目錄
);
而其中的host 參數指向一個具體的類，由於該類實際上屬於兩個應用域之間的聯絡類，在兩個應用程式定義域之間編組傳遞資料，所以必須要繼承自MarshalByRefObject，以允許在支援應用程式中跨應用程式定義域邊界訪問（至於為什麼，建議翻查參考3）。
可以看到，我們需要啟動兩個應用程式定義域（web server功能應用程式定義域和ASP.NET 應用程式定義域），而這兩個（應用程式）域之間通過跨（應用程式）域的流對象引用來實現，使得在ASP.NET域中執行的結果可以通過web server域返回給要求者。
可以大致下圖表達
執行ASP.NET的Web伺服器端










WEB用戶端

代碼實現分析：
using System;
using System.Web ;
using System.Web.Hosting;
using System.IO;
using System.NET;
using System.NET.Sockets ;
using System.Text ;
using System.Threading ;

namespace MyIIS
{
class ASPHostServer
{
[STAThread]
static void Main(string[] args)
{
//建立並啟動伺服器
MyServer myserver=new MyServer(“/”, ”c:\\inetpub\\wwwroot\\myWeb”);
}
}

class MyServer //處理HTTP協議的伺服器類
{
private ASPDOTNETHost ASPnetHost; //ASP.NET host的執行個體
private TcpListener mytcp; //Web監聽通訊端
bool bSvcRunning=true; //服務是否運行指示
FileStream fs; //處理http請求的普通文本要求

public MyServer(string virtualDir ,vstring realPath)
{//在建構函式中啟動web監聽服務
try
{
mytcp=new TcpListener(8001);
mytcp.Start(); //啟動在8001連接埠的監聽
Console.WriteLine("服務啟動...");
//利用CreateApplicationHost方法建立一個獨立的應用程式定義域執行ASP.NET程式
ASPnetHost = ( ASPDOTNETHost )ApplicationHost.CreateApplicationHost
( typeof( ASPDOTNETHost ) , virtualDir , realPath);
Thread t=new Thread(new ThreadStart(MainSvcThread));
t.Start(); //服務線程啟動 負責處理每一個用戶端的請求
}
catch(NullReferenceException)
{
Console.WriteLine("NullReferenceException throwed!") ;
}
}

public void MainSvcThread() //ASP.NET Host的web伺服器的主要服務線程
{
int s=0;
string strRequest; //請求資訊
string strDir; //請求的目錄
string strRequestFile; //請求的檔案名稱
string strErr=""; //錯誤資訊
string strRealDir; //實際目錄
string strWebRoot=rpath; //應用根目錄
string strRealFile=""; //正在請求的檔案的磁碟路徑
string strResponse=""; //回應響應緩衝區
string strMsg=""; //格式化響應資訊
byte[] bs; //輸出位元組緩衝區

while(bSvcRunning)
{
Socket sck=mytcp.AcceptSocket(); //每個請求到來
if(sck.Connected)
{
Console.WriteLine("Client {0} connected!",sck.RemoteEndPoint);
byte[] bRecv=new byte[1024]; //緩衝區
int l=sck.Receive(bRecv,bRecv.Length,0);
string strBuf=Encoding.Default.GetString(bRecv); //轉換成字串，便於分析
s=strBuf.IndexOf("HTTP",1);
string httpver=strBuf.Substring(s,8); // HTTP/1.1 之類的
strRequest=strBuf.Substring(0,s-1);
strRequest.Replace("\\","/");
if((strRequest.IndexOf(".")<1) && (!strRequest.EndsWith("/")))
{
strRequest += "/";
}
s=strRequest.LastIndexOf("/")+1;
strRequestFile = strRequest.Substring(s); strDir=strRequest.Substring(strRequest.IndexOf("/"),strRequest.LastIndexOf("/")-3); //取得訪問的URL
if(strDir=="/")
{
strRealDir=strWebRoot;
}
else
{
strDir=strDir.Replace("/","\\");
strRealDir=strWebRoot + strDir;
}
Console.WriteLine("Client request dir: {0}" , strRealDir);
if(strRequestFile.Length==0)
{
strRequestFile="default.htm"; //預設文檔
}
int iTotlaBytes=0; //總計需要輸出的位元組
strResponse=""; //輸出內容
strRealFile = strRealDir +"\\"+ strRequestFile;
if(strRealFile.EndsWith(".ASPx")) //這裡有Bug!!
{
string output="";
//注意我下面的語句們給host對象ProcessRequest方法傳遞了一個ref類型的參數，
//ASPnetHost會從ASP.NET的執行應用程式定義域執行一個請求後返迴流給當前web server所在的域，這實際上發生了一個域間的調用
ASPnetHost.ProcessRequest (strRequestFile, ref output);//轉換成位元組流
bs=System.Text.Encoding.Default.GetBytes (output);
iTotlaBytes=bs.Length ; //調用通訊端將執行結果返回
WriteHeader(httpver,"text/html",iTotlaBytes,"200 OK",ref sck);
FlushBuf(bs,ref sck);
}
else
{try
{
fs=new FileStream( strRealFile,FileMode.Open,FileAccess.Read,FileShare.Read );
BinaryReader reader=new BinaryReader(fs); //讀取
bs=new byte[fs.Length ];
int rb;
while((rb=reader.Read(bs,0,bs.Length ))!=0)
{
strResponse =strResponse +Encoding.Default.GetString(bs,0,rb);
iTotlaBytes =iTotlaBytes+rb;
}
reader.Close();
fs.Close();
WriteHeader(httpver,"text/html",iTotlaBytes,"200 OK",ref sck);
FlushBuf(bs,ref sck);
}
catch(System.IO.FileNotFoundException )
{//假設找不到檔案，報告404 WriteHeader(httpver,"text/html",iTotlaBytes,"404 OK",ref sck);
}
}
}
sck.Close(); //Http請求結束
}
}

// WriteHeader想用戶端發送HTTP頭
public void WriteHeader(string ver,string mime,int len,string statucode,ref Socket sck) {
string buf="";

if(mime.Length ==0)
{
mime="text/html";

buf=buf+ver+ statucode + "\r\n";
buf=buf+"Server:MyIIS"+"\r\n";
buf=buf+"Content-Type:"+mime +"\r\n";
buf=buf+"Accept-Rabges:bytes"+"\r\n";
buf=buf+"Content-Length:"+ len +"\r\n\r\n";
byte[] bs=Encoding.Default.GetBytes(buf);
FlushBuf(bs,ref sck);
}
}

// FlushBuf重新整理向客戶發送資訊緩衝區
public void FlushBuf(byte[] bs,ref Socket sck)
{
int iNum=0;
try
{
if(sck.Connected)
{
if((iNum=sck.Send(bs,bs.Length ,0))==-1)
{
Console.WriteLine("Flush Err:Send Data err");
}
else
{
Console.WriteLine("Send bytes :{0}",iNum);
}
}
else
{
Console.WriteLine("Client diconnectioned!");
}
}
catch(Exception e)
{
Console.WriteLine("Error:{0}",e);
}
}
}

// ASPDOTNETHost類執行個體需要跨越兩個應用程式定義域，所以繼承自MarshalByRefObject
class ASPDOTNETHost:MarshalByRefObject
{
public void ProcessRequest( string fileName ,ref string output)
{
MemoryStream ms=new MemoryStream(); //記憶體流，當然為了速度
StreamWriter sw = new StreamWriter(ms); //輸出
sw.AutoFlush = true; //設為自動重新整理 /先構造一個HttpWorkRequest請求類，以便ASP.NET能夠分析擷取請求資訊，同時傳入一個輸出資料流對象供ASP.NET執行期間返回html流
HttpWorkerRequest worker = new SimpleWorkerRequest( fileName, "" ,sw) ; // 調度某個頁，這裡面的包含很多細節，後面分析
HttpRuntime.ProcessRequest( worker ) ;
StreamReader sr= new StreamReader(ms); //準備從記憶體流中讀取
ms.Position =0; //移動指標到頭
output = sr.ReadToEnd();
}
}
}
HttpRuntime.ProcessRequest( worker ) ;包括了那些細節呢？大體上如下：
1、首先，worker對象傳入給ASP.NET的應用程式定義域，告知發生了對於哪一個ASPx檔案的請求，以及目前的目錄是什麼，如果在執行期間發生的輸出內容應該寫到哪裡(sw對象)。這發生一個由web server當前應用程式定義域到我們自己建立的ASP.NET應用程式定義域的跨（應用程式）域調用，還可能由於是第一次訪問，會發生了全域事件、或者session事件等。
2、ASP.NET的應用程式定義域會檢測請求的ASPx檔案是否存在，不存在，就報錯；如果存在還要看看代碼緩衝中是否存在上次編譯的代碼，如果存在且ASP.NET檢測到不需要重新編譯，會直接執行緩衝中的代碼；如果不存在或者代碼到期需要重新編譯，就需要讀取ASPx檔案，編譯成.NET的代碼，存入緩衝。可能有些頁存在代碼和模板分離成多個檔案，甚至包括一些資源檔，這些都需要讀取後編譯成.NET的虛擬機器代碼，然後在託管環境裡執行。
3、執行ASP.NET的編譯代碼緩衝中的代碼，輸出資料利用sw對象輸出。
當然，根據不同的配置，還有很多方法的調用/事件的發生等細節不同。
如何調試運行以上程式，觀察結果呢？
建立一個控制台類型工程，將上述代碼錄入後編譯，將得到的程式拷貝在作為網站應用起始目錄（譬如c:\inetpub\wwwroot\myweb）的bin子目錄下，然後啟動，這樣在其中建立ASP.NET應用程式定義域才不會因為程式集載入失敗而出錯。建立一個asp.net工程在目錄下，添加default.htm檔案和測試用的test.aspx，加入.NET執行代碼，然後啟動IE，在地址欄分別輸入：http://127.0.0.1:8001/default.htm http://127.0.0.1:8001/test.aspx感受一下執行過程。甚至你可以建立的工程中設定斷點之類，仔細調試和觀察其中的細節。親手試一試吧，一定有收穫的！

四、 自己構造ASP.NET宿主的意義
費了半天勁搞自己的ASP.NET宿主，對於我們有何意義呢？
首先，是大致從代碼級清楚分析ASP.NET執行細節，自己學習瞭解執行細節，除了可以在出現ASP.NET故障可以進行精確定位和排除外，還可以協助我們在寫ASP.NET應用程式時寫出更有效率和健壯的代碼。
其次，我們可以提供一個思路，可以將我們的ASP.NET程式運行於低配置機器上，脫離IIS。ASP.NET的“原配”宿主IIS需要運行在Server OS上，要知道在安全專家眼中，IIS可是大隱患的源頭之一。我們可以將很多傳統程式利用ASP.NET編寫，但脫離IIS獨立執行，譬如在win98系統上執行ASP.NET。web server和ASP.NET都在託管環境中執行，相比較ISAPI建立宿主然後執行，除提高效率外，還可以使用.NET平台提供的豐富管理調控功能，寫B/S程式更接近傳統程式編寫方式，這對於程式員來講都是效率（編寫代碼的效率和執行效果效率）的保證。
另外，對於採用ASP.NET做的項目，大家可以很方便進行開發調試、運行維護、安裝。即使是普通傳統型程式，我們也可以通過類似製作網頁的方式編寫這些介面和代碼，然後獨立建立類似本例中的Host環境，根據使用者互動請求載入執行某些頁面，然後將介面在用戶端通過相關組件顯示出來。你可以通過此獲得ASP.NET的即時編譯功能和ASP.NET宿主託管環境，大量可自由使用的API，便於開發、安裝、維護。畢竟，託管環境幾乎準備了您需要的一切功能。

五、 參考資料
1、.NET MSDN
2、清華大學出版社《.NET網路進階編程》Andrew Krowczyk Viond Kumar原著
3、清華大學出版社《.NET架構程式設計(修訂版)》Jsfftry Richter著