Asp.net HttpHandler vs HttpModule 詳細解說.

前言:

Asp.net 是一個pipeline的模型

我覺得.Net Web工程師對於這個模型和IHttpHanlder,IHttpModule 要有基本的概念和理解.

理解這些管道除了可以讓我們節省許多不必要的資源浪費也可讓我們程式架構更加有條理.

就像我們在Asp.net MVC如果要寫權限驗證程式碼,雖然可以寫在ControllerAction

但更好做法是我可以寫一個類別繼承AuthorizeAttributeoverride OnAuthorization方法並掛上此標籤.

所以更了解這些原理可以讓我們寫程式事半功倍.

Asp.net Application Event 生命週期

前面我們知道Asp.net是一個請求處理響應的管道而這個管道中微軟有提供許多點可以讓我們進行客製化的擴充程式撰寫

事件可藉由IHttpModule來擴充註冊

Event事件名稱:

官網列出可用事件很多,下面列出我有用過的幾個事件和其功用.

  • BeginRequest
  • AuthorizeRequest
  • PostResolveRequestCache
  • MapRequestHandler
  • AcquireRequestState
  • PreRequestHandlerExecute
  • PostRequestHandlerExecute
  • EndRequest

事件方法說明:

  • BeginRequest: 已經啟動要求。如果要在要求前執行某個動作 (例如, 在每頁頁首顯示廣告橫幅), 請同步處理這個事件。
  • AuthorizeRequest: 您可以在內部使用這個事件, 以實作授權機制 (例如, 將存取控制清單 (ACL) 儲存在資料庫, 而非存入檔案系統)。您也可以覆寫這個事件, 但無此必要。
  • PostResolveRequestCache:當 ASP.NET 略過目前事件處理常式的執行並允許快取模組從快取中服務要求時發生。
  • MapRequestHandler:ASP.NET 基礎結構會使用事件來判斷目前要求的要求處理常式。 如需詳細資訊
  • AcquireRequestState: 工作階段狀態是擷取自狀態儲存區。如果要建置自已的狀態管理模組, 則可以同步處理這個事件, 以便從狀態儲存區擷取「工作階段」狀態。
  • PreRequestHandlerExecute: 這個事件會在執行 HTTP 處理常式之前產生。
  • 在介於PreRequestHandlerExecutePostRequestHandlerExecute事件之間會執行HttpHandler程式碼.
  • PostRequestHandlerExecute: 這個事件會在執行 HTTP 處理常式之後產生。
  • EndRequest: 要求已完成。您可能想要建置偵錯模組, 以便收集要求的全部資訊, 然後再將資訊寫入網頁中。

IHttpHandler 和 IHttpModule 關係

用一句話簡述IHttpHandlerIHttpModule

如果把Http請求當作火車那

  • IHttpHandler是火車的終點
  • IHttpModule是沿路經過的站點

IHttpHandlerIHttpModule關係如 Implementing HTTPHandler and HTTPModule in ASP.NET 文章提到

img

每個請求一定會通過所有被註冊的IHttpModule,而最終會執行一個IHttpHandler後進行返回.

我們常聽到的Asp.net WebformMVC都是經過管道Module並執行相對應的Handler.

所以HttpHanlder 和 HttpMoudule 搭配使用達到更強大的功能.

IHttpHandler

MSDN說明

您可以撰寫自訂的 HTTP 處理常式來處理特定的預先定義的任何 Common Language Specification (CLS) 標準的語言中的 HTTP 要求的類型。 可執行程式碼中定義HttpHandler類別,而不是傳統的 ASP 或 ASP.NET Web 網頁,這些特定的要求回應。 HTTP 處理常式提供您一種低層級的要求和回應服務的 IIS Web 伺服器互動,以及大部分 ISAPI 擴充程式類似,但使用簡單的程式設計模型提供的功能。

IHttpHandler是一個可以讓我們實現的介面
裡面包含:

屬性:

1
public bool IsReusable { get; }

取得值,指出另一個要求是否可以使用 IHttpHandler 執行個體。

方法:

1
public void ProcessRequest(HttpContext context)

以實作 IHttpHandler 介面的自訂 HttpHandler 來啟用 HTTP Web 要求的處理。

IHttpModule

MSDN說明

Modules are called before and after the handler executes. Modules enable developers to intercept, participate in, or modify each individual request. Modules implement the IHttpModule interface, which is located in the System.Web namespace.

處理常式 (Handler) 在執行前後,會呼叫模組 (Module)。 模組可以讓開發人員攔截、參與或修改每個要求。

更印證了

 如果把Http請求當作火車那

  • IHttpHandler是火車的終點
  • IHttpModule是沿路經過的站點

要查看有哪寫IHttpModuleIHttpHandler被註冊可以看applicationhost.config檔案

路徑:C:\Users[user]\Documents\IISExpress\config\applicationhost.config

自己建立一個 IHttpHandler

