[UWP]了解TypeConverter

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,扩展性方面了无问题。

图片 1

值得一提的是,如果利用了错的字符串,Convert.ChangeType只提示“输入字符串的格式不得法”。
而TypeConverter的错误提示则详细得几近:”a 不是 Decimal 的有效值”。

3. WPF中的TypeConverter

XAML本质上是XML,其中的性质内容全部都是字符串。如果对应属性的花色是XAML内置类型.aspx)(即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;
    }
}

图片 2

当张如达到图那样的错误信息,可以掌握也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
类.aspx)
TypeConverters 和
XAML.aspx)
Type Converters for XAML
Overview
TypeConverterAttribute
Class
怎么样:实现类型转换器.aspx)
XAML
固有数据类型
CreateFromStringAttribute
Class

7. 源码

GitHub –
TypeConverterSample