[UWP]瞭解TypeConverter_ZenDei技術網路在線

1. 前言 TypeConverter是XAML解釋器的幕後功臣，它做了大量工作，從WPF誕生以來，幾乎每一次XAML的運作都有它的參與。雖然UWP中TypeConverter已經徹徹底底退居幕後，連自定義TypeConverver都不可以，但瞭解TypeConverter的原理對理解XAML解析器 ...

1. 前言

TypeConverter是XAML解釋器的幕後功臣，它做了大量工作，從WPF誕生以來，幾乎每一次XAML的運作都有它的參與。雖然UWP中TypeConverter已經徹徹底底退居幕後，連自定義TypeConverver都不可以，但瞭解TypeConverter的原理對理解XAML解析器的運作方式總是有幫助的。

2. .Net中的TypeConverter

TypeConverter在.NET 的早期版本中就已經存在，它可以將一種類型的值轉換為其它類型，典型的用法是在數據類型和字元串之間轉換。

假設要實現一個從字元串轉換成目標類型的函數GetValue：

private T GetValue<T>(string source)
{
    var type = typeof(T);
    T result;
    if (type == typeof(bool))
    {
        result = (T)(object)Convert.ToBoolean(source);
    }
    else if (type == typeof(string))
    {
        result = (T)(object)source;
    }
    else if (type == typeof(short))
    {
        result = (T)(object)Convert.ToInt16(source);
    }
    else if (type == typeof(int))
    {
        result = (T)(object)Convert.ToInt32(source);
    }
    else
    {
        result = default(T);
    }

    return result;
}

這個函數有很多明顯的問題：代碼冗餘、支持的類型不多、難以維護、不符合開放封閉原則等。使用Convert.ChangeType可以將代碼重構如下：

private T GetValue<T>(string source)
{
    return (T)Convert.ChangeType(source, typeof(T));
}

只用一行代碼，看上去簡直完美。但想深一層，Convert類的註釋是“將一個基本數據類型轉換為另一個基本數據類型。”也就是說它只支持基礎類型，事實上ChangeType函數的源碼只是上面GetValue的高級版本而已：

public static Object ChangeType(Object value, Type conversionType, IFormatProvider provider) {
    if( conversionType == null) {
        throw new ArgumentNullException("conversionType");
    }
    Contract.EndContractBlock();

    if( value == null ) {
        if(conversionType.IsValueType) {
            throw new InvalidCastException(Environment.GetResourceString("InvalidCast_CannotCastNullToValueType"));
        }
        return null; 
    }

    IConvertible ic = value as IConvertible;
    if (ic == null) {
        if ( value.GetType() == conversionType) {
            return value;
        }
        throw new InvalidCastException(Environment.GetResourceString("InvalidCast_IConvertible"));
    }

    RuntimeType rtConversionType = conversionType as RuntimeType;

    if (rtConversionType==ConvertTypes[(int)TypeCode.Boolean])
        return ic.ToBoolean(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Char])
        return ic.ToChar(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.SByte])
        return ic.ToSByte(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Byte])
        return ic.ToByte(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Int16]) 
        return ic.ToInt16(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.UInt16])
        return ic.ToUInt16(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Int32])
        return ic.ToInt32(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.UInt32])
        return ic.ToUInt32(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Int64])
        return ic.ToInt64(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.UInt64])
        return ic.ToUInt64(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Single])
        return ic.ToSingle(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Double])
        return ic.ToDouble(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Decimal])
        return ic.ToDecimal(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.DateTime])
        return ic.ToDateTime(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.String])
        return ic.ToString(provider);
    if (rtConversionType==ConvertTypes[(int)TypeCode.Object])
        return (Object)value;

    return ic.ToType(conversionType, provider);
}

TypeConverter的一個典型應用場景就是用於解決這個問題。使用TypeConverter重構這個函數如下：

private T GetValue<T>(string source)
{
    var typeConverter = TypeDescriptor.GetConverter(typeof(T));
    if (typeConverter.CanConvertTo(typeof(T)))
        return (T)typeConverter.ConvertFromString(source);

    return default(T);
}

TypeConverter GetConverter(Type type) 返回指定類型的TypeConverter，此方法可查找通過查找相應的 TypeConverterAttribute，如果找不到 TypeConverterAttribute, ，該代碼遍歷類的基類層次結構，直到它找到的基元類型。使用TypeConverter不需要擔心可以轉換的數據類型太少，BCL中已實現了一大堆繼承TypeConverter的類，基本滿足日常使用。除了這些已實現的TypeConverter，還可以實現自己的TypeConverter，擴展性方面完全沒有問題。

