系統架構/機制

BasePage 撰寫 PageCommand 事件

jeff — Fri, 29 Aug 2008 20:46:00 GMT

前言

在「撰寫自用 Confirm 方法」一文中提到的「案例三：先執行伺服端程式再彈出詢問訊息，依用戶端回應再接續執行」，當用戶端回應詢問訊息後，會呼叫 __doPostBack() 函式來產生 PostBack 的動作，頁面再自行判斷 Me.Request.Form("__EVENTTARGET") 及 Me.Request.Form("__EVENTARGUMENT") 來處理後序的作業。可是這樣處理 PostBack 的方式略顯麻煩，換個角度思考，若 Page 也能像 GridView 一樣具有類似 RowCommand 的事件，可以處理這類的 PostBack 那不是更方便了嗎？所以本文將在 BasePage 加入 PageCommand 事件，針對這個案例改用 PageCommand 來處理。

程式實作

我們將使用「撰寫自用的 ScriptManager 來管理用戶端指令碼」文中提及的 TBBasePage 類別及 TBScriptManager 類別為基礎做擴展。首先在 TBBasePage 新增一個 PageCommand 事件，作法如下。

1.定義 PageCommand 事件。
2.新增 EventTarget 唯讀屬性，傳回 Me.Request.Form("__EVENTTARGET")。
3.新增 EventArgument 唯讀屬性，傳回 Me.Request.Form("__EVENTARGUMENT")。
4.覆寫 OnLoad 方法，判斷 EventTarget 及 EventArgument 屬性值，來決定是否引發 PageCommand 事件。

''' <summary> ''' 頁面基礎類別。 ''' </summary> Public Class TBBasePage Inherits System.Web.UI.Page #Region " PageCommand 事件 " ''' <summary> ''' DayCommand 事件引數。 ''' </summary> Public Class PageCommandEventArgs Inherits System.EventArgs Private FCommandName As String = String.Empty Private FCommandArgument As String = String.Empty ''' <summary> ''' 命令名稱。 ''' </summary> Public Property CommandName() As String Get Return FCommandName End Get Set(ByVal value As String) FCommandName = value End Set End Property ''' <summary> ''' 命令引數。 ''' </summary> Public Property CommandArgument() As String Get Return FCommandArgument End Get Set(ByVal value As String) FCommandArgument = value End Set End Property End Class ''' <summary> ''' 頁面命令事件。 ''' </summary> < _ System.ComponentModel.Description("頁面命令事件。") _ > _ Public Event PageCommand(ByVal sender As Object, ByVal e As PageCommandEventArgs) ''' <summary> ''' 引發 PageCommand 事件。 ''' </summary> Protected Overridable Sub OnPageCommand(ByVal e As PageCommandEventArgs) RaiseEvent PageCommand(Me, e) End Sub #End Region ''' <summary> ''' 觸發 PostBack 的控制項 UniqueID。 ''' </summary> Public ReadOnly Property EventTarget() As String Get Return Me.Request.Form("__EVENTTARGET") End Get End Property ''' <summary> ''' 觸發 PostBack 動作事件引數。 ''' </summary> Public ReadOnly Property EventArgument() As String Get Return Me.Request.Form("__EVENTARGUMENT") End Get End Property ''' <summary> ''' 判斷二字串是否相同(不區分大小寫)。 ''' </summary> ''' <param name="S1">第一個字串。</param> ''' <param name="S2">第二個字串。</param> Public Shared Function SameText(ByVal S1 As String, ByVal S2 As String) As Boolean If S1 Is Nothing Then Return S2 Is Nothing End If Return S1.Equals(S2, StringComparison.CurrentCultureIgnoreCase) End Function ''' <summary> ''' 覆寫。引發 Load 事件。 ''' </summary> Protected Overrides Sub OnLoad(ByVal e As EventArgs) Dim oArgument() As String Dim oEventArgs As PageCommandEventArgs MyBase.OnLoad(e) If SameText(Me.EventTarget, Me.UniqueID) Then '引發 PageCommand 事件 oArgument = Split(Me.EventArgument, "$") If oArgument.Length = 3 Then If SameText(oArgument(0), "PageCommand") Then oEventArgs = New PageCommandEventArgs() oEventArgs.CommandName = oArgument(1) oEventArgs.CommandArgument = oArgument(2) Me.OnPageCommand(oEventArgs) End If End If End If End Sub End Class

