Http Handler 介绍(转)
轉(zhuǎn)自：http://www.tracefact.net/Asp-Net-Architecture/Introduction-to-Http-Handler.aspx
Http Handler 介紹
引言
在 Part.1 Http請(qǐng)求處理流程 一文中，我們了解了Http請(qǐng)求的處理過程以及其它一些運(yùn)作原理。我們知道Http管道中有兩個(gè)可用接口，一個(gè)是IHttpHandler，一個(gè)是IHttpModule，但在Part.1中，我并沒有詳細(xì)講述如何對(duì)它們進(jìn)行編程，只是輕描淡寫地一筆帶過。所謂學(xué)以致用，前面已經(jīng)介紹了不少概念和原理。在本文中，我們通過幾個(gè)范例來了解 IHttpHandler，看看掌握這些原理的實(shí)際用途。
IHttpHandler 概述
可能和我一樣，很多Asp.Net開發(fā)人員都有過Asp的背景，以至于我們?cè)陂_發(fā)程序的時(shí)候，通常都是在“頁面級(jí)”上思考，也就是說我們現(xiàn)在正在做的這個(gè)頁面應(yīng)該有什么樣的功能，是進(jìn)行一個(gè)問卷調(diào)查還是一個(gè)數(shù)據(jù)庫查詢等等。而很少在“請(qǐng)求級(jí)”思考，考慮有沒有辦法來通過編碼的方式來操控一個(gè)Http請(qǐng)求。
實(shí)際上，Framework提供了一系列的接口和類，允許你對(duì)于Http請(qǐng)求進(jìn)行編程，而實(shí)現(xiàn)這一操作的一個(gè)主要的接口，就是 IHttpHandler(另一個(gè)是IHttpModule)。
應(yīng)該還記得第一節(jié)中我們提到過 ISAPI，它根據(jù)文件名后綴把不同的請(qǐng)求轉(zhuǎn)交給不同的處理程序。但是仔細(xì)看看就會(huì)發(fā)現(xiàn)：幾乎一大半的文件都交給 aspnet_isapi.dll 去處理了。很明顯，aspnet_isapi.dll 不可能對(duì)每種文件采用同一種方式處理，那么 aspnet_isapi.dll 是如何更進(jìn)一步處理不同的文件，交由誰去處理呢？為了搞清楚這個(gè)問題，我們需要打開機(jī)器上C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG\ 目錄下的web.config 文件。
NOTE：我查閱了很多資料，都說是在 machine.config 中，但實(shí)際上 v2.0.50727 下的machine.config中httpHandlers結(jié)點(diǎn)是這樣的：<httpHandlers />，并沒有給出詳細(xì)的處理程序，在Web.config中才能看到。而v1.1.4322 下的machine.config中卻有。
找到httpHandlers結(jié)點(diǎn)，應(yīng)該可以看到如下這樣的代碼(做了省略)：
<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>結(jié)點(diǎn)中將不同的文件類型映射給不同的Handler去處理，對(duì)于.aspx來說，是由System.Web.UI.PageHandlerFactory來處理。而對(duì)于.cs來說，是由System.Web.HttpForbiddenHandler 處理，從ForbiddenHandler名字中出現(xiàn)的Forbidden (翻譯過來是“禁止”)可以看出，這個(gè)Handler可以避免我們的源碼被看到。
NOTE：System.Web.UI.PageHandlerFactory 是一個(gè)IHttpHandlerFactory，而不是一個(gè)單一的HttpHandler，IHttpHandlerFactory用來做什么后面會(huì)說明。
上面列出的是.Net Framework在處理Http請(qǐng)求時(shí)的所采用的默認(rèn)Handler。而如果我們要用編程的方式來操控一個(gè)Http請(qǐng)求，我們就需要實(shí)現(xiàn)IHttpHandler接口，來定制我們自己的需求。
IHttpHandler的定義是這樣的：
public interface IHttpHandler{
??? void ProcessRequest(HttpContext context);
??? bool IsReusable { get; }
}
由上面可以看出IHttpHandler要求實(shí)現(xiàn)一個(gè)方法和一個(gè)屬性。其中 ProcessRequest，從名字(處理請(qǐng)求)看就知道這里應(yīng)該放置我們處理請(qǐng)求的主要代碼。
IsReusable屬性，MSDN上是這樣解釋的：獲取一個(gè)值，該值指示其他請(qǐng)求是否可以使用 IHttpHandler 實(shí)例。也就是說后繼的Http請(qǐng)求是不是可以繼續(xù)使用實(shí)現(xiàn)了該接口的類的實(shí)例，一般來說，我把它設(shè)置成true。
那么實(shí)現(xiàn)此接口的類形式應(yīng)該是這樣的：
public class CustomHandler : IHttpHandler{
??? public void ProcessRequest(HttpContext context)? {
?????? // 處理請(qǐng)求的代碼
??? }
??? public bool IsReusable {
?????? get { return true; }
??? }
}
而為了能使用這個(gè)自定義的HttpHandler，我們需要在應(yīng)用程序目錄下的Web.config中注冊(cè)它。
?<system.web>
??? <httpHandlers>
????? <add path="*.jpg" verb="*" type="MyNameSpace.MyClass, MyDllName" />
??? </httpHandlers>
?</system.web>
應(yīng)該發(fā)現(xiàn)這與之前在C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG\目錄下web.config中看到的幾乎完全一樣。這里，path指的是請(qǐng)求的文件名稱，可以使用通配符擴(kuò)大范圍，也可以明確指定這個(gè)handler僅用于處理某個(gè)特定的文件(比如說：filename.aspx)的請(qǐng)求。verb指的是請(qǐng)求此文件的方式，可以是post或get，用*代表所有訪問方式。type屬性由“,”分隔成兩部分，第一部分是實(shí)現(xiàn)了接口的類名，第二部分是位于Bin目錄下的編譯過的程序集名稱。
NOTE：如果你新建一個(gè)項(xiàng)目，并且在項(xiàng)目下創(chuàng)建HandlerTest.cs，然后讓站點(diǎn)引用該項(xiàng)目，那么在生成解決方案的時(shí)候會(huì)自動(dòng)將編譯好的.dll文件添到Bin目錄中。
??? NOTE：MyDll只寫程序集名，不要加后面的.dll。
使用HttpHandler實(shí)現(xiàn)圖片防盜鏈
有了之前這么多的準(zhǔn)備知識(shí)，實(shí)現(xiàn)現(xiàn)在的目標(biāo)就容易得多了：
NOTE：這個(gè)例子，以及下面的一個(gè)例子均來自于《Maximizing ASP.NET Real World, Object-Oriented Development》一書：
Step.1：創(chuàng)建文件 CustomHandler.cs，代碼如下：
using System;
using System.Web;
namespace CustomHandler{
??? public class JpgHandler : IHttpHandler{
?????? public void ProcessRequest(HttpContext context){
?????????? // 獲取文件服務(wù)器端物理路徑
?????????? string FileName = context.Server.MapPath(context.Request.FilePath);
?????????? // 如果UrlReferrer為空，則顯示一張默認(rèn)的禁止盜鏈的圖片
?????????? if (context.Request.UrlReferrer.Host == null){
????????????? context.Response.ContentType = "image/JPEG";
????????????? context.Response.WriteFile("/error.jpg");
?????????? }else{
????????????? // 如果 UrlReferrer中不包含自己站點(diǎn)主機(jī)域名，則顯示一張默認(rèn)的禁止盜鏈的圖片
???????????? 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 編譯這個(gè)文件
csc /t:library /r:System.Web.dll CustomHandler.cs
Step.3 將編譯好的 CustomHandler.dll 拷貝到站點(diǎn)的 Bin 目錄下。
Step.4 在Web.Config 中注冊(cè)這個(gè)Handler。
<system.web>
??? <httpHandlers>
????? <add path="*.jpg" verb="*" type="CustomHandler.JpgHandler, CustomHandler" />
??? </httpHandlers>
?</system.web>
OK，諸位可以按步驟自行測(cè)試一下，這里就不贅述了。
通過IhttpHandler實(shí)現(xiàn)圖片驗(yàn)證碼
也可以在一個(gè).ashx文件中實(shí)現(xiàn)IHttpHandler，而不是采用這種提前編譯的方式。
Step.1 打開Vs2005，“添加新項(xiàng)”，“一般處理程序”。新建文件后，VS會(huì)自動(dòng)在文件中添加如下的代碼：
<%@ 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對(duì)象，繪圖
?????? 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();
??????
?????? //添加隨機(jī)的五個(gè)字母
?????? 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();?? //如果沒有實(shí)現(xiàn)IRequiresSessionState，則這里會(huì)出錯(cuò)，也無法生成圖片
?????? context.Response.End();?????
??? }
??? public bool IsReusable {
?????? get { return true; }
??? }
}
需要特別注意的是，Handler類不僅需要實(shí)現(xiàn) IHttpHandler接口(這個(gè)顯然)，為了在這個(gè)Handler類中使用SessionState，還需要實(shí)現(xiàn)IRequiresSessionState接口，對(duì)于這個(gè)接口，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.(翻譯過來是：指定當(dāng)前Http Handler需要對(duì)SessionState值的讀寫訪問權(quán)。這是一個(gè)標(biāo)記接口，沒有任何方法)。
而實(shí)際上，IRequiresSessionState的接口定義是這樣的：
public interface IRequiresSessionState{}
可見，這個(gè)接口沒有任何需要實(shí)現(xiàn)的方法或?qū)傩?#xff0c;大家只要記得：如果想在HttpHandler中使用SessionState，必須實(shí)現(xiàn)這個(gè)接口，實(shí)際上也就是在類的標(biāo)頭將這個(gè)接口加進(jìn)去。
Step.3 新建一個(gè)ImageCode.aspx頁面，在HTML代碼中寫下：
<img src="Handler.ashx" alt="圖片驗(yàn)證碼" />
OK，在瀏覽器中打開ImageCode.aspx，應(yīng)該可以看到如下所示：
利用HttpHandler創(chuàng)建自定義后綴Rss源
RSS如今已經(jīng)可以說是隨處可見，而RSS的實(shí)現(xiàn)方式，通常是在一個(gè).aspx的CodeBehind文件中寫一個(gè)XML文件，然后加載到Response的OutputStream中， Rss源通常是Rss.aspx這種形式的。通過第一章學(xué)到的ISAPI的知識(shí)，再結(jié)合本章學(xué)到的關(guān)于HttpHandler的知識(shí)，很容易想到：我們可以自定一個(gè)以 .rss 作為后綴名的文件來實(shí)現(xiàn) Rss 源，比如說Article.rss?，F(xiàn)在我們就一步步來實(shí)現(xiàn)它：
NOTE：關(guān)于RSS的更多內(nèi)容，可以參閱我編譯的 在Web站點(diǎn)中創(chuàng)建和使用RSS源。本文不再解釋Rss是什么，如何創(chuàng)建Rss源，為了文章的獨(dú)立性，僅給出創(chuàng)建過程。
Step.1 創(chuàng)建范例數(shù)據(jù)庫
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)
)
-- 插入范例數(shù)據(jù)
Insert Into RssSample(Title, Author, [Description], Link)
Values('標(biāo)題1', '作者1', '文章摘要1', 'http://127.0.0.1/#' )
-- 省略 ....
Step.2 建立站點(diǎn)，在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");?????? //修改這里成你的數(shù)據(jù)庫連接
?????????? 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 下的結(jié)點(diǎn)靜態(tài)寫入
?????????? writer.WriteElementString("title", "TraceFact.Net 技術(shù)文章");
?????????? 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 結(jié)點(diǎn)從數(shù)據(jù)庫讀取
?????????? 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();
?????????? // 將流轉(zhuǎn)換成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 創(chuàng)建可以處理 .rss 后綴名的 RssHandler
我們?cè)谶@個(gè) RssFeedsLib命名空間下，再添加一個(gè)類，這個(gè)類用于處理對(duì) .rss 后綴名文件的Http請(qǐng)求。
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中進(jìn)行配置
<httpHandlers>
??? <add path="*.rss" type="RssFeadsLib.RSSHandler" verb="GET" />
</httpHandlers>
?
NOTE：因?yàn)檫@個(gè)類和命名空間位于App_Code中，這里就不需要再手動(dòng)編譯RssFeadsLib.cs然后將編譯好的.dll應(yīng)用程序集放到Bin目錄中了。至于為什么可以這樣，將會(huì)在 《Asp.Net 構(gòu)架與安全機(jī)制 Part.5 – 頁面生存周期與編譯模型》中解釋。
Step.5 在IIS 對(duì)ISAPI進(jìn)行設(shè)置。
應(yīng)該還記得在Part.1中如何在IIS中設(shè)置ISAPI來進(jìn)行文件與處理程序映射：
進(jìn)行了這些設(shè)置以后，現(xiàn)在IIS就知道如何去處理對(duì).rss后綴名文件的請(qǐng)求了。
Step.6 測(cè)試范例
這個(gè)時(shí)候，隨便打開一個(gè)頁面，比如空白的Default.aspx，然后我們?cè)诘刂窓趯⑽募臑?#xff1a;Article.rss(改成abc.rss也是一樣)，敲回車，應(yīng)該可以看到如下的畫面。
IHttpHandlerFactory 概述
現(xiàn)在假設(shè)我們有這樣的需求，我們不僅想要處理 .rss 后綴名，還想要能夠處理 .atom后綴名，假設(shè)處理atom的類命名為AtomHandler，那么我們的Web.config該如何設(shè)置呢？我想應(yīng)該是這樣的：
<httpHandlers>
<add path="*.rss" type="RssFeadsLib.RSSHandler" verb="GET" />
<add path="*.atom" type="RssFeadsLib.AtomHandler" verb="GET" />
</httpHandlers>
如果我們有很多個(gè)HttpHandler分別映射不同后綴名的請(qǐng)求，這樣我們的Web.config會(huì)變得很冗長(zhǎng)，或者，我們只有在程序運(yùn)行時(shí)才能確切地知道使用哪個(gè)Handler，這個(gè)時(shí)候，可以考慮實(shí)現(xiàn) IHttpHandlerFactory來完成這一過程。
IHttpHandlerFactory的定義是這樣的：
public interface IHttpHandlerFactory{
??? IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated);
??? void ReleaseHandler(IHttpHandler handler);
}
可見，需要實(shí)現(xiàn)兩個(gè)方法，分別是 GetHandler() 和 ReleaseHandler()。
- GetHandler()，返回實(shí)現(xiàn)了IHttpHandler接口的類的實(shí)例。
- ReleaseHandler()，使得Factory可以重復(fù)使用一個(gè)已經(jīng)存在的Handler實(shí)例。
對(duì)于上面 .atom 和 .rss 的問題，我們可以這樣來實(shí)現(xiàn) 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){
??? }
}
這時(shí)，在Web.Config 中<system.web>節(jié)點(diǎn)下進(jìn)行如下設(shè)置即可：
<httpHandlers>
<add path="*.rss,*.atom" type=" RssFeadsLib.HandlerFactory" verb="GET" />
</httpHandlers>
但是，這不能簡(jiǎn)化IIS中ISAPI的設(shè)置，還是需要手動(dòng)去對(duì).rss和.atom分別設(shè)置。
總結(jié)
在本文中，我們首先討論了aspnet_isapi.dll 如何將對(duì)不同后綴名文件的請(qǐng)求分發(fā)給相應(yīng)的處理程序，如何查看Framework默認(rèn)的處理程序Handler。
然后，我們通過三個(gè)實(shí)例，圖片防盜鏈、圖片驗(yàn)證碼、處理自定義后綴名請(qǐng)求，詳細(xì)講解了IHttpHandler的實(shí)現(xiàn)方法和使用過程。
最后，我向大家概要地介紹了IHttpHandlerFactory接口。
轉(zhuǎn)載于:https://www.cnblogs.com/millen/archive/2009/12/16/1625266.html
總結(jié)
以上是生活随笔為你收集整理的Http Handler 介绍(转)的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： linux之cp/scp命令＋scp命令
- 下一篇： 多线程编程之四——线程的同步