Http Handler 介紹

Http Handler 介紹

引言

在 Part.1 Http請求處理流程 一文中，我們瞭解了Http請求的處理過程以及其它一些運作原理。我們知道Http管道中有兩個可用接口，一個是IHttpHandler，一個是IHttpModule，但在Part.1中，我並沒有詳細講述如何對它們進行編程，只是輕描淡寫地一筆帶過。所謂學以致用，前面已經介紹了不少概念和原理。在本文中，我們通過幾個範例來了解 IHttpHandler，看看掌握這些原理的實際用途。

IHttpHandler 概述

可能和我一樣，很多Asp.Net開發人員都有過Asp的背景，以至於我們在開發程序的時候，通常都是在“頁面級”上思考，也就是說我們現在正在做的這個頁面應該有什麼樣的功能，是進行一個問卷調查還是一個數據庫查詢等等。而很少在“請求級”思考，考慮有沒有辦法來通過編碼的方式來操控一個Http請求。

實際上，Framework提供了一系列的接口和類，允許你對於Http請求進行編程，而實現這一操作的一個主要的接口，就是 IHttpHandler(另一個是IHttpModule)。

應該還記得第一節中我們提到過 ISAPI，它根據文件名後綴把不同的請求轉交給不同的處理程序。但是仔細看看就會發現：幾乎一大半的文件都交給 aspnet_isapi.dll 去處理了。很明顯，aspnet_isapi.dll 不可能對每種文件採用同一種方式處理，那麼 aspnet_isapi.dll 是如何更進一步處理不同的文件，交由誰去處理呢？爲了搞清楚這個問題，我們需要打開機器上C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG\ 目錄下的web.config 文件。

NOTE：我查閱了很多資料，都說是在 machine.config 中，但實際上 v2.0.50727 下的machine.config中httpHandlers結點是這樣的：<httpHandlers />，並沒有給出詳細的處理程序，在Web.config中才能看到。而v1.1.4322 下的machine.config中卻有。

找到httpHandlers結點，應該可以看到如下這樣的代碼(做了省略)：

<httpHandlers>
... ... //略
<add path="*.axd" verb="*" type="System.Web.HttpNotFoundHandler" validate="True" /><add path="*.aspx" verb="*" type="System.Web.UI.PageHandlerFactory" validate="True" />
   <add path="*.ashx" verb="*" type="System.Web.UI.SimpleHandlerFactory" validate="True" />
   <add path="*.asax" verb="*" type="System.Web.HttpForbiddenHandler" validate="True" />
<add path="*.ascx" verb="*" type="System.Web.HttpForbiddenHandler" validate="True" />
   <add path="*.config" verb="*" type="System.Web.HttpForbiddenHandler" validate="True" />
   <add path="*.cs" verb="*" type="System.Web.HttpForbiddenHandler" validate="True" />
   <add path="*" verb="GET,HEAD,POST" type="System.Web.DefaultHttpHandler" validate="True" />
   ... ... //略 
</httpHandlers>

可以看到，在<httpHandlers>結點中將不同的文件類型映射給不同的Handler去處理，對於.aspx來說，是由System.Web.UI.PageHandlerFactory來處理。而對於.cs來說，是由System.Web.HttpForbiddenHandler 處理，從ForbiddenHandler名字中出現的Forbidden (翻譯過來是“禁止”)可以看出，這個Handler可以避免我們的源碼被看到。

NOTE：System.Web.UI.PageHandlerFactory 是一個IHttpHandlerFactory，而不是一個單一的HttpHandler，IHttpHandlerFactory用來做什麼後面會說明。

上面列出的是.Net Framework在處理Http請求時的所採用的默認Handler。而如果我們要用編程的方式來操控一個Http請求，我們就需要實現IHttpHandler接口，來定製我們自己的需求。

IHttpHandler的定義是這樣的：

public interface IHttpHandler{
    void ProcessRequest(HttpContext context);
    bool IsReusable { get; }
}

