Xamarin Bindableproperty 可綁定屬性

本文翻譯自微軟官方 Bindable Properties, 介紹了可綁定屬性，並演示瞭如何創建和使用它們。可綁定屬性是一種特殊類型的屬性，其中屬性的值由Xamarin.Forms屬性系統跟蹤。 ...

重要的事情說三遍：

　　本文基本是取自微軟官方 Bindable Properties, 官方也提供了機翻的中文版本，筆者只是嘗試用自己的理解描述一遍，便於記憶。如有不對之處，歡迎拍磚。

概述

　　首先來說說Bindableproperty是什麼？官方的說是：在Xamarin.Forms中，公共語言運行時(CLR)的屬性(properites)的功能由bindable properties來擴展。它是一種特殊的屬性，特殊的點在於它的值是被Xamarin.Foms的屬性系統跟蹤的。

　　它是通過使用備份一個BindableProperty的類型來實現擴展property的功能的，而不是使用備份field的方式。它的目標是提供這樣一個屬性系統，這個系統支持類似於父子關係的方式來設置數據綁定，樣式更改等等。此外，它還額外提供了一些別的功能，如設置預設值，驗證屬性合法性，提供屬性更改時的回調函數等等。

　　上面兩段內容確實很繞，換成筆者的理解是：利用BindableProperty來創建的屬性不同於我們平常所使用的形如 public string abc { get; set; } 這樣的普通屬性，它額外提供了對數據綁定，以及相關方法的支持。這種功能是通過Xamrin.Forms這個框架自身對bindable properties的值的追蹤來實現的。

　　如果你有下麵的某些功能的需求，那麼你就應該使用bindable properties

