Http Handler 介紹web
引言數據庫
在 Part.1 Http 請求處理流程 一文中,咱們瞭解了Http請求的處理過程以及其它一些運做原理。咱們知道Http管道中有兩個可用接口,一個是IHttpHandler,一個是 IHttpModule,但在Part.1中,我並無詳細講述如何對它們進行編程,只是輕描淡寫地一筆帶過。所謂學以至用,前面已經介紹了很多概念和原理。在本文中,咱們經過幾個範例來了解 IHttpHandler,看看掌握這些原理的實際用途。編程
IHttpHandler 概述api
可能和我同樣,不少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中卻有。session
找到httpHandlers結點,應該能夠看到以下這樣的代碼(作了省略):asp.net
<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>dom
能夠看到,在<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來進行文件與處理程序映射:
進行了這些設置之後,如今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()。
對於上面 .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接口。