值得一提的是，如果使用了錯誤的字元串，Convert.ChangeType只提示“輸入字元串的格式不正確”。而TypeConverter的錯誤提示則詳細得多："a 不是 Decimal 的有效值"。

3. WPF中的TypeConverter

XAML本質上是XML，其中的屬性內容全部都是字元串。如果對應屬性的類型是XAML內置類型（即Boolea,Char,String,Decimal,Single,Double,Int16,Int32,Int64,TimeSpan,Uri,Byte,Array等類型），XAML解析器直接將字元串轉換成對應值賦給屬性；對於其它類型，XAML解析器需做更多工作。

<Grid.RowDefinitions>
    <RowDefinition Height="Auto"/>
    <RowDefinition Height="*"/>
</Grid.RowDefinitions>

如上面這段XAML中的"Auto"和"*"，XAML解析器將其分別解析成GridLength.Auto和new GridLength(1, GridUnitType.Star)再賦值給Height，它相當於這段代碼：

grid.RowDefinitions.Add(new RowDefinition { Height = GridLength.Auto });
grid.RowDefinitions.Add(new RowDefinition { Height = new GridLength(1, GridUnitType.Star) });

為了完成這個工作，XAML解析器需要TypeConverter的協助。XAML解析器通過兩個步驟查找TypeConverter：
1. 檢查屬性聲明上的TypeConverterAttribute。
2. 如果屬性聲明中沒有TypeConverterAttribute，檢查類型聲明中的TypeConverterAttribute。

屬性聲明上TypeConverterAttribute的優先順序高於類型聲明。如果以上兩步都找不到類型對應的TypeConverterAttribute，XAML解析器將會報錯：屬性"*"的值無效。找到TypeConverterAttribute指定的TypeConverter後，XAML解析器調用它的object ConvertFromString(string text)函數將字元串轉換成屬性的值。

WPF內置的TypeConverter十分十分多，但有時還是需要自定義TypeConverter，一種情況是難以用字元串直接構建的類型，一種是為了簡化XAML。

假設有三個類Email、Receiver、ReceiverCollection，結構如下：

public class Email
{
    public ReceiverCollection Receivers { get; set; }
}

public class Receiver
{
    public string Name { get; set; }
}

public class ReceiverCollection : ObservableCollection<Receiver>
{
}

在XAML中構建一個Email對象及填充Receiver列表的代碼如下：

<local:Email x:Key="Email">
    <local:Email.Receivers>
        <local:ReceiverCollection>
            <local:Receiver Name="Zhao"/>
            <local:Receiver Name="Qian"/>
            <local:Receiver Name="Sun"/>
            <local:Receiver Name="Li"/>
            <local:Receiver Name="Zhou"/>
            <local:Receiver Name="Wu"/>
        </local:ReceiverCollection>
    </local:Email.Receivers>
</local:Email>

語法這麼複雜，這時候就需要考慮自定義一個ReceiverCollectionConverter了。自定義TypeConverter的基本步驟如下：

創建一個繼承自TypeConverter的類；
重載virtual bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType);
重載virtual bool CanConvertTo(ITypeDescriptorContext context, Type destinationType);
重載virtual object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value);
重載virtual object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType);
使用TypeConverterAttribute 指示XAML解析器可用的TypeConverter；

代碼如下：

[TypeConverter(typeof(ReceiverCollectionConverter))]
public class ReceiverCollection : ObservableCollection<Receiver>
{
    public static ReceiverCollection Parse(string source)
    {
        var result = new ReceiverCollection();
        var tokens = source.Split(';');
        foreach (var token in tokens)
        {
            result.Add(new Receiver { Name = token });
        }
        return result;
    }

    public string ConvertToString()
    {
        var result = string.Empty;
        foreach (var item in this)
        {
            result += item.Name;
            result += ";";
        }
        return result;
    }
}

public class ReceiverCollectionConverter : TypeConverter
{
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        if (sourceType == typeof(string))
        {
            return true;
        }