由上面可以看出IHttpHandler要求實現一個方法和一個屬性。其中 ProcessRequest，從名字(處理請求)看就知道這裏應該放置我們處理請求的主要代碼。

IsReusable屬性，MSDN上是這樣解釋的：獲取一個值，該值指示其他請求是否可以使用 IHttpHandler 實例。也就是說後繼的Http請求是不是可以繼續使用實現了該接口的類的實例，一般來說，我把它設置成true。

那麼實現此接口的類形式應該是這樣的：

public class CustomHandler : IHttpHandler{
    public void ProcessRequest(HttpContext context)  {
       // 處理請求的代碼
    }
    public bool IsReusable {
       get { return true; }
    }
}

而爲了能使用這個自定義的HttpHandler，我們需要在應用程序目錄下的Web.config中註冊它。

 <system.web>
    <httpHandlers>
      <add path="*.jpg" verb="*" type="MyNameSpace.MyClass, MyDllName" />
    </httpHandlers>
 </system.web>

應該發現這與之前在C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG\目錄下web.config中看到的幾乎完全一樣。這裏，path指的是請求的文件名稱，可以使用通配符擴大範圍，也可以明確指定這個handler僅用於處理某個特定的文件(比如說：filename.aspx)的請求。verb指的是請求此文件的方式，可以是post或get，用*代表所有訪問方式。type屬性由“,”分隔成兩部分，第一部分是實現了接口的類名，第二部分是位於Bin目錄下的編譯過的程序集名稱。

NOTE：如果你新建一個項目，並且在項目下創建HandlerTest.cs，然後讓站點引用該項目，那麼在生成解決方案的時候會自動將編譯好的.dll文件添到Bin目錄中。
    NOTE：MyDll只寫程序集名，不要加後面的.dll。

使用HttpHandler實現圖片防盜鏈

有了之前這麼多的準備知識，實現現在的目標就容易得多了：

NOTE：這個例子，以及下面的一個例子均來自於《Maximizing ASP.NET Real World, Object-Oriented Development》一書：

Step.1：創建文件 CustomHandler.cs，代碼如下：

using System;
using System.Web;

namespace CustomHandler{
    public class JpgHandler : IHttpHandler{
       public void ProcessRequest(HttpContext context){
           // 獲取文件服務器端物理路徑
           string FileName = context.Server.MapPath(context.Request.FilePath);
           // 如果UrlReferrer爲空，則顯示一張默認的禁止盜鏈的圖片
           if (context.Request.UrlReferrer.Host == null){
              context.Response.ContentType = "image/JPEG";
              context.Response.WriteFile("/error.jpg");
           }else{
              // 如果 UrlReferrer中不包含自己站點主機域名，則顯示一張默認的禁止盜鏈的圖片
             if (context.Request.UrlReferrer.Host.IndexOf("yourdomain.com") > 0){
                  context.Response.ContentType = "image/JPEG";
                  context.Response.WriteFile(FileName);
              }else{
                  context.Response.ContentType = "image/JPEG";
                  context.Response.WriteFile("/error.jpg");
              }
           }
       }

       public bool IsReusable{
           get{ return true; }
       }
    }
}

Step.2 編譯這個文件

csc /t:library /r:System.Web.dll CustomHandler.cs

Step.3 將編譯好的 CustomHandler.dll 拷貝到站點的 Bin 目錄下。

Step.4 在Web.Config 中註冊這個Handler。

<system.web>
    <httpHandlers>
      <add path="*.jpg" verb="*" type="CustomHandler.JpgHandler, CustomHandler" />
    </httpHandlers>
 </system.web>

OK，諸位可以按步驟自行測試一下，這裏就不贅述了。

通過IhttpHandler實現圖片驗證碼

也可以在一個.ashx文件中實現IHttpHandler，而不是採用這種提前編譯的方式。

Step.1 打開Vs2005，“添加新項”，“一般處理程序”。新建文件後，VS會自動在文件中添加如下的代碼：