在前面有說到每個Http請求的最終是為了給一個HttpHander來執行處理.

像我們常看到的

  • ASP.NET page (*.aspx)
  • Web service (*.asmx)
  • Generic Web (*.ashx)

甚至是MVC (MvcHandler)都是實現於IHttpHander介面

這邊介紹如果要如何建立自己HttpHander.

程式碼

使用IHttpHandler須完成幾個步驟:

  1. 建立一個類別實現IHttpHander
  2. Web.Config註冊上面撰寫的IHttpHandler

建立一個類別實現IHttpHander

繼承完IHttpHandler我們會實現兩個方法.

  1. ProcessRequest(HttpContext context) 執行此次請求動作.
  2. bool IsReusable { get; } 是否要將此次請求加入快取中重用.
1
2
3
4
5
6
7
8
9
10
11
12
public class MyHttpHandler : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
context.Response.ContentType = "text/html";
context.Response.Write("==================<br/>");
context.Response.Write("Hello World<br/>");
context.Response.Write("==================<br/>");
}

public bool IsReusable { get; }
}

Web.Config註冊上面撰寫的IHttpHandler

我們要在Web.Config中設定我們撰寫的HttpHandler

這是一個範例:

1
2
3
4
5
6
7
<configuration>
<system.webServer>
<handlers>
<add verb="*" name="MyHttpHandler" path="*.cspx" type="HttpHandler_HttpModule.MyHttpHandler"/>
</handlers>
</system.webServer>
</configuration>

handlers加入在system.webServer結點中.

裡面有幾個Attribute

  • verb:請求動作 GET,POST,PUT...如果是*代表全部請請動作都合用.
  • path:請求那些副檔名會執行此HttpHandler
  • type:註冊的HttpHandler類型.

其中最要注意的是type Attribute.

1
<add verb="*" name="MyHttpHandler" path="*.cspx"  type="(namespace).(classname)"/>

最後我們就可以請求 http://xxxx/Mypage.cspx 來試試看我們的結果.

自己建立一個 IHttpModule

每個被註冊的HttpModule是Http請求必經之路.

  • Asp.net MVC 是透過System.Web.Routing.UrlRoutingModule 這個HttpModule來完成切入的.

使用IHttpModule須完成幾個步驟:

  1. 建立一個類別實現IHttpModule
  2. Web.Config註冊上面撰寫的IHttpModule

建立一個類別實現IHttpModule

這個範例會在頁面上顯示 IIS Pipeline Event的執行順序.

  1. public void Init(HttpApplication context)HttpApplication 中的event做擴充.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public class MyHttpModule:IHttpModule
{
public void Init(HttpApplication context)
{
context.BeginRequest += (sender, args) => ShowStep(sender, "BeginRequest");

context.AuthorizeRequest += (sender, args) => ShowStep(sender, "AuthorizeRequest");

context.PostResolveRequestCache += (sender, args) => ShowStep(sender, "PostResolveRequestCache");

context.MapRequestHandler += (sender, args) => ShowStep(sender, "MapRequestHandler");

context.AcquireRequestState += (sender, args) => ShowStep(sender, "AcquireRequestState");

context.PreRequestHandlerExecute += (sender, args) => ShowStep(sender, "PreRequestHandlerExecute");

//這中間執行IHttpHandler.

context.PostRequestHandlerExecute += (sender, args) => ShowStep(sender, "PostRequestHandlerExecute");

context.EndRequest += (sender, args) => ShowStep(sender, "EndRequest");

context.PreSendRequestHeaders += (sender, args) => ShowStep(sender, "PreSendRequestHeaders");
}

private void ShowStep(object app,string eventName)
{
var http = (HttpApplication)app;
http.Response.Write($"Step {eventName}<br/>");
}

public void Dispose()
{
}
}

Web.Config註冊上面撰寫的IHttpModule

註冊方法和IHttpHander很類似,一樣在system.webServer節點下加入modules

1
2
3
4
5
6
7
<configuration>
<system.webServer>
<modules>
<add name="MyHttpModule" type="HttpHandler_HttpModule.MyHttpModule"/>
</modules>
</system.webServer>
</configuration>

範例原始碼下載

參考資料:

  • https://docs.microsoft.com/en-us/previous-versions/aspnet/bb398986(v=vs.100)#Features
  • https://support.microsoft.com/zh-tw/help/307985/info-asp-net-http-modules-and-http-handlers-overview
  • https://www.codeproject.com/Articles/335968/Implementing-HTTPHandler-and-HTTPModule-in-ASP-NET

此文作者:Daniel Shih(石頭)
此文地址https://isdaniel.github.io/HttpHandler-HttpModule/
版權聲明:本博客所有文章除特別聲明外,均採用 CC BY-NC-SA 3.0 TW 許可協議。轉載請註明出處!


如果本文對您幫助很大,可街口支付斗內鼓勵石頭^^