        return base.CanConvertFrom(context, sourceType);
    }


    public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
    {
        if (destinationType == typeof(string))
        {
            return true;
        }

        return base.CanConvertTo(context, destinationType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        switch (value)
        {
            case null:
                throw GetConvertFromException(null);
            case string source:
                return ReceiverCollection.Parse(source);
        }

        return base.ConvertFrom(context, culture, value);
    }

    public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
    {
        switch (value)
        {
            case ReceiverCollection instance:
                if (destinationType == typeof(string))
                {
                    return instance.ConvertToString();
                }
                break;
        }

        return base.ConvertTo(context, culture, value, destinationType);
    }
}

結果上面那的那段XAML可以簡化成一句代碼：

<local:Email Receivers="Zhao;Qian;Sun;Li;Zhou;Wu" x:Key="Email"/>

除了可以在類型上聲明TypeConverterAttribute，還可以在屬性上聲明，屬性上的聲明優先順序較高：

public class Email
{
    [TypeConverter(typeof(ReceiverCollectionConverterExtend))]
    public ReceiverCollection Receivers { get; set; }
}

4. UWP中的TypeConverter

在UWP中TypeConverter已徹底退居幕後，要實現上面ReceiverCollectionConverter 的簡化XAML效果，可以用CreateFromStringAttribute（自Aniverssary Update(14393)後可用，但好像常常報錯，直接升到Creators Update(15063)比較好）：

[Windows.Foundation.Metadata.CreateFromString(MethodName = "TypeConverterUwp.ReceiverCollection.Parse")]
public class ReceiverCollection : ObservableCollection<Receiver>
{
    public static ReceiverCollection Parse(string source)
    {
        var result = new ReceiverCollection();
        var tokens = source.Split(';');
        foreach (var token in tokens)
        {
            result.Add(new Receiver { Name = token });
        }
        return result;
    }
}

CreateFromStringAttribute的效果和TypeConverterAttribute差不多，可是它只能用在類上，不能用於屬性。即使提供了這個補償方案，不能自定義TypeConverter對UWP的影響還是很大。UWP有XAML 固有數據類型的概念（即可以直接在XAML上使用的數據類型），只包含Boolean、String、Double、Int32四種，而內置的TypeConverter又十分少，導致連decimal都沒有獲得支持.

有趣的是VisualStudio的屬性面板還天真地以為自己支持直接輸入Decimal，甚至設計視圖還可以正常顯示，但編譯報錯。通過引用System.ComponentModel.TypeConverter的NuGet包連TypeConverterAttribute都可以添加，但這個Attribute沒有任何實際效果。

public class MyContentControl : ContentControl
{
    /// <summary>
    /// 獲取或設置Amount的值
    /// </summary>  
    [TypeConverter(typeof(DecimalConverter))]
    public Decimal Amount
    {
        get { return (Decimal)GetValue(AmountProperty); }
        set { SetValue(AmountProperty, value); }
    }

    /// <summary>
    /// 標識 Amount 依賴屬性。
    /// </summary>
    public static readonly DependencyProperty AmountProperty =
        DependencyProperty.Register("Amount", typeof(Decimal), typeof(MyContentControl), new PropertyMetadata(0m, OnAmountChanged));

    private static void OnAmountChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
    {
        MyContentControl target = obj as MyContentControl;
        Decimal oldValue = (Decimal)args.OldValue;
        Decimal newValue = (Decimal)args.NewValue;
        if (oldValue != newValue)
            target.OnAmountChanged(oldValue, newValue);
    }

    protected virtual void OnAmountChanged(Decimal oldValue, Decimal newValue)
    {
        Content = "Amount is " + newValue;
    }
}

當看到如上圖那樣的錯誤信息，可以理解為UWP缺少對應類型的TypeConverter，只能在CodeBehind為屬性賦值。如果一定要在XAML上為decimal賦值，可以用Binding。

public class StringToDecimalBridge
{
    public Decimal this[string key]
    {
        get
        {
            return Convert.ToDecimal(key);
        }
    }
}

<local:MyContentControl  Amount="{Binding [10.3],Source={StaticResource StringToDecimalBridge}}"/>

5. 結語

因為本地化的文章提到TypeConverter，正好手頭的工作要用到TypeConverter，所以才想寫一篇文章介紹這個概念。結果才發現UWP的TypeConverter不能直接使用，偏偏這個概念對理解XAML解析器很重要，正好把WPF的內容也拿來討論一下。

6. 參考

TypeConverter 類
 TypeConverters 和 XAML
Type Converters for XAML Overview
TypeConverterAttribute Class
如何：實現類型轉換器
 XAML 固有數據類型
 CreateFromStringAttribute Class

7. 源碼

GitHub - TypeConverterSample