作為數據綁定的有效目標值。（註意這裡是目標值(target),而不是源(source)）
通過樣式來設置屬性
提供一個與該屬性本身預設值不同的預設值。(如int的預設值是0，如果你想預設指定為別的值，可以使用bindable properties。原文是 Providing a default property value that's different from the default for the type of the property.
驗證屬性的值
監控這個屬性值的變更

　　舉個例子，Xamarin.Forms自帶的如 Label.Text，Button.BorderRadius，StackLayout.Orientation等等都是可綁定屬性。任何一個可綁定的屬性在其所在的class內都有一個由pubilc static readonly property修飾的BindableProperty對應。加粗的這句話不是很好理解，舉個例子。如前面提到的Xamarin.Forms自帶的Lable.Text是一個可綁定屬性，那麼在Lable這個類中也一定包含這樣的定義

public static readonly Xamarin.Forms.BindableProperty TextProperty;

創建和實用可綁定屬性

　　可以使用如下的流程來創建可綁定屬性：

利用 BindableProperty.Create方法來創建一個BindableProperty的實例。(該方法包括多個重載)。
為第一步驟中創建的實例定義一個屬性訪問器。

　　請註意，所有的可綁定屬性都必須在UI Thread上創建。這意味著只有跑在UI Thread上的代碼可以獲取(get)或改變(set)可綁定屬性的值。然而，可以通過使用Device.BeginInvokeOnMainThread方法將可綁定屬性的實例封送到UI Thread,來實現從其他線程訪問。(這句的翻譯不是很準確，原文是：However, BindableProperty instances can be accessed from other threads by marshaling to the UI thread with the Device.BeginInvokeOnMainThread method.)

　　創建

　　包含BindableProperty屬性的類必須派生自BindableObject，但BindableObject繼承關係中處於較高的位置，因此大部分用於UI的類都支持可綁定屬性。

　　通過使用public static readonly來聲明一個可綁定屬性，使用BindableProperty.Create的某個重載來創建它。此處要註意可綁定屬性應該定義在BindableObject派生類的主體內，並且在該類任何成員的外部。

　　創建可綁定屬性時至少應該指定下麵所需的參數：

可綁定屬性的name
該屬性的類型(The type of the property)
包含整個屬性的類的類型(The type of the owning object)
預設值。這個預設值可設置為屬性本身的預設值不同，如創建一個int類型的可綁定屬性可將這裡的預設值設置為5，而不是使用int自身的預設值0。此外，當調用ClearValue方法時也將會把值重置為我們定義的預設值。

　　例如：

public static readonly BindableProperty EventNameProperty =
  BindableProperty.Create ("EventName", typeof(string), typeof(EventToCommandBehavior), null);

　　這段代碼將創建一個名為“EventName”,string類型的可綁定屬性的實例。它屬於EventToCommandBehavior這個類，並且預設值是null。可綁定屬性的命名規範要求其必須與Create方法中所指定的name相匹配，併在後面追加"Property"。如上面的代碼,EventName與EventNameProperty。

　　此外，在創建BindableProperty的實例時，還可以指定以下的一些參數

綁定模式，這裡不用多說了，就是綁定中所對應的那幾種模式。這裡的預設值是source to target。
設置屬性時所使用的驗證方法的委托。
屬性更改完成時所調用方法的委托。
屬性更改將要發生時所調用的方法的委托，此方法與更改完成時的方法具有相同的簽名。
屬性更改時調用的“強制值”委托。（A coerce value delegate that will be invoked when the property value has changed.）
用於初始化預設屬性值的Func委托。

　　創建屬性訪問器

　　需要使用屬性語法(property syntax)來創建可用於訪問可綁定屬性的屬性訪問器。Get方法需要利用GetValue從對應的BindableProperty中獲取值，再使用類型轉換拿到所需的值。Set方法需要使用SetValue方法來為其複製。例如

public string EventName {
  get { return (string)GetValue (EventNameProperty); }
  set { SetValue (EventNameProperty, value); }
}

　　使用可綁定屬性

　　一旦聲明瞭可綁定屬性就可以在XAML和C#代碼中使用它。在XAML中，還需要先聲明帶有首碼的命名空間，這個空間中包含著我們創建的可綁定屬性所屬的類。在XAML中

　　聲明

<ContentPage ... xmlns:local="clr-namespace:EventToCommandBehavior" ...>
  ...
</ContentPage>

　　使用

<ListView ...>
  <ListView.Behaviors>
    <local:EventToCommandBehavior EventName="ItemSelected" ... />
  </ListView.Behaviors>
</ListView>

　　等效的C#代碼

var listView = new ListView ();
listView.Behaviors.Add (new EventToCommandBehavior {
  EventName = "ItemSelected",
  ...
});

進階使用場景

　　檢測屬性更改

　　在利用BindableProperety.Create方法創建可綁定屬性的實例時可以通過propertyChanged參數來註冊一個靜態的回調方法，該方法會在可綁定屬性的值發生變更時執行。例如：

public static readonly BindableProperty EventNameProperty =
  BindableProperty.Create (
    "EventName", typeof(string), typeof(EventToCommandBehavior), null, propertyChanged: OnEventNameChanged);
...

static void OnEventNameChanged (BindableObject bindable, object oldValue, object newValue)
{
  // Property changed implementation goes here
}

　　OnEventNameChanged方法中的參數BindableObject bindable用於指定是哪個實例在執行這個方法，後面兩個參數就不解釋了。

　　用於驗證屬性的回調函數

　　註冊方法與上面類似，直接貼代碼

public static readonly BindableProperty AngleProperty =
  BindableProperty.Create ("Angle", typeof(double), typeof(HomePage), 0.0, validateValue: IsValidValue);
...

static bool IsValidValue (BindableObject view, object value)
{
  double result;
  bool isDouble = double.TryParse (value.ToString (), out result);
  return (result >= 0 && result <= 360);
}

　　驗證屬性的這個方法會根據接收到的參數的值以及你定義好的邏輯來判斷它是否通過驗證。如果沒有通過驗證則返回false,開發需要處理這種情況。(如ui上style的變更，以提示用戶輸入值不滿足要求等等)。如上面代碼中的例子，被驗證的值只有在處於[0,360]才能驗證通過。

　　強制值回調（Coerce Value Callback）

　　註冊方法與上面類似，直接貼代碼

public static readonly BindableProperty AngleProperty = BindableProperty.Create (
  "Angle", typeof(double), typeof(HomePage), 0.0, coerceValue: CoerceAngle);
public static readonly BindableProperty MaximumAngleProperty = BindableProperty.Create (
  "MaximumAngle", typeof(double), typeof(HomePage), 360.0);
...

static object CoerceAngle (BindableObject bindable, object value)
{
  var homePage = bindable as HomePage;
  double input = (double)value;

  if (input > homePage.MaximumAngle) {
    input = homePage.MaximumAngle;
  }

  return input;
}

　　這裡需要說明一下。coerceValue方法會在屬性值發生變更時調用。它用於在屬性值變更時重新改變屬性的值。如上面的代碼所示，可以使用它來確保一個可綁定屬性的值不大於另一個可綁定屬性的值。該CoerceAngle方法檢查MaximumAngle屬性的值，如果Angle屬性值大於它，則它會將值強制轉換為MaximumAngle屬性值。

　　使用Func創建預設值

　　貼代碼

public static readonly BindableProperty SizeProperty =
  BindableProperty.Create ("Size", typeof(double), typeof(HomePage), 0.0,
  defaultValueCreator: bindable => Device.GetNamedSize (NamedSize.Large, (Label)bindable));

　　此處使用一個Device.GetNamedSize方法來獲取在原生平臺(native platform)上lable的字體大小，並將其設置為SizeProperty的預設值。