HttpModule的認識

於為源發表於2015-10-29

HttpModule是向實現類提供模組初始化和處置事件。當一個HTTP請求到達HttpModule時，整個ASP.NET Framework系統還並沒有對這個HTTP請求做任何處理，也就是說此時對於HTTP請求來講，HttpModule是一個HTTP請求的“必經之路”，所以可以在這個HTTP請求傳遞到真正的請求處理中心（HttpHandler）之前附加一些需要的資訊在這個HTTP請求資訊之上，或者針對截獲的這個HTTP請求資訊作一些額外的工作，或者在某些情況下乾脆終止滿足一些條件的HTTP請求，從而可以起到一個Filter過濾器的作用。

1、asp.net的HTTP請求處理過程

說明：
（1）、客戶端瀏覽器向伺服器發出一個http請求，此請求會被inetinfo.exe程式截獲，然後轉交給aspnet_isapi.dll程式，接著它又通過Http Pipeline的管道，傳送給aspnet_wp.exe這個程式，接下來就到了.net framework的HttpRunTime處理中心，處理完畢後就傳送給使用者瀏覽器。
（2）、當一個http請求被送入到HttpRuntime之後，這個Http請求會繼續被送入到一個被稱之為HttpApplication Factory的一個容器當中，而這個容器會給出一個HttpApplication例項來處理傳遞進來的http請求，而後這個Http請求會依次進入到如下幾個容器中：HttpModule --> HttpHandler Factory --> HttpHandler。當系統內部的HttpHandler的ProcessRequest方法處理完畢之後，整個Http Request就被處理完成了，客戶端也就得到相應的東東了。
（3）完整的http請求在asp.net framework中的處理流程：
HttpRequest-->inetinfo.exe->ASPNET_ISAPI.DLL-->Http Pipeline-->ASPNET_WP.EXE-->HttpRuntime-->HttpApplication Factory-->HttpApplication-->HttpModule-->HttpHandler Factory-->HttpHandler-->HttpHandler.ProcessRequest()

也就是說一個HTTP請求在HttpModule容器的傳遞過程中，會在某一時刻（ResolveRequestCache事件）將這個HTTP請求傳遞給HttpHandler容器。在這個事件之後，HttpModule容器會建立一個HttpHandler的入口例項，但是此時並沒有將HTTP請求控制權交出，而是繼續觸發AcquireRequestState事件以及PreRequestHandlerExcute事件。在PreRequestHandlerExcute事件之後，HttpModule視窗就會將控制權暫時交給HttpHandler容器，以便進行真正的HTTP請求處理工作。

而在HttpHandler容器內部會執行ProcessRequest方法來處理HTTP請求。在容器HttpHandler處理完畢整個HTTP請求之後，會將控制權交還給HttpModule，HttpModule則會繼續對處理完畢的HTTP請求資訊流進行層層的轉交動作，直到返回到客戶端為止。
PS:紅色的HttpApplication例項在HttpModule的Init方法中會用到。

（4）如果想在中途截獲一個httpRequest並做些自己的處理，就應該在HttpRuntime執行時內部來做到這一點，確切的說是在HttpModule這個容器中來實現。

2、HttpModule工作原理

負責監聽HttpRequest，同時對HttpRequest增添或者過濾掉一部分內容。也就是說，當一個HTTP請求到達HttpModule時，整個ASP.NET Framework系統還並沒有對這個HTTP請求做任何處理，也就是說此時對於HTTP請求來講，HttpModule是一個HTTP請求的“必經之路”，所以可以在這個HTTP請求傳遞到真正的請求處理中心（HttpHandler）之前附加一些需要的資訊在這個HTTP請求資訊之上，或者針對截獲的這個HTTP請求資訊作一些額外的工作，或者在某些情況下乾脆終止滿足一些條件的HTTP請求，從而可以起到一個Filter過濾器的作用。
HttpModule實現了介面IHttpModule，我們可以自定義實現該介面的類，從而取代HttpModule。
asp.net預設的HttpModule如下：

        System.Web.SessionState.SessionStateModule;
        System.Web.Security.WindowsAuthenticationModule;
        System.Web.Security.FormsAuthenticationModule;
        System.Web.Security.PassportAuthenticationModule;
        System.Web.Security.UrlAuthorizationModule;
        System.Web.Security.FileAuthorizationModule;

3、編寫自己的HttpModule

要實現HttpModule，必須實現介面IHttpModule。下面是IHttpModule介面分析：

using System;
namespace System.Web
{
    public interface IHttpModule
    {
        //   銷燬不再被HttpModule使用的資源
        void Dispose();
        // 初始化一個Module,為捕獲HttpRequest做準備
        void Init(HttpApplication context);
    }
}

下面是自己的HttpModule：