<%@ WebHandler Language="C#" Class="Handler" %>

using System;
using System.Web;

public class Handler : IHttpHandler {
    public void ProcessRequest (HttpContext context) {
        context.Response.ContentType = "text/plain";
        context.Response.Write("Hello World");
    }
 
    public bool IsReusable {
        get {
            return false;
        }
    }
}

Step.2 將代碼改寫成如下所示：

<%@ WebHandler Language="C#" Class="Handler" %>

using System;
using System.Drawing;
using System.Drawing.Imaging;
using System.Text;
using System.Web;
using System.Web.SessionState;

public class Handler : IHttpHandler, IRequiresSessionState {

    public void ProcessRequest(HttpContext context) {
       context.Response.ContentType = "image/gif";
       //建立Bitmap對象，繪圖
       Bitmap basemap = new Bitmap(200, 60);
       Graphics graph = Graphics.FromImage(basemap);
       graph.FillRectangle(new SolidBrush(Color.White), 0, 0, 200, 60);
       Font font = new Font(FontFamily.GenericSerif, 48, FontStyle.Bold, GraphicsUnit.Pixel);
       Random r = new Random();
       string letters = "ABCDEFGHIJKLMNPQRSTUVWXYZ";
       string letter;
       StringBuilder s = new StringBuilder();
       
       //添加隨機的五個字母
       for (int x = 0; x < 5; x++) {
           letter = letters.Substring(r.Next(0, letters.Length - 1), 1);
           s.Append(letter);
           graph.DrawString(letter, font, new SolidBrush(Color.Black), x * 38, r.Next(0, 15));
       }
       
       //混淆背景
       Pen linePen = new Pen(new SolidBrush(Color.Black), 2);
       for (int x = 0; x < 6; x++)
           graph.DrawLine(linePen, new Point(r.Next(0, 199), r.Next(0, 59)), new Point(r.Next(0, 199), r.Next(0, 59)));
              
       //將圖片保存到輸出流中       
       basemap.Save(context.Response.OutputStream, ImageFormat.Gif);
       context.Session["CheckCode"] = s.ToString();   //如果沒有實現IRequiresSessionState，則這裏會出錯，也無法生成圖片
       context.Response.End();      
    }

    public bool IsReusable {
       get { return true; }
    }
}

需要特別注意的是，Handler類不僅需要實現 IHttpHandler接口(這個顯然)，爲了在這個Handler類中使用SessionState，還需要實現IRequiresSessionState接口，對於這個接口，MSDN的解釋是這樣的：Specifies that the target HTTP handler requires read and write access to session-state values. This is a marker interface and has no methods.(翻譯過來是：指定當前Http Handler需要對SessionState值的讀寫訪問權。這是一個標記接口，沒有任何方法)。

而實際上，IRequiresSessionState的接口定義是這樣的：

public interface IRequiresSessionState{}

可見，這個接口沒有任何需要實現的方法或屬性，大家只要記得：如果想在HttpHandler中使用SessionState，必須實現這個接口，實際上也就是在類的標頭將這個接口加進去。

Step.3 新建一個ImageCode.aspx頁面，在HTML代碼中寫下：

<img src="Handler.ashx" alt="圖片驗證碼" />

OK，在瀏覽器中打開ImageCode.aspx，應該可以看到如下所示：

利用HttpHandler創建自定義後綴Rss源

RSS如今已經可以說是隨處可見，而RSS的實現方式，通常是在一個.aspx的CodeBehind文件中寫一個XML文件，然後加載到Response的OutputStream中， Rss源通常是Rss.aspx這種形式的。通過第一章學到的ISAPI的知識，再結合本章學到的關於HttpHandler的知識，很容易想到：我們可以自定一個以 .rss 作爲後綴名的文件來實現 Rss 源，比如說Article.rss。現在我們就一步步來實現它：