然後在 TBScriptManager 類別新增一個 GetPageCommandEventReference 方法，取得引發 PageCommand 事件的用戶端指令碼。

''' <summary> ''' 用戶端指令碼管理。 ''' </summary> Public Class TBScriptManager ''' <summary> ''' 取得引發 PageCommand 事件的用戶端指令碼。 ''' </summary> ''' <param name="CommandName">命令名稱。</param> ''' <param name="CommandArgument">命令引數。</param> Public Function GetPageCommandEventReference(ByVal CommandName As String, ByVal CommandArgument As String) As String Dim sArgument As String sArgument = String.Format("{0}${1}${2}", "PageCommand", CommandName, CommandArgument) Return Me.GetPostBackEventReference(FPage, sArgument) End Function End Class

PageCommand 事件完成了，我們把「案例三：先執行伺服端程式再彈出詢問訊息，依用戶端回應再接續執行」使用 PageCommand 來改寫，它的程式流程如下。

請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) -> 取得用戶端回應決定是否送審(伺服端)

第一個階段處理「請假單儲存(伺服端) -> 彈出詢問訊息(用戶端) 」，在下面的程式碼中，訊問訊息的回應結果無論是「確定」或「取消」都會引發 PageCommand 事件，CommandName 都是 "SaveConfirm"，差別是 CommandArgument 的值不同。

Protected Sub btnSave_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnSave.Click Dim sTrueScript As String Dim sFalseScript As String '執行請假單儲存的程式碼 '儲存完成彈出詢問訊息 sTrueScript = Me.BeeScript.GetPageCommandEventReference("SaveConfirm", "True") sFalseScript = Me.BeeScript.GetPageCommandEventReference("SaveConfirm", "False") Me.BeeScript.Confirm("假單要送審嗎?", sTrueScript, sFalseScript) End Sub

第二階段在 PageCommand 事件處理用戶端詢問訊息的回應「取得用戶端回應決定是否送審(伺服端)」，在 PageCommand 事件中，我們只需判斷 e.CommandName 及 e.CommandArgument 來決定接續的執行動作即可。

Protected Sub Page_PageCommand(ByVal sender As Object, ByVal e As Bee.Web.TBBasePage.PageCommandEventArgs) Handles Me.PageCommand If String.Equals(e.CommandName, "SaveConfirm", StringComparison.CurrentCultureIgnoreCase) Then If String.Equals(e.CommandArgument, "True", StringComparison.CurrentCultureIgnoreCase) Then '按了確定要執行的程式碼 Else '按了取消要執行的程式碼 End If End If End Sub

利用 BasePage 實作表單權限控管

jeff — Thu, 19 Jun 2008 20:48:00 GMT

摘要

若表單(頁面)具有「執行、新增、修改、刪除」等操作權限控管，可以使用列舉來描述使用者在該表單的權限，詳細的作法可以參考下面的「Enum 的設計與應用 - 簡易權限設計」這篇文章。在此我們將利用這種列舉的方式來描述表單權限，並由 BasePage 來處理表單權限的控管。

程式說明及實作

首先定義 EFormActions 列舉，來描述表單操作權限。