using System;
using System.Web;
namespace ClassLibrary1
{
    public class MyHttpModule : IHttpModule
    {
        public void Dispose() { }
        public void Init(HttpApplication context)
        {
            context.BeginRequest += new EventHandler(Application_BeginRequest);
            context.EndRequest += new EventHandler(Application_EndRequest);
        }
        public void Application_BeginRequest(object sender, EventArgs e)
        {
            HttpApplication application = sender as HttpApplication;
            HttpContext context = application.Context;
            HttpResponse response = context.Response;
            response.Write("這是來自自定義HttpModule中有BeginRequest");
        }
        public void Application_EndRequest(object sender, EventArgs e)
        {
            HttpApplication application = sender as HttpApplication;
            HttpContext context = application.Context;
            HttpResponse response = context.Response;
            response.Write("這是來自自定義HttpModule中有EndRequest");
        }
    }
}

web.config

    <httpModules>
      <add name="myHttpModule" type="ClassLibrary1.MyHttpModule,ClassLibrary1"/>
    </httpModules>

default.aspx.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
public partial class _Default : System.Web.UI.Page 
{
    protected void Page_Load(object sender, EventArgs e)
    {
        Response.Write("<br/><br/>來自Default.aspx頁面<br/>");
    }
}

4、HttpModule內部事件機制和生命週期

HttpModule對HttpApplication例項進行處理，而HttpApplication有很多事件（對應不同的生命期），這樣就衍生出HttpModule內部事件機制和生命週期。
（1）、HttpModule的事件


BeginRequest	指示請求處理開始
AuthenticateRequest	封裝請求身份驗證過程
AuthorizeRequest	封裝檢查是否能利用以前快取的輸出頁面處理請求的過程
ResolveRequestCache	從快取中得到相應時候觸發
AcquireRequestState	載入初始化Session時候觸發
PreRequestHandlerExecute	在Http請求進入HttpHandler之前觸發
PostRequestHandlerExecute	在Http請求進入HttpHandler之後觸發
ReleaseRequestState	儲存Session狀態時候觸發
UpdateRequestCache	更新快取資訊時觸發
EndRequest	在Http請求處理完成的時候觸發
PreSendRequestHenaders	在向客戶端傳送Header之前觸發
PreSendRequestConternt	在向客戶端傳送內容之前觸發

說明：
a、BenginRequest和EndRequest分別是HttpModule容器最開始的和最後的事件；
b、EndRequest之後還會觸發PreSendRequestHeaders事件和PreSendRequestContent事件，這不是在HttpModule外的兩個事件，表示HttpModule結束，即將開始向Client傳送資料。

（2）、驗證HttpModule生命週期
與HttpHandler的互動：

說明：
a、HttpModule容器會將HttpRequest傳遞到HttpHandler容器，這個時間點是ResolveRequestCache事件
b、HttpModule容器會建立HttpHandler例項作為入口——Session從此生效
c、觸發AcquireRequestState事件以及PreRequestHandlerExecute事件
d、HttpModule容器便將對HttpRequest的控制權轉讓給HttpHandler容器
e、HttpHandler容器處理HttpRequest——使用自身的ProcessRequest方法，將對其控制權又還給HttpModule容器——之後Session失效。

驗證生命週期程式碼：

using System;
 

using System.Collections.Generic;
 

using System.Text;
 

using System.Web;
 

 

namespace MyHttpModule
 

{
 

    public class ValidaterHttpModuleEvents : IHttpModule
 

    {
 

 

        public void Dispose()
 

        { }
 

 

        /// <summary>
 

        /// 驗證HttpModule事件機制
 

        /// </summary>
 

        /// <param name="application"></param>
 

        public void Init(HttpApplication application)
 

        {
 

            application.BeginRequest += new EventHandler(application_BeginRequest);
 

            application.EndRequest += new EventHandler(application_EndRequest);
 

            application.AcquireRequestState += new EventHandler(application_AcquireRequestState);
 

            application.AuthenticateRequest += new EventHandler(application_AuthenticateRequest);
 

            application.AuthorizeRequest += new EventHandler(application_AuthorizeRequest);
 

            application.PreRequestHandlerExecute += new EventHandler(application_PreRequestHandlerExecute);
 

            application.PostRequestHandlerExecute += new EventHandler(application_PostRequestHandlerExecute);
 

            application.ReleaseRequestState += new EventHandler(application_ReleaseRequestState);
 

            application.ResolveRequestCache += new EventHandler(application_ResolveRequestCache);
 

            application.PreSendRequestHeaders += new EventHandler(application_PreSendRequestHeaders);
 

            application.PreSendRequestContent += new EventHandler(application_PreSendRequestContent);
 

        }
 

 

        private void application_BeginRequest(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_BeginRequest<br/>");
 

        }
 

 

        private void application_EndRequest(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_EndRequest<br/>");
 

        }
 

 

        private void application_PreRequestHandlerExecute(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_PreRequestHandlerExecute<br/>");
 

        }
 

 

        private void application_PostRequestHandlerExecute(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_PostRequestHandlerExecute<br/>");
 

        }
 

 