NOTE：關於RSS的更多內容，可以參閱我編譯的 在Web站點中創建和使用RSS源。本文不再解釋Rss是什麼，如何創建Rss源，爲了文章的獨立性，僅給出創建過程。

Step.1 創建範例數據庫

Create Table RssSample
(
    SampleId      Int Identity(1,1)    Not Null,
    Title         Varchar(100)          Not Null Constraint uq_Title Unique,
    Author        Varchar(50)              Not Null,
    PubDate       DateTime              Not Null Default GetDate(),
    [Description] Varchar(500)          Not Null,
    Link          Varchar(150)          Not Null

    Constraint pk_RssSample Primary Key(SampleId)
)
-- 插入範例數據
Insert Into RssSample(Title, Author, [Description], Link)
Values('標題1', '作者1', '文章摘要1', 'http://127.0.0.1/#' )

-- 省略 ....

Step.2 建立站點，在App_Code目錄下建立RssFeedsLib.cs文件。

using System;
using System.Data;
using System.Data.SqlClient;
using System.IO;
using System.Web;
using System.Xml;
using System.Text;

namespace RssFeadsLib {
    public class RssGenerator {
       public static string GetRSS() {
           MemoryStream ms = new MemoryStream();
           XmlTextWriter writer = new XmlTextWriter(ms, null);
           SqlConnection conn = new SqlConnection("Data Source=.;Initial Catalog=Sample;User ID=sa;Password=sa");       //修改這裏成你的數據庫連接
           SqlCommand cmd = new SqlCommand("select * from RssSample order by pubdate desc", conn);

           conn.Open();
           SqlDataReader reader = cmd.ExecuteReader();
           writer.WriteStartElement("rss");
           writer.WriteAttributeString("version", "2.0");
           writer.WriteStartElement("channel");
           // Channel 下的結點靜態寫入
           writer.WriteElementString("title", "TraceFact.Net 技術文章");
           writer.WriteElementString("link", "http://www.tracefact.net");
           writer.WriteElementString("description", "Dedicated to asp.net...");
           writer.WriteElementString("copyright", "Copyright (C) 2007");
           writer.WriteElementString("generator", "My RSS Generator");
           // Item 結點從數據庫讀取
           while (reader.Read()) {
              writer.WriteStartElement("item");
              writer.WriteElementString("author", reader.GetString(reader.GetOrdinal("Author")));
              writer.WriteElementString("title",             reader.GetString(reader.GetOrdinal("title")));
              writer.WriteElementString("link", reader.GetString(reader.GetOrdinal("Link")));
              writer.WriteElementString("description", reader.GetString(reader.GetOrdinal("Description")));
              writer.WriteElementString("pubDate", reader.GetDateTime(reader.GetOrdinal("PubDate")).ToString(@"ddd, dd MMM yyyy 12:00:00 tt "));
              writer.WriteEndElement();
           }

           writer.WriteEndElement();
           writer.WriteEndElement();
           reader.Close();
           conn.Close();

           writer.BaseStream.Flush();
           writer.Flush();
           ms.Flush();

           // 將流轉換成String並返回
           byte[] data = new byte[ms.Length];
           ms.Seek(0, SeekOrigin.Begin);
           ms.Read(data, 0, data.Length);
           ms.Close();
           return UTF8Encoding.UTF8.GetString(data);
       }
    }
}

Step.3 創建可以處理 .rss 後綴名的 RssHandler

我們在這個 RssFeedsLib命名空間下，再添加一個類，這個類用於處理對 .rss 後綴名文件的Http請求。

public class RSSHandler:IHttpHandler{
    public bool IsReusable
    {
       get {return false;}
    }

    public void ProcessRequest(HttpContext context){
       context.Response.ContentType = "text/xml";
       string str = RssGenerator.GetRSS();
       context.Response.Write(str);
    }
}

Step.4 在Web.config中進行配置

<httpHandlers>
    <add path="*.rss" type="RssFeadsLib.RSSHandler" verb="GET" />
