IHttpModule向实现类提供模块初始化和处置事件。
IHttpModule包含兩個方法:
public void Init(HttpApplication context);
public void
Dispose();
Init():这个方法接受一个HttpApplication对象,HttpApplication代表了当前的应用程序,我们需要在这个方法内注册
HttpApplication对象暴露给客户端的事件。可见,这个方法仅仅是用来对事件进行注册,而实际的事件处理程序,需要我们另外写方法。
整个过程很好理解:
1.
当站点第一个资源被访问的时候,Asp.Net会创建HttpApplication类的实例,它代表着站点应用程序,同时会创建所有在Web.Config中注册过的Module实例。
2.
在创建Module实例的时候会调用Modul的Init()方法。
3.
在Init()方法内,对想要作出响应的HttpApplication暴露出的事件进行注册。(仅仅进行方法的简单注册,实际的方法需要另写)。
4.
HttpApplication在其应用程序周期中触发各类事件。
5.
触发事件的时候调用Module在其Init()方法中注册过的方法。
Dispose():它可以在进行垃圾回收之前进行一些清理工作。
public class ModuleDemo:IHttpModule
{
public void
Init(HttpApplication context) {
// 注册HttpApplication应用程序 BeginRequest 事件
// 也可以是其他任何HttpApplication暴露出的事件
context.BeginRequest += new
EventHandler(context_BeginRequest);
}
void
context_BeginRequest(object sender, EventArgs e) {
HttpApplication
application = (HttpApplication)sender;
HttpContext context =
application.Context;
// 做些实际的工作,HttpContext对象都获得了,剩下的基本可以自由发挥了
}
public
void Dispose() {
}
}
通过Http Module向Http请求输出流中写入文字
本例中,我们仅用BeginRequest事件和 EndRequest 事件对 Http Module
的使用作以说明。我们通过这个范例,了解 Http Module 基本的使用方法。
首先,请创建一个新的站点,在App_Code目录中添加类文件:
ModuleDemo.cs:
public class ModuleDemo:IHttpModule
{
// Init方法仅用于给期望的事件注册方法
public void
Init(HttpApplication context) {
context.BeginRequest += new
EventHandler(context_BeginRequest);
context.EndRequest += new
EventHandler(context_EndRequest);
}
// 处理BeginRequest 事件的实际代码
void context_BeginRequest(object
sender, EventArgs e) {
HttpApplication application =
(HttpApplication)sender;
HttpContext context =
application.Context;
context.Response.Write("<h1
style='color:#00f'>来自HttpModule 的处理,请求到达</h1><hr>");
}
// 处理EndRequest 事件的实际代码
void context_EndRequest(object
sender, EventArgs e) {
HttpApplication application =
(HttpApplication)sender;
HttpContext context =
application.Context;
context.Response.Write("<hr><h1
style='color:#f00'>来自HttpModule的处理,请求结束</h1>");
}
public void Dispose() {
}
}
上面的代码很简单,它注册了 HttpApplication实例的 BeginRequest 事件 和
EndRequest事件,事件处理方法的作用仅仅是在http请求开始和结束的时候,给http请求的输入流中分别写入不同的内容。
接下来在 Web.config 的 System.web 结点中写入以下内容:
<system.web>
<httpModules>
<add
name="MyModule" type="ModuleDemo" />
</httpModules>
</system.web>
在这册我们自己的http module
时,假设类名为ModuleDemo,位于myNameSpace命名空间下,程序集名称为myDll,我们只需将myDll.dll拷贝到Bin目录下,并在站点的
web.config 文件 system.web 结点下创建 httpModules 结点:
<system.web>
<httpModules>
<add
name="CustomModuleName" type="myNameSpace.ModuleDemo, myDll"/>
</httpModules>
</system.web>
type属性由分号“,”分为两部分,前面是命名空间及类名,也就是类型名;后面是程序集名。如果我们将代码创建在App_Code目录中,则不需要再指定程序集名。
name属性由我们自己命名,不一定与类名相同,此处我将它命名为“CustomModuleName”。我们可以通过应用程序(HttpApplication)
的Modules属性获取HttpModuleCollection集合,然后通过name属性,进一步获取HttpModule对象。
通过name属性,我们还可以在global.asax中文件中编写自定义HttpModule暴露出的事件的处理程序,它采用的格式是:void
ModuleName_EventName(object sender, EventArgs e)。