如何解決“呈現控件時出錯”的問題
Webpart部署后在SPD中打開顯示呈現控件時出錯,后查到這篇文章,主要問題是在CreateChildControls中調用了this.page.Header,在設計視圖時,該對象可能還不存在,以后編碼時要注意在CreateChildControls盡量不調用數據庫/文件系統讀取、變量未附初值、調用了類似Page的屬性如Session,Page.Request.QueryString等。
在制作控件的時候容易遇到呈現控件時出錯發生了未處理的異常。未將對象引用設置到對象的實例。這樣的錯誤,如下圖:(也有可能僅僅只是因為未設置runat="server"標簽而導致該錯誤,請先檢查該項。)
但是在編譯時/運行時也都是沒有錯誤的。
分析
如圖所示的情況我們稱之為設計時以區別于編譯時/運行時。
設計時:在ASP.NET環境中也就是當我們在Visual Studio中使用網頁設計器進行編輯的時候。直接的理解就是在ASPX頁面切換到設計的時候。
編譯時:直接的理解就是當你進行編譯的時候,通常這個時候的錯誤是由類型檢查,參數匹配等顯式可直接通過語法約束所限制的錯誤。
運行時:直接的理解就是當你進行預覽/運行的時候。通常這個時候的錯誤則是由具體的異常,邏輯錯誤所組成的。
讓我們分析控件在設計時的表現,我們的控件在設計時的時候,VS智能地模擬輸出控件在運行時的樣貌,控件的呈現通過了一定順序的方法,并最終形成了當前輸出。按照標準,我們應該是在Render或RenderContents中對控件進行了輸出的操作(事實上其他也是可以,但我們通常也不那么做,或者說更多的呈現控件時出錯的異常主要來自于Render或RenderContents)。
從錯誤的提示未將對象引用設置到對象的實例。從這一句話來看,也就是說,有一個或者以上的對象的實例在沒有賦初值的情況下就被使用了。
讓我們窺視一下我們的代碼:
{
UpButton.Text = Page.Server.HtmlDecode(UpButton.Text);
DownButton.Text = Page.Server.HtmlDecode(DownButton.Text);
base.RenderContents(writer);
}
因為該控件在設計的時候需要有一個向上的按鈕和一個向下的按鈕,分別需要用兩個特殊的標點符號向上和向下,而這兩個符號需要通過設置如下所示的代碼編號才可以正確地被瀏覽器呈現:
private string downButtonText = "or;";
而這兩個符號在呈現前卻會被頁面進行一個HtmlEncode方法編譯后再輸出,而這兩個特殊的標志卻只能通過直接輸出的方式進行呈現,也就是說在HtmlEncode之后只能將該特殊標志以文本的形式輸出and; or;而不會輸出向上和向下的箭頭。這時候我們需要引入它的反向方法Page.Server.HtmlDecode進行解碼,注意到這里我們使用了Page實例,該實例只有在頁面真實存在的情況下才為非空,否則后續的操作將是對null的操作,而這樣的操作將會顯示未將對象引用設置到對象的實例。這樣的錯誤。
設計時:我們剛才提到了,設計時僅僅只是模擬頁面呈現的過程,而頁面事實上是不存在的。因此在這個時候Page對象的實例將為空,后續的調用將引發異常。
假設說我們只有這個方法用于處理當前所需要的行為,那么我們在調用Page的時候必將導致null的對象并致使后續操作發生異常。這個時候我們引入設計模式這個概念(非DesignPattern而是DesignMode),DesignMode是由Control類的一個受保護的(protected)屬性,它獲取一個值,用以指示該組件當前是否處于設計模式。這里的設計模式也就相當于設計時的概念。
因此我們可以將代碼改造為如下形式:
{
if (!DesignMode)
{
UpButton.Text = Page.Server.HtmlDecode(UpButton.Text);
DownButton.Text = Page.Server.HtmlDecode(DownButton.Text);
}
base.RenderContents(writer);
}
這樣只有在非設計時的時候,我們才引入Page對象的實例,因此設計時的異常將迎刃而解。
總結
因此在設計控件的時候,特別是在考慮控件呈現的時候,為了避免類似異常的發生,我們應該考慮該控件在設計時能夠獲取足夠的資源,對于未能獲取資源的項,我們應該顯式將其區分(如上代碼中使用DesignMode來判斷是否為設計時要執行的代碼)。
擴展
剛才我們所見到的情形可以歸結為在設計時無法引用具體實例所導致的異常,類似該異常的還會有數據庫/文件系統讀取、變量未附初值、調用了類似Page的屬性如Session,Page.Request.QueryString等。在頁面設計的時候由于以上部分方案特別是調用到Page的相關方法的由于頁面總是會存在,因此我們不會經常看到它們出異常,在設計控件的時候我們更應該注意。