        private void application_ReleaseRequestState(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_ReleaseRequestState<br/>");
 

        }
 

 

        private void application_AcquireRequestState(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_AcquireRequestState<br/>");
 

        }
 

 

        private void application_PreSendRequestContent(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_PreSendRequestContent<br/>");
 

        }
 

 

        private void application_PreSendRequestHeaders(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_PreSendRequestHeaders<br/>");
 

        }
 

 

        private void application_ResolveRequestCache(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_ResolveRequestCache<br/>");
 

        }
 

 

        private void application_AuthorizeRequest(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_AuthorizeRequest<br/>");
 

        }
 

 

        private void application_AuthenticateRequest(object sender, EventArgs e)
 

        {
 

            HttpApplication application = (HttpApplication)sender;
 

            application.Context.Response.Write("application_AuthenticateRequest<br/>");
 

        }
 

    }
 

}

 

<add name="HttpModule1" type="MyHttpModule.HttpModule1,MyHttpModule"/>
<add name="HttpModule2" type="MyHttpModule.HttpModule2,MyHttpModule"/>

HttpModule1和HttpModule2模仿ValidaterHttpModuleEvents編寫（除了類名改變外，事件和方法不變），不貼程式碼了。執行結果如下：

從執行結果可以看到，在web.config檔案中引入自定義HttpModule的順序就決定了多個自定義HttpModule在處理一個HTTP請求的接管順序。

(3)、利用HttpModule實現終止此次HttpRequest請求

在BeginRequest事件中，使用HttpApplication.CompleteRequest()方法可以實現當滿足一定條件時終止此次HttpRequest請求

using System;
using System.Web;
namespace ClassLibrary1
{
    public class MyHttpModule : IHttpModule
    {
        public void Dispose() { }
        public void Init(HttpApplication context)
        {
            context.BeginRequest += new EventHandler(Application_BeginRequest);
        }
        public void Application_BeginRequest(object sender, EventArgs e)
        {
            HttpApplication application = sender as HttpApplication;
            application.CompleteRequest();
            application.Context.Response.Write("請求被終止");
        }
    }
}

說明：
a、對於一個HttpModule，在BeginRquest中終止，但是仍然會呼叫EndRequest事件，以及PreSendRequestHeaders事件和PreSendRequestContent事件。也可以說是直接跳轉到EndRequest事件，而不會呼叫這期間的事件
b、如果有兩個HttpModule，在第一個HttpModule的BeginRequest中終止，僅僅不會呼叫第二個HttpModule的BeginRequest，但仍然會呼叫兩個EndRequest事件，以及PreSendRequestHeaders事件和PreSendRequestContent事件。看下面的圖示：

HttpModule的認識與深入理解
2009-10-19
HTTP
.net httpHandler和httpModule
2013-10-21
HTTP
HttpModule與HttpHandler的區別（一）
2013-03-29
HTTP
認識Windows的域
2017-11-07
Windows
圖形的認識
2024-09-22
關於UI設計行業的認識再到認識
2018-04-08
UI行業
ASP.NET HttpModule——原理
2009-01-12
ASP.NETHTTP
認識CopyOnWriteArrayList
2019-04-08
認識Docker
2020-11-15
Docker
認識jquery
2020-10-19
jQuery
JQuery認識
2020-10-03
jQuery
認識 TypeScript
2017-03-11
TypeScript
【認識JavaScript】
2016-12-25
JavaScript
認識WebGL
2015-04-30
Web
認識Redis
2024-06-18
Redis
認識JS中的Class
2021-09-25
JS
Hadoop 工具的認識
2018-05-18
Hadoop
對C++的認識
2017-01-08
C++
軟體工程的認識
2016-03-07
軟體工程
認識oracle的update更新
2013-01-30
Oracle
新手知識：認識(轉)
2007-08-10
學習/認識CPU的GDT
2020-08-19
package.json的認識
2021-08-25
PackageJSON
spring 啟動的認識
2018-09-04
Spring
【雜談】對CopyOnWriteArrayList的認識
2018-11-12
我認識的python(4)
2018-07-14
Python
我認識的python(5)
2018-07-14
Python
對深度學習的認識
2020-11-27
深度學習
快速冪的初步認識（Java）
2020-10-02
Java
我認識的python(3)
2018-07-06
Python
我認識的python(1)
2018-07-02
Python
我認識的python(2）
2018-07-02
Python
對轉義字元的認識
2016-07-26
字元
Session Facade的認識
2003-08-23
Session
Redis(1)_Redis的基本認識
2024-04-23
Redis
JSON認識
2021-09-09
JSON
Mybatis初步認識
2021-02-28
MyBatis
認識mysql(3)
2018-08-28
MySql

HttpModule的認識

1、asp.net的HTTP請求處理過程

2、HttpModule工作原理

3、編寫自己的HttpModule

4、HttpModule內部事件機制和生命週期

相關文章