C#自定義HttpFilter模塊完善實例

2020-01-24 02:19:08

字體：大中小

來源：轉載

供稿：網友

本文實例講述了C#自定義HttpFilter模塊完善的方法，分享給大家供大家參考。具體實現方法如下：

一、背景

近期由于要針對項目做用戶操作日志，但不想在每個方法里去增加代碼，寫入用戶日志。因為這樣具體的方法違背職責單一的原則，若后期日志內容格式發生變更，或其他什么需求，該方法代碼主要一變在變，故使用HttpModule模塊來完成此功能，感興趣的朋友可以參考：關于HttpHandler與HttpModule的理解和應用方法

經過實際運用與完善，現在可以再次總結下。

二、攔截時機

現在的版本中，攔截的依據是，在每次請求發生的過程中，攔截控制器類請求，重定向http輸出流，并分析出Controller與Action，接下來查找是否有方法監控了此控制器，若有，則分析出請求輸入參數，與此次請求輸出內容，存儲在FilterContext中，交給該方法，完成相應邏輯。

由于在最初的寫法中，是針對所有的請求進行流的重定向，在asmx下，會遇到問題，只要重定向了，調用服務的客戶端會提示400 Http Bad Request 。這個具體的錯誤原因，還不清楚，但正是由于該錯誤，讓我發現，我之前攔截的時機是錯誤的，理應放在請求之前，判斷是否滿足攔截的規則，若滿足，則重定向輸出流。

三、讀取用戶名

在Module模塊中總會出點問題，最后使用了Cookie記住用戶名，并直接定義為FilterContext一個屬性。解釋下這樣做的原因：由于記住用戶名的方式有很多，如Session、Cookie，即讀取用戶名的方式是可變的，所以盡可能將變化的內容在前面解決，這樣監聽控制器的方法，直接根據該屬性獲取用戶名，否則用戶名的讀取時機，放在每個監聽控制器模塊之后，讀取方式一旦發生變更，所有的模塊都要改變，當然也可以通過繼承一個base類來避免這么大的改變。

在這里我想表達的意思是:我們做類似底層庫的東西，盡可能穩定,將變化點集中在庫本身，這樣依賴該庫的應用才能穩定。若.net版本更新過程中，API都不穩定，想必我們也不會在去使用它。

四、應用之寫入日志

典型例子如下:

復制代碼代碼如下:

[FilterMethod("Login", "Login")]
public void Login(FilterContext context)
{
    //解析輸出內容，這里針對要監聽的控制器和方法來寫的
    var arr = context.OutputBody.Split('|');
    var log = string.Format("userName:{0} password:{1}",arr);
    FilterLog.Log.Info(log);
}

該方法表達的意思是，監控LoginController的Login方法。由于我們需要分析請求輸出結果，所以分析的規則，與控制器是強依賴的，控制器的方法是怎么返回數據的，我們此處就要根據規則解析。我在項目中使用的是Json，所以監控的地方都需要Json的反序列化，這里僅僅是一個Demo。

另外一個方法可以監聽一個控制器下的多個方法，或者多個控制器。這樣是旨在解決有很多Action，輸入參數和輸出參數都是相同的，可能由于業務不同，僅僅在方法名和內部實現中有不同。

五、應用之更新緩存

首先關于Cache的應用，可以讀下此文章，Asp.Net Cache高級用法。

由于此處我沒有寫例子，先描述我在項目中運用的情況。系統有很多數據字典，在請求該數據字典時，程序首先從數據庫加載字典數據，并放入緩存，此時放入緩存有個技巧，設置過期時間，并設置移除緩存前的回調，我們來看看具體的方法定義:

復制代碼代碼如下:

//
// 摘要:
//     將對象與依賴項、到期策略以及可用于在從緩存中移除項之前通知應用程序的委托一起插入到 System.Web.Caching.Cache 對象中。
//
// 參數:
//   key:
//     用于引用對象的緩存鍵。
//
//   value:
//     要插入到緩存中的對象。
//
//   dependencies:
//     該項的文件依賴項或緩存鍵依賴項。當任何依賴項更改時，該對象即無效，并從緩存中移除。如果沒有依賴項，則此參數包含 null。
//
//   absoluteExpiration:
//     所插入對象將到期并被從緩存中移除的時間。要避免可能的本地時間問題（例如從標準時間改為夏時制），請使用 System.DateTime.UtcNow
//     而不是 System.DateTime.Now 作為此參數值。如果使用絕對到期，則 slidingExpiration 參數必須設置為 System.Web.Caching.Cache.NoSlidingExpiration。
//
//   slidingExpiration:
//     緩存對象的上次訪問時間和對象的到期時間之間的時間間隔。如果該值等效于 20 分鐘，則對象在最后一次被訪問 20 分鐘之后將到期并被從緩存中移除。如果使用可調到期，則
//     absoluteExpiration 參數必須設置為 System.Web.Caching.Cache.NoAbsoluteExpiration。
//
//   onUpdateCallback:
//     從緩存中移除對象之前將調用的委托。可以使用它來更新緩存項并確保緩存項不會從緩存中移除。
//
// 異常:
//   System.ArgumentNullException:
//     key、value 或 onUpdateCallback 參數為 null。
//
//   System.ArgumentOutOfRangeException:
//     將 slidingExpiration 參數設置為小于 TimeSpan.Zero 或大于一年的等效值。
//
//   System.ArgumentException:
//     為要添加到 Cache 中的項設置 absoluteExpiration 和 slidingExpiration 參數。- 或 -dependencies
//     參數為 null，absoluteExpiration 參數設置為 System.Web.Caching.Cache.NoAbsoluteExpiration
//     并且 slidingExpiration 參數設置為 System.Web.Caching.Cache.NoSlidingExpiration。
public void Insert(string key, object value, CacheDependency dependencies, DateTime absoluteExpiration, TimeSpan slidingExpiration, CacheItemUpdateCallback onUpdateCallback);