XAML自定義控件中事件處理的示例分析

這篇文章主要為大家展示了“XAML自定義控件中事件處理的示例分析”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“XAML自定義控件中事件處理的示例分析”這篇文章吧。

在開發 XAML(WPF/UWP) 應用程序中，有時候，我們需要創建自定義控件 (Custom Control) 來滿足實際需求。而在自定義控件中，我們一般會用到一些原生的控件（如 Button、TextBox 等）來輔助以完成自定義控件的功能。

自定義控件并不像用戶控件 (User Control) 一樣，使用 Code-Behind（UI 與邏輯在一起）技術。相反，它通過把 UI 與邏輯分離而將兩者解耦。因此，創建一個自定義控件會產生兩個文件，一個是 Generic.xaml，在它里面定義其模板與樣式；另一個是 <ControlName>.cs，這里面存放其邏輯，如下圖：

在這種情況下，要想在代碼中獲取到模板里定義的控件，就不像 Code-Behind 中那么容易，而要借助于 OnApplyTemplate 和 GetTemplateChild 這兩個方法。它們的意義分別如下：

OnApplyTemplate: 在自定義控件中，通常要重寫這個方法，當基類調用 ApplyTemplate() 方法以構造可視化樹時，會調用它；

GetTemplateChild: 獲取 ControlTemplate 中所定義的可視化樹上指定名稱的元素；

所以，如果我們在模板中定義了一個名為 PART_ViewButton 的按鈕，那么，我們可以這樣獲取它，并為它注冊響應事件：

public override void OnApplyTemplate()
  {
   base.OnApplyTemplate();
   Button btnView = GetTemplateChild("PART_ViewButton") as Button;
   if (btnView != null)
   {
    btnView.Click += BtnView_Click;
   }
  }
  private void BtnView_Click(object sender, RoutedEventArgs e)
  {
   // 這里寫響應邏輯
  }

當我們（或者其他人）要用這個控件時，通過給它設置了模板（一般都是默認模板）后， OnApplyTemplate 方法就會被執行。這樣做看起來沒什么問題。不過，其實這里有可能會引起一個聽起來很嚴重的問題：內存泄露 (Memory Leak)。

何為內存泄露

內存泄露有多種類型，一般來說，它是指某種類型的資源不再使用，但卻仍然占用內存。換句話說，它從受管理的內存區域中“泄漏”出去了。如果在程序中有多處內存泄露，將會占有很多內存，并最終導到內存被耗盡。

在 C# 中，常見的內存泄露有：

? 沒有移除事件監聽；

? 沒有銷毀非托管資源（如數據庫、文件流等）；

對于上面兩種情況，它們的解決辦法也非常簡單，分別是：要反注冊事件（即移除事件監聽）與調用 Dispose 方法（如果沒有，則要實現 IDisposable 接口，并在其中銷毀非托管資源）。

對于第二種情況，比較好理解；而對于第一種情況，問題是，為什么沒有移除事件監聽，會導致內存泄露呢？這是因為事件源比事件監聽者的生命周期更長。來看代碼：

ObjectA objA = new ObjectA(); 

ObjectB objB = new ObjectB(); 

objA.Event += objB.EventHanlder;

ObjectA 中定義了 Event 事件，我們為它注冊了一個事件處理器（對象 objB 中的 EventHanlder 方法）；因此，事件源 objA 對事件監聽對象 objB 存在一個引用。

如果 objB 不再使用，我們要銷毀它，但由于 objA 引用了它，所以它不會被銷毀、回收；它要等到 objA 銷毀時，才能被銷毀。所以本來需要被銷毀的對象，卻因有其它對象對它的引用，結果造成了內存泄露。

如何解決

再回到自定義控件的問題上，因為我們的自定義控件，可能會被重寫樣式或者重寫模板，這會使 OnApplyTemplate 方法在這個自定義控件的生命周期內被執行多次。所以，我們需要為那些通過 GetTemplateChild 方法得到并且又添加了事件處理的控件（如上述代碼中的 btnView 控件）進行事件反注冊。因為這些都是前一個模板中的控件（元素），當反注冊后，原來的控件與事件監聽者（自定義控件本身）就不存在引用關系，從而避免了內存泄露的問題。

根據我們的解決思路，對之前的代碼重構如下：

private Button btnView = null;
  public override void OnApplyTemplate()
  {
   base.OnApplyTemplate();
   // 先反注冊事件
   if (btnView != null)
   {
    btnView.Click -= BtnView_Click;
   }
   btnView = GetTemplateChild("PART_ViewButton") as Button;
   if (btnView != null)
   {
    btnView.Click += BtnView_Click;
   }
  }
  private void BtnView_Click(object sender, RoutedEventArgs e)
  {
   // 這里寫響應邏輯
  }

這樣，就解決了本文開頭所說的問題。不過，接下來，我們還需要做一點調整。

進一步重構

試想，如果我們的自定義控件中，有多個類似像前述 btnView 這樣的控件，我們就要將上面的代碼在 OnApplyTemplate 方法中復制若干次，從而導致 OnApplyTemplate 方法的復雜度增加，以及代碼的可讀性變差 。

為了改善這一點，我們將每個控件以及它的事件注冊與反注冊封裝一下。

重構后，代碼如下：

protected const string PART_ViewButton = nameof(PART_ViewButton);
    private Button btnView = null;
    public Button ViewButton
    {
      get
      {
        return btnView;
      }
      set
      {
        // 先反注冊事件
        if (btnView != null)
        {
          btnView.Click -= BtnView_Click;
        }
        btnView = value;
        if (btnView != null)
        {
          btnView.Click += BtnView_Click;
        }
      }
    }
    public override void OnApplyTemplate()
    {
      base.OnApplyTemplate();
      ViewButton = GetTemplateChild(PART_ViewButton) as Button;
    }
    private void BtnView_Click(object sender, RoutedEventArgs e)
    {
      // 這里寫響應邏輯
    }

針對最終的代碼，這里再提幾點：

1. 在 OnApplyTemplate 方法中，建議一開始要先調用 base.OnApplyTemplate();

2. 無論在為控件反注冊事件，還是注冊事件時，都要對控件是否為空進行判斷，這是因為有可能用戶重寫模板時沒有遵循 TemplatePart 屬性中所指定的控件名稱；

3. 將控件的名稱聲明為常量，可以避免字符串拼寫錯誤；

以上是“XAML自定義控件中事件處理的示例分析”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！