C# DropDownList的一個有意思的bug及解決
1.引言
信息和網絡的發展,使基于Web應用的系統越來越普及, VS.Net無疑是開發Web應用的系統的最合適的工具之一。但我們在長期的開發實踐中發現,C#.Net下DropDownList控件在使用過程中會遇到一些問題,它的SelectedIndex屬性存在一個讀寫缺陷,這個問題也一直困擾著其他的開發人員。因此,本文專門對DropDownList做了詳細的測試,來探求問題所在和解決辦法。
2.C# DropDownList控件介紹
DropDownList是C#.Net 控件面板Web Form下的一個控件,它的命名空間是System.Web.UI.WebControls.DropDownList。它是一個允許用戶從下拉列表中選擇一項的控件,通過在C# ropDownList 控件的開始和結束標記之間為每個項放置一個ListItem對象,可以指定希望顯示在C# DropDownList 控件中的項,也支持數據綁定。DropDownList的功能決定了它在日常開發中的實用性,在數據輸入控件中其使用率僅次于TextBox。通過預先設定或動態數據綁定將其填入可供用戶選擇的數據,既方便了用戶操作,增強軟件的易用性,又能有效的規范數據輸入,成為軟件開發人員最常選擇的控件之一。
3.關于SelectedIndex的有趣的問題
在長期的使用過程中我們發現,當在程序中動態將DropDownList列表中的某項選定,
或指定SelectedIndex為某一值時,會出現意想不到的錯誤。而使用斷點跟蹤調試方法或將SelectedIndex值讀取到某個變量進行測試,卻難以找到問題所在。
3.1 發現問題
假設有如下簡單代碼
- private void Page_Load(object sender, System.EventArgs e)
- {
- if (!IsPostBack)
- { //初始化DropDownList下拉列表
- Init_FillList();
- }
- }
- private void btnOK_Click(object sender, System.EventArgs e)
- {
- string strID=txtContinentID.Text.Trim();
- //選擇指定項
- listContinent.Items.FindByValue(strID).Selected=true;
- Response.Write("OK!");
- }
- #region初始化下拉列表方法
- private void Init_FillList()
- { //定義ListItem對象
- ListItem item;
- //清空列表
- listContinent.Items.Clear();
- //寫入列表
- listContinent.Items.Add(" ");
- item=new ListItem("亞洲","Asia");
- listContinent.Items.Add(item);
- item=new ListItem("歐洲","Euro");
- listContinent.Items.Add(item);
- item=new ListItem("美洲","Amer");
- listContinent.Items.Add(item);
- }
- #endregion
把它放到一個簡單web頁面中直接運行,在輸入框中輸入大洲編號Asia,Euro ,Amer中的任一個,點擊btnOK按鈕鍵,看似沒有任何問題的代碼,報出了如下VS.Net著名的錯誤黃頁:(記為:錯誤A )
C# DropDownList 不能有多個項被選定。
說明: 執行當前 Web 請求期間,出現未處理的異常。請檢查堆棧跟蹤信息,以了解有關該錯誤以及代碼中導致錯誤的出處的詳細信息。異常詳細信息: System.Web.HttpException: DropDownList 不能有多個項被選定。
通過認真核查代碼并查詢聯機幫助,發現DropDownList的使用符合相關說明文檔的使用方法,沒有任何問題。
為了跟蹤查找錯誤的原因,在btnOK_Click()事件下的所有代碼外圍加try…catch保護進行調試,單步執行,發現一直執行到Response.Write("OK!")句,程序都沒有跳出,繼續向下,此時該事件已經執行完了,沒有錯誤,應該顯示出正常的web頁面,就在這時,上面的錯誤黃頁又出現了。調試無法找到錯誤所在,如何才能解決這個問題,難道是開發工具的原因,于是想到以下辦法.
3.2 問題暫時解決不能有多個項被選定,可能是因為DropDownList在選擇新項之前不能自動去除原來的選擇,即,不能有效的對已添入數據的列表進行初始化。于是在每次PostBack后將DropDownList的數據重新綁定刷新恢復到系統自己規定的默認值,然后再進行新的項的選擇,將Page_Load()事件下的代碼做如下調整
- private void Page_Load(object sender, System.EventArgs e)
- {
- //去掉 if (!IsPostBack)每次都重寫數據
- Init_FillList();
- }
此時再運行程序,不再出現錯誤A,運行正常。但是web應用不同于局域網內系統的應用,它對程序執行效率要求更高,要盡量減少對服務器的訪問。如果一個頁面在每次刷新時都要重新訪問服務器初始化數據地話,會嚴重增加服務器的負擔。一旦數據量大或訪問的終端增多,將會使頁面顯示變的非常慢,客戶無法忍受。需要繼續尋求其他的解決辦法。
3.3 有趣的bug由于過去曾經長期從事Delphi下的應用系統的開發,對Combox控件的使用非常熟悉,由于他們的功能基本相同,推斷其使用方法應該也是有些相通的,于是對txtOK_Click()進行修改,得txtOK2_Click()事件:
- private void txtOK2_Click(object sender, System.EventArgs e)
- {
- string strID=txtContinentID.Text.Trim();
- this.listContinent.SelectedIndex=-1;//新加行
- listContinent.Items.FindByValue(strID).Selected=true;
- Response.Write("OK!");
- }
運行程序,果然在加上IsPostBack判斷的情況下,程序仍能正常運行。然而這與msdn聯機幫助對DropDownList的使用說明是不符的。相關的屬性說明:“DropDownList.SelectedIndex 屬性,DropDownList控件中的選定項的索引。默認值為 0,該值選擇列表中的***項。備注 使用 SelectedIndex 屬性以編程方式指定或確定 DropDownList控件中的選定項的索引。DropDownList 控件中總是選擇一項。無法在列表中同時取消選擇所有項。注意 DropDownList 控件中的項的索引從零開始”。有趣的是不符合使用規定的程序沒有報任何錯誤,反而使程序運行正常。
為了查看SelectedIndex在運行時的實際值是0還是1或其他的值,再次跟蹤調試,此時發現了一個有趣的bug。把斷點設置到this.listContinent.SelectedIndex=-1行,當程序運行到這里時將鼠標移到SelectedIndex的位置,查看它的值,(或者通過開發環境下邊的變量查看器查看),發現此時的值是0,繼續向下運行,錯誤A又出現了。而同樣是調試狀態,單步執行代碼,只是不進行查看SelectedIndex的操作(通過變量查看器看也不可以),直到跟蹤完畢,程序運行也沒有問題。很明顯,這是C#.Net的一個bug。
3.4 換一種取值方式既然不能在調試時通過系統的返回值提示查看變量值,只能變通一下,通過自己定義變量來獲取SelectedIndex的值。于是對txtOK2_Click()進行修改,得txtOK3_Click()事件:
- private void btnOK3_Click(object sender, System.EventArgs e)
- {
- //新加行 調試后知 i=0
- int i= listContinent.SelectedIndex;
- string strID=txtContinentID.Text.Trim();
- this.listContinent.SelectedIndex=-1;
- //新加行 調試后知 j=0
- int j=this.listContinent.SelectedIndex;
- listContinent.Items.FindByValue(strID).Selected=true;
- Response.Write("OK!");
- }
運行程序,真正的問題出現了,不管在debug狀態還是非調試狀態,都是一樣的“DropDownList 不能有多個項被選定”錯誤。這說明SelectedIndex的值根本不能進行查看或讀取,這也進一步證明C#.Net中對SelectedIndex的讀取實現代碼有問題,存在不安全的判斷。
另外,經過此時的調試觀察i和j的返回值是一樣的結果,這個結果也和系統規定的SelectedIndex的默認值為 0一致。這證明了this.listContinent.SelectedIndex=-1這行代碼在txtOK2_Click()中是沒有起作用沒有用途的,然而加上該行代碼卻能解決問題,使程序正常運行。
3.5問題根源
通過反編譯工具和.NET源碼的幫助,找到了C#.Net中關于DropDownList的源碼實現,發現了這個問題存在的根源。以下是C#.Net中DropDownList的SelectedIndex屬性源碼實現:
- [WebCategory("Behavior"),DesignerSerializationVisibility
- (DesignerSerializationVisibility.Hidden),DefaultValue(0),
- WebSysDescription("DropDownList_SelectedIndex")]
- public override int SelectedIndex{ get
- { int num1 = base.SelectedIndex;
- if ((num1 < 0) && (this.Items.Count > 0))
- {
- this.Items[0].Selected = true;
- num1 = 0;
- }
- return num1; }
- set
- {
- base.SelectedIndex = value;
- }}
這段源碼實現表明,在取SelectedIndex時自動進行了判斷,只要有數據那么Selected的值就肯定大于等于0,所以我們在查看時發現設置成-1是無效的,它會自動改為0。另外它還做了另外一部操作this.Items[0].Selected = true,這個也就是直接導致Exception產生的原因(開發者只是想看看SelectedIndex它就把Item[0]的Selected值給改了...),所以在調試程序時要注意回避這個問題,我們只能通過修改代碼使程序運行正常,而無法改變 VS.NET的源碼實現。
程序測試界面,btnOK,btnOK2,btnOK3和列表數據綁定代碼的實現已在上面給出。
4.C# DropDownList結束語
經調試,在初始設置SelectedIndex=0的情況下同樣存在“錯誤A”的問題。而且若將3.3中SelectedIndex=-1改為SelectedIndex=0,此中情況程序不調試運行也會出現“錯誤A”。
在系統對效率要求不高,數據量小的情況下可以采用3.2的方法來回避這個問題,即每次加載頁面重新初始化DropDownList列表。也可采取3.3中將SelectedIndex設為-1的方法來改進這一問題,但此時不要對SelectedIndex=-1行進行單行調試。兩種方法在工程交付運行時都不會有任何因為SelectedIndex而引起的程序錯誤。
該文所有測試在Microsoft .NET Framework 1.1, C# .NET 2003 version 7.1,IE6.0 環境下編寫調試。
【編輯推薦】