</httpHandlers>

 

NOTE：因爲這個類和命名空間位於App_Code中，這裏就不需要再手動編譯RssFeadsLib.cs然後將編譯好的.dll應用程序集放到Bin目錄中了。至於爲什麼可以這樣，將會在 《Asp.Net 構架與安全機制 Part.5 – 頁面生存週期與編譯模型》中解釋。

Step.5 在IIS 對ISAPI進行設置。

應該還記得在Part.1中如何在IIS中設置ISAPI來進行文件與處理程序映射：

1. 打開IIS，選擇本範例所用的站點，右鍵，選擇“屬性”。
2. 選擇“主目錄”選項卡，點擊“配置...”按鈕。
3. 點擊“添加”，設置“可執行文件”爲“C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\aspnet_isapi.dll”，設置“擴展名”爲“.rss”，點“確定”。
4. 注意，不要勾選“檢查文件是否存在”複選框，這樣不用創建文件，只要在地址欄輸入任意以.rss後綴結尾的文件名，均會交由上面創建的Handler去處理，而不管這個文件是否存在，也不管請求的是Article.rss還是Sample.rss。

進行了這些設置以後，現在IIS就知道如何去處理對.rss後綴名文件的請求了。

Step.6 測試範例

這個時候，隨便打開一個頁面，比如空白的Default.aspx，然後我們在地址欄將文件改爲：Article.rss(改成abc.rss也是一樣)，敲回車，應該可以看到如下的畫面。

IHttpHandlerFactory 概述

現在假設我們有這樣的需求，我們不僅想要處理 .rss 後綴名，還想要能夠處理 .atom後綴名，假設處理atom的類命名爲AtomHandler，那麼我們的Web.config該如何設置呢？我想應該是這樣的：

<httpHandlers>
<add path="*.rss" type="RssFeadsLib.RSSHandler" verb="GET" />
<add path="*.atom" type="RssFeadsLib.AtomHandler" verb="GET" />
</httpHandlers>

如果我們有很多個HttpHandler分別映射不同後綴名的請求，這樣我們的Web.config會變得很冗長，或者，我們只有在程序運行時才能確切地知道使用哪個Handler，這個時候，可以考慮實現 IHttpHandlerFactory來完成這一過程。

IHttpHandlerFactory的定義是這樣的：

public interface IHttpHandlerFactory{
    IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated);
    void ReleaseHandler(IHttpHandler handler);
}

可見，需要實現兩個方法，分別是 GetHandler() 和 ReleaseHandler()。

• GetHandler()，返回實現了IHttpHandler接口的類的實例。
• ReleaseHandler()，使得Factory可以重複使用一個已經存在的Handler實例。

對於上面 .atom 和 .rss 的問題，我們可以這樣來實現 IHttpHandlerFactory接口：

class HandlerFactory:IHttpHandlerFactory{
    public IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated){
       string path = context.Request.PhysicalPath;
       if (Path.GetExtension(path) == ".rss"){
           return new RSSHandler();
       }

       if (Path.GetExtension(path) == ".atom"){
           return new ATOMHandler();
       }
       return null;
    }

    public void ReleaseHandler(IHttpHandler handler){
    }
}

這時，在Web.Config 中<system.web>節點下進行如下設置即可：

<httpHandlers>
<add path="*.rss,*.atom" type=" RssFeadsLib.HandlerFactory" verb="GET" />
</httpHandlers>

但是，這不能簡化IIS中ISAPI的設置，還是需要手動去對.rss和.atom分別設置。

總結

在本文中，我們首先討論了aspnet_isapi.dll 如何將對不同後綴名文件的請求分發給相應的處理程序，如何查看Framework默認的處理程序Handler。

然後，我們通過三個實例，圖片防盜鏈、圖片驗證碼、處理自定義後綴名請求，詳細講解了IHttpHandler的實現方法和使用過程。

最後，我向大家概要地介紹了IHttpHandlerFactory接口。