Http Handler 介绍

导读：

　　

　　引言

　　在Part.1中，我们了解了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中却有。 <br><br>　　找到httpHandlers结点，应该可以看到如下这样的代码(做了省略)： <br><br>　　<httphandlers><br><br>　　... ... <br><br>　　<add validate="True" type="System.Web.HttpNotFoundHandler" verb="*" path="*.axd"><br><br>　　<add validate="True" type="System.Web.UI.PageHandlerFactory" verb="*" path="*.aspx"><br><br>　　<add validate="True" type="System.Web.UI.SimpleHandlerFactory" verb="*" path="*.ashx"><br><br>　　<add validate="True" type="System.Web.HttpForbiddenHandler" verb="*" path="*.asax"><br><br>　　<add validate="True" type="System.Web.HttpForbiddenHandler" verb="*" path="*.ascx"><br><br>　　<add validate="True" type="System.Web.HttpForbiddenHandler" verb="*" path="*.config"><br><br>　　<add validate="True" type="System.Web.HttpForbiddenHandler" verb="*" path="*.cs"><br><br>　　<add validate="True" type="System.Web.DefaultHttpHandler" verb="GET,HEAD,POST" path="*"><br><br>　　... ... <br><br>　　</add><br><br>　　可以看到，在<httphandlers>结点中将不同的文件类型映射给不同的Handler去处理，对于.aspx来说，是由System.Web.UI.PageHandlerFactory来处理。而对于.cs来说，是由System.Web.HttpForbiddenHandler 处理，从ForbiddenHandler名字中出现的Forbidden (翻译过来是“禁止”)可以看出，这个Handler可以避免我们的源码被看到。 <br><br>　　<strong>NOTE</strong><strong>：</strong>System.Web.UI.PageHandlerFactory 是一个IHttpHandlerFactory，而不是一个单一的HttpHandler，IHttpHandlerFactory用来做什么后面会说明。 <br><br>　　上面列出的是.Net Framework在处理Http请求时的所采用的默认Handler。而如果我们要用编程的方式来操控一个Http请求，我们就需要实现IHttpHandler接口，来定制我们自己的需求。 <br><br>　　IHttpHandler的定义是这样的： <br><br>　　public interface IHttpHandler{ <br><br>　　void ProcessRequest(HttpContext context); <br><br>　　bool IsReusable { get; } <br><br>　　} <br><br>　　 <br><br>　　由上面可以看出IHttpHandler要求实现一个方法和一个属性。其中ProcessRequest，从名字(处理请求)看就知道这里应该放置我们处理请求的主要代码。 <br><br>　　IsReusable属性，MSDN上是这样解释的：获取一个值，该值指示其他请求是否可以使用IHttpHandler 实例。也就是说后继的Http请求是不是可以继续使用实现了该接口的类的实例，一般来说，我把它设置成true。 <br><br>　　那么实现此接口的类形式应该是这样的： <br><br>　　public class CustomHandler : IHttpHandler{ <br><br>　　public void ProcessRequest(HttpContext context) { <br><br>　　// 处理请求的代码 <br><br>　　} <br><br>　　public bool IsReusable { <br><br>　　get { return true; } <br><br>　　} <br><br>　　} <br><br>　　而为了能使用这个自定义的HttpHandler，我们需要在应用程序目录下的Web.config中注册它。 <br><br>　　<system.web><br><br>　　<httphandlers><br><br>　　<add type="MyNameSpace.MyClass, MyDllName" verb="*" path="*.jpg"><br><br>　　</add><br><br>　　</httphandlers><br><br>　　应该发现这与之前在C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG\目录下web.config中看到的几乎完全一样。这里，path指的是请求的文件名称，可以使用通配符扩大范围，也可以明确指定这个handler仅用于处理某个特定的文件(比如说：filename.aspx)的请求。verb指的是请求此文件的方式，可以是post或get，用*代表所有访问方式。type属性由“,”分隔成两部分，第一部分是实现了接口的类名，第二部分是位于Bin目录下的编译过的程序集名称。 <br><br>　　<strong>NOTE</strong><strong>：</strong>如果你新建一个项目，并且在项目下创建HandlerTest.cs，然后让站点引用该项目，那么在生成解决方案的时候会自动将编译好的.dll文件添到Bin目录中。 <br><br>　　<strong>NOTE</strong><strong>：</strong>MyDll只写程序集名，不要加后面的.dll。 <br><br>　　使用HttpHandler实现图片防盗链 <br><br>　　有了之前这么多的准备知识，实现现在的目标就容易得多了： <br><br>　　<strong>NOTE</strong><strong>：</strong>这个例子，以及下面的一个例子均来自于《Maximizing ASP.NET Real World, Object-Oriented Development》一书： <br><br>　　Step.1：创建文件CustomHandler.cs，代码如下： <br><br>　　using System; <br><br>　　using System.Web; <br><br>　　 <br><br>　　namespace CustomHandler{ <br><br>　　public class JpgHandler : IHttpHandler{ <br><br>　　public void ProcessRequest(HttpContext context){ <br><br>　　// 获取文件服务器端物理路径 <br><br>　　string FileName = context.Server.MapPath(context.Request.FilePath); <br><br>　　// 如果UrlReferrer为空，则显示一张默认的禁止盗链的图片 <br><br>　　if (context.Request.UrlReferrer.Host == null){ <br><br>　　context.Response.ContentType = "image/JPEG"; <br><br>　　context.Response.WriteFile("/error.jpg"); <br><br>　　}else{ <br><br>　　// 如果UrlReferrer中不包含自己站点主机域名，则显示一张默认的禁止盗链的图片 <br><br>　　if (context.Request.UrlReferrer.Host.IndexOf("yourdomain.com") &gt;0){ <br><br>　　context.Response.ContentType = "image/JPEG"; <br><br>　　context.Response.WriteFile(FileName); <br><br>　　}else{ <br><br>　　context.Response.ContentType = "image/JPEG"; <br><br>　　context.Response.WriteFile("/error.jpg"); <br><br>　　} <br><br>　　} <br><br>　　} <br><br>　　 <br><br>　　public bool IsReusable{ <br><br>　　get{ return true; } <br><br>　　} <br><br>　　} <br><br>　　} <br><br>　　Step.2 编译这个文件 <br><br>　　csc /t:library /r:System.Web.dll CustomHandler.cs <br><br>　　Step.3 将编译好的CustomHandler.dll 拷贝到站点的Bin 目录下。 <br><br>　　Step.4 在Web.Config 中注册这个Handler。 <br><br>　　<system.web><br><br>　　<httphandlers><br><br>　　<add type="CustomHandler.JpgHandler, CustomHandler" verb="*" path="*.jpg"><br><br>　　</add><br><br>　　</httphandlers><br><br>　　 <br><br>　　OK，诸位可以按步骤自行测试一下，这里就不赘述了。 <br><br>　　通过IhttpHandler实现图片验证码 <br><br>　　也可以在一个.ashx文件中实现IHttpHandler，而不是采用这种提前编译的方式。 <br><br>　　Step.1 打开Vs2005，“添加新项”，“一般处理程序”。新建文件后，VS会自动在文件中添加如下的代码： <br><br>　　&lt;%@ WebHandler Language="C#" Class="Handler" %&gt; <br><br>　　 <br><br>　　using System; <br><br>　　using System.Web; <br><br>　　 <br><br>　　public class Handler : IHttpHandler { <br><br>　　public void ProcessRequest (HttpContext context) { <br><br>　　context.Response.ContentType = "text/plain"; <br><br>　　context.Response.Write("Hello World"); <br><br>　　} <br><br>　　 <br><br>　　public bool IsReusable { <br><br>　　get { <br><br>　　return false; <br><br>　　} <br><br>　　} <br><br>　　} <br><br>　　Step.2 将代码改写成如下所示： <br><br>　　&lt;%@ WebHandler Language="C#" Class="Handler" %&gt; <br><br>　　 <br><br>　　using System; <br><br>　　using System.Drawing; <br><br>　　using System.Drawing.Imaging; <br><br>　　using System.Text; <br><br>　　using System.Web; <br><br>　　using System.Web.SessionState; <br><br>　　 <br><br>　　public class Handler : IHttpHandler, IRequiresSessionState { <br><br>　　 <br><br>　　public void ProcessRequest(HttpContext context) { <br><br>　　context.Response.ContentType = "image/gif"; <br><br>　　//建立Bitmap对象，绘图 <br><br>　　Bitmap basemap = new Bitmap(200, 60); <br><br>　　Graphics graph = Graphics.FromImage(basemap); <br><br>　　graph.FillRectangle(new SolidBrush(Color.White), 0, 0, 200, 60); <br><br>　　Font font = new Font(FontFamily.GenericSerif, 48, FontStyle.Bold, GraphicsUnit.Pixel); <br><br>　　Random r = new Random(); <br><br>　　string letters = "ABCDEFGHIJKLMNPQRSTUVWXYZ"; <br><br>　　string letter; <br><br>　　StringBuilder s = new StringBuilder(); <br><br>　　 <br><br>　　//添加随机的五个字母 <br><br>　　for (int x = 0; x &lt;5; x++) { <br><br>　　letter = letters.Substring(r.Next(0, letters.Length - 1), 1); <br><br>　　s.Append(letter); <br><br>　　graph.DrawString(letter, font, new SolidBrush(Color.Black), x * 38, r.Next(0, 15)); <br><br>　　} <br><br>　　 <br><br>　　//混淆背景 <br><br>　　Pen linePen = new Pen(new SolidBrush(Color.Black), 2); <br><br>　　for (int x = 0; x &lt;6; x++) <br><br>　　graph.DrawLine(linePen, new Point(r.Next(0, 199), r.Next(0, 59)), new Point(r.Next(0, 199), r.Next(0, 59))); <br><br>　　 <br><br>　　//将图片保存到输出流中 <br><br>　　basemap.Save(context.Response.OutputStream, ImageFormat.Gif); <br><br>　　context.Session["CheckCode"] = s.ToString(); //如果没有实现IRequiresSessionState，则这里会出错，也无法生成图片 <br><br>　　context.Response.End(); <br><br>　　} <br><br>　　 <br><br>　　public bool IsReusable { <br><br>　　get { return true; } <br><br>　　} <br><br>　　} <br><br>　　需要特别注意的是，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值的读写访问权。这是一个标记接口，没有任何方法)。 <br><br>　　而实际上，IRequiresSessionState的接口定义是这样的： <br><br>　　public interface IRequiresSessionState <br><br>　　{ <br><br>　　} <br><br>　　可见，这个接口没有任何需要实现的方法或属性，大家只要记得：<strong>如果想在</strong><strong>HttpHandler</strong><strong>中使用</strong><strong>SessionState</strong><strong>，必须实现这个接口，实际上也就是在类的标头将这个接口加进去。</strong> <br><br>　　Step.3 新建一个ImageCode.aspx页面，在HTML代码中写下： <br><br>　　<img src="http://ds.hylanda.com/Handler.ashx" alt=""><br>　　OK，在浏览器中打开ImageCode.aspx，应该可以看到如下所示： <br><br>　　<img src="http://www.tracefact.net/graph/Architecture_2/01.gif" alt=""><br><br>　　 <br><br>　　利用HttpHandler创建自定义后缀Rss源 <br><br>　　RSS如今已经可以说是随处可见，而RSS的实现方式，通常是在一个.aspx的CodeBehind文件中写一个XML文件，然后加载到Response的OutputStream中， Rss源通常是Rss.aspx这种形式的。通过第一章学到的ISAPI的知识，再结合本章学到的关于HttpHandler的知识，很容易想到：我们可以自定一个以.rss 作为后缀名的文件来实现Rss 源，比如说Article.rss。现在我们就一步步来实现它： <br><br>　　<strong>NOTE</strong><strong>：</strong>关于RSS的更多内容，可以参阅我编译的《在Web站点中创建和使用RSS源》。本文不再解释Rss是什么，如何创建Rss源，为了文章的独立性，仅给出创建过程。 <br><br>　　Step.1 创建范例数据库 <br><br>　　Create Table RssSample <br><br>　　( <br><br>　　SampleId Int Identity(1,1) Not Null, <br><br>　　Title Varchar(100) Not Null Constraint uq_Title Unique, <br><br>　　Author Varchar(50) Not Null, <br><br>　　PubDate DateTime Not Null Default GetDate(), <br><br>　　[Description] Varchar(500) Not Null, <br><br>　　Link Varchar(150) Not Null <br><br>　　 <br><br>　　Constraint pk_RssSample Primary Key(SampleId) <br><br>　　) <br><br>　　-- 插入范例数据 <br><br>　　Insert Into RssSample(Title, Author, [Description], Link) <br><br>　　Values('标题1', '作者1', '文章摘要1', 'http://127.0.0.1/#' ) <br><br>　　 <br><br>　　-- 省略.... <br><br>　　Step.2 建立站点，在App_Code目录下建立RssFeedsLib.cs文件。 <br><br>　　using System; <br><br>　　using System.Data; <br><br>　　using System.Data.SqlClient; <br><br>　　using System.IO; <br><br>　　using System.Web; <br><br>　　using System.Xml; <br><br>　　using System.Text; <br><br>　　 <br><br>　　namespace RssFeadsLib { <br><br>　　public class RssGenerator { <br><br>　　public static string GetRSS() { <br><br>　　MemoryStream ms = new MemoryStream(); <br><br>　　XmlTextWriter writer = new XmlTextWriter(ms, null); <br><br>　　SqlConnection conn = new SqlConnection("Data Source=.;Initial Catalog=Sample;User ID=sa;Password=sa"); //修改这里成你的数据库连接 <br><br>　　SqlCommand cmd = new SqlCommand("select * from RssSample order by pubdate desc", conn); <br><br>　　 <br><br>　　conn.Open(); <br><br>　　SqlDataReader reader = cmd.ExecuteReader(); <br><br>　　writer.WriteStartElement("rss"); <br><br>　　writer.WriteAttributeString("version", "2.0"); <br><br>　　writer.WriteStartElement("channel"); <br><br>　　// Channel 下的结点静态写入 <br><br>　　writer.WriteElementString("title", "TraceFact.Net 技术文章"); <br><br>　　writer.WriteElementString("link", "http://www.tracefact.net"); <br><br>　　writer.WriteElementString("description", "Dedicated to asp.net..."); <br><br>　　writer.WriteElementString("copyright", "Copyright (C) 2007"); <br><br>　　writer.WriteElementString("generator", "My RSS Generator"); <br><br>　　// Item 结点从数据库读取 <br><br>　　while (reader.Read()) { <br><br>　　writer.WriteStartElement("item"); <br><br>　　writer.WriteElementString("author", reader.GetString(reader.GetOrdinal("Author"))); <br><br>　　writer.WriteElementString("title", reader.GetString(reader.GetOrdinal("title"))); <br><br>　　writer.WriteElementString("link", reader.GetString(reader.GetOrdinal("Link"))); <br><br>　　writer.WriteElementString("description", reader.GetString(reader.GetOrdinal("Description"))); <br><br>　　writer.WriteElementString("pubDate", reader.GetDateTime(reader.GetOrdinal("PubDate")).ToString(@"ddd, dd MMM yyyy 12:00:00 tt ")); <br><br>　　writer.WriteEndElement(); <br><br>　　} <br><br>　　 <br><br>　　writer.WriteEndElement(); <br><br>　　writer.WriteEndElement(); <br><br>　　reader.Close(); <br><br>　　conn.Close(); <br><br>　　 <br><br>　　writer.BaseStream.Flush(); <br><br>　　writer.Flush(); <br><br>　　ms.Flush(); <br><br>　　 <br><br>　　// 将流转换成String并返回 <br><br>　　byte[] data = new byte[ms.Length]; <br><br>　　ms.Seek(0, SeekOrigin.Begin); <br><br>　　ms.Read(data, 0, data.Length); <br><br>　　ms.Close(); <br><br>　　return UTF8Encoding.UTF8.GetString(data); <br><br>　　} <br><br>　　} <br><br>　　} <br><br>　　Step.3 创建可以处理.rss 后缀名的RssHandler <br><br>　　我们在这个RssFeedsLib命名空间下，再添加一个类，这个类用于处理对.rss 后缀名文件的Http请求。 <br><br>　　public class RSSHandler:IHttpHandler{ <br><br>　　public bool IsReusable <br><br>　　{ <br><br>　　get {return false;} <br><br>　　} <br><br>　　 <br><br>　　public void ProcessRequest(HttpContext context){ <br><br>　　context.Response.ContentType = "text/xml"; <br><br>　　string str = RssGenerator.GetRSS(); <br><br>　　context.Response.Write(str); <br><br>　　} <br><br>　　} <br><br>　　Step.4 在Web.config中进行配置 <br><br>　　<httphandlers><br><br>　　<add verb="GET" type="RssFeadsLib.RSSHandler" path="*.rss"><br><br>　　</add><br><br>　　 <br><br>　　<strong>NOTE</strong><strong>：</strong>因为这个类和命名空间位于App_Code中，这里就不需要再手动编译RssFeadsLib.cs然后将编译好的.dll应用程序集放到Bin目录中了。至于为什么可以这样，将会在 《Asp.Net 构架与安全机制Part.5 –页面生存周期与编译模型》中解释。 <br><br>　　Step.5 在IIS 对ISAPI进行设置。 <br><br>　　应该还记得在Part.1中如何在IIS中设置ISAPI来进行文件与处理程序映射： <br><br>　　1. 打开IIS，选择本范例所用的站点，右键，选择“属性”。 <br><br>　　2. 选择“主目录”选项卡，点击“配置...”按钮。 <br><br>　　3. 点击“添加”，设置“可执行文件”为“C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\aspnet_isapi.dll”，设置“扩展名”为“.rss”，点“确定”。 <br><br>　　4. 注意，不要勾选“检查文件是否存在”复选框，这样不用创建文件，只要在地址栏输入任意以.rss后缀结尾的文件名，均会交由上面创建的Handler去处理，而不管这个文件是否存在，也不管请求的是Article.rss还是Sample.rss。 <br><br>　　进行了这些设置以后，现在IIS就知道如何去处理对.rss后缀名文件的请求了。 <br><br>　　Step.6 测试范例 <br><br>　　这个时候，随便打开一个页面，比如空白的Default.aspx，然后我们在地址栏将文件改为：Article.rss(改成abc.rss也是一样)，敲回车，应该可以看到如下的画面。 <br><br>　　<img src="http://www.tracefact.net/graph/Architecture_2/02.gif" alt=""><br><br>　　 <br><br>　　IHttpHandlerFactory 概述 <br><br>　　现在假设我们有这样的需求，我们不仅想要处理.rss 后缀名，还想要能够处理.atom后缀名，假设处理atom的类命名为AtomHandler，那么我们的Web.config该如何设置呢？我想应该是这样的： <br><br>　　<httphandlers><br><br>　　<add verb="GET" type="RssFeadsLib.RSSHandler" path="*.rss"><br><br>　　<add verb="GET" type="RssFeadsLib.AtomHandler" path="*.atom"><br><br>　　</add><br><br>　　如果我们有很多个HttpHandler分别映射不同后缀名的请求，这样我们的Web.config会变得很冗长，或者，我们只有在程序运行时才能确切地知道使用哪个Handler，这个时候，可以考虑实现IHttpHandlerFactory来完成这一过程。 <br><br>　　IHttpHandlerFactory的定义是这样的： <br><br>　　public interface IHttpHandlerFactory{ <br><br>　　IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated); <br><br>　　void ReleaseHandler(IHttpHandler handler); <br><br>　　} <br><br>　　可见，需要实现两个方法，分别是GetHandler() 和ReleaseHandler()。 <br><br>　　l GetHandler()，返回实现了IHttpHandler接口的类的实例。 <br><br>　　l ReleaseHandler()，使得Factory可以重复使用一个已经存在的Handler实例。 <br><br>　　对于上面.atom 和.rss 的问题，我们可以这样来实现IHttpHandlerFactory接口： <br><br>　　class HandlerFactory:IHttpHandlerFactory{ <br><br>　　public IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated){ <br><br>　　string path = context.Request.PhysicalPath; <br><br>　　if (Path.GetExtension(path) == ".rss"){ <br><br>　　return new RSSHandler(); <br><br>　　} <br><br>　　 <br><br>　　if (Path.GetExtension(path) == ".atom"){ <br><br>　　return new ATOMHandler(); <br><br>　　} <br><br>　　return null; <br><br>　　} <br><br>　　 <br><br>　　public void ReleaseHandler(IHttpHandler handler){ <br><br>　　} <br><br>　　} <br><br>　　这时，在Web.Config 中<system.web>节点下进行如下设置即可： <br><br>　　<httphandlers><br><br>　　<add verb="GET" type=" RssFeadsLib.HandlerFactory" path="*.rss,*.atom"><br><br>　　</add><br><br>　　但是，这不能简化IIS中ISAPI的设置，还是需要手动去对.rss和.atom分别设置。 <br><br>　　总结 <br><br>　　在本文中，我们首先讨论了aspnet_isapi.dll如何将对不同后缀名文件的请求分发给相应的处理程序，如何查看Framework默认的处理程序Handler。 <br><br>　　然后，我们通过三个实例，图片防盗链、图片验证码、处理自定义后缀名请求，详细讲解了IHttpHandler的实现方法和使用过程。 <br><br>　　最后，我向大家概要地介绍了IHttpHandlerFactory接口。 <br><br>　　希望这篇文章能给你带来帮助。 <br><br><br><br>本文转自 <br><br><a href="http://www.cnblogs.com/JimmyZhang/archive/2007/09/15/894124.html">http://www.cnblogs.com/JimmyZhang/archive/2007/09/15/894124.html</a> <br></httphandlers></system.web></add></httphandlers></httphandlers></system.web></system.web></httphandlers></add></add></add></add></add></add></add></httphandlers></httphandlers>