''' <summary> ''' 表單操作權限列舉。 ''' </summary> <Flags()> _ Public Enum EFormActions ''' <summary> ''' 無。 ''' </summary> None = 0 ''' <summary> ''' 執行。 ''' </summary> Execute = 1 ''' <summary> ''' 新增。 ''' </summary> Add = 2 ''' <summary> ''' 修改。 ''' </summary> Update = 4 ''' <summary> ''' 刪除。 ''' </summary> Delete = 8 ''' <summary> ''' 全部。 ''' </summary> All = Execute Or Add Or Update Or Delete End Enum

新增一個 TBActionPage 類別，繼承至 System.Web.UI.Page 或自訂的底層 BaseForm，做為權限控管的 BaseForm。首先新增一個 UserActions 屬性，來描述使用者的表單操作權限，在 OnInitComplete 方法中，第一次載入此表單時取得使用者的表單權限，即設定 UserActions 屬性，此屬性會儲存至 ViewState 中，使下次頁面 PostBack 時無需再重新取得表單權限。另外新增 CheckUserActions 方法，供檢查使用者是否具有指定的表單操作權限。

Public Class TBActionPage Inherits System.Web.UI.Page ''' <summary> ''' 使用者權限。 ''' </summary> Private FUserActions As EFormActions = EFormActions.None #Region " ViewState 狀態管理　" ''' <summary> ''' 由 ViewState 還原控制項的狀態。 ''' </summary> ''' <param name="savedState">要還原的控制項狀態。</param> Protected Overrides Sub LoadViewState(ByVal savedState As Object) If Not (savedState Is Nothing) Then ' Load State from the array of objects that was saved at ; ' SavedViewState. Dim myState As Object() = CType(savedState, Object()) If Not (myState(0) Is Nothing) Then MyBase.LoadViewState(myState(0)) End If If Not (myState(1) Is Nothing) Then FUserActions = CType(myState(1), EFormActions) End If End If End Sub ''' <summary> ''' 控制項的狀態儲存至 ViewState。 ''' </summary> ''' <returns>含有控制項之目前檢視狀態的物件。</returns> Protected Overrides Function SaveViewState() As Object Dim baseState As Object = MyBase.SaveViewState() Dim myState(1) As Object myState(0) = baseState myState(1) = FUserActions Return myState End Function #End Region ''' <summary> ''' 覆寫。引發 InitComplete 事件。 ''' </summary> Protected Overrides Sub OnInitComplete(ByVal e As System.EventArgs) If Not Me.IsPostBack Then '取得使用者的表單權限 '測試用：設定使用者具「執行/新增/修改」權限，實際應呼叫中間層取得使用者的此表單權限 Me.UserActions = EFormActions.Execute Or EFormActions.Add Or EFormActions.Update '第一次載入頁面時檢查執行權限 If Me.UserActions = EFormActions.None Then Throw New Exception("沒有此表單執行權限") End If End If MyBase.OnInitComplete(e) End Sub ''' <summary> ''' 使用者的表單操作權限。 ''' </summary> Public Property UserActions() As EFormActions Get Return FUserActions End Get Set(ByVal value As EFormActions) FUserActions = value End Set End Property ''' <summary> ''' 檢查使用者是否具有指定的表單操作權限。 ''' </summary> ''' <param name="Actions">表單操作權限</param> Public Function CheckUserActions(ByVal Actions As EFormActions) As Boolean If (Me.UserActions And Actions) = Actions Then Return True Else Return False End If End Function End Class

測試程式

為測試使用，在上述的 TBActionPage 的 OnInitComplete 方法，直接設定具有「執行/新增/修改」權限；正確的作法應該是呼叫中間層傳入該表單的識別碼來取得使用者在該表單具有那些權限，並在此設定 UserActions 屬性值。

Me.UserActions = EFormActions.Execute Or EFormActions.Add Or EFormActions.Update

新增一個測試頁面，繼承至 TBActionPage，當按下按鈕時利用 CheckUserActions 使用者具那些權限並輸出。

Imports Bee.Web.WebCommon Partial Class _Default Inherits Bee.Web.TBActionPage Protected Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles Button1.Click Me.Response.Write("執行 -> " & IIf(Me.CheckUserActions(EFormActions.Execute), "Y", "N")) Me.Response.Write("< br/ >") Me.Response.Write("新增 -> " & IIf(Me.CheckUserActions(EFormActions.Add), "Y", "N")) Me.Response.Write("< br/ >") Me.Response.Write("修改 -> " & IIf(Me.CheckUserActions(EFormActions.Update), "Y", "N")) Me.Response.Write("< br/ >") Me.Response.Write("刪除 -> " & IIf(Me.CheckUserActions(EFormActions.Delete), "Y", "N")) End Sub End Class

執行結果如下