[UWP]了解TypeConverter

C#

浏览数:101

2019-5-16

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

作者:dino.c