美学原理[UWP]领会TypeConverter

美学原理,5. 结语

因为本地化的文章提到TypeConverter,正好手头的做事要用到TypeConverter,所以才想写一篇文章介绍这一个定义。结果才察觉UWP的TypeConverter不能够一贯运用,偏偏那一个概念对精晓XAML解析器很重庆大学,正好把WPF的剧情也拿来斟酌一下。

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 的有效值”。

1. 前言

TypeConverter是XAML解释器的私自功臣,它做了大批量干活,从WPF诞生以来,大概每三回XAML的运转都有它的插足。即使UWP中TypeConverter已经彻彻底底退居幕后,连自定义TypeConverver都无法,但了解TypeConverter的规律对精晓XAML解析器的周转格局连接有援助的。

6. 参考

TypeConverter
.aspx)
TypeConverters 和
XAML
.aspx)
Type Converters for XAML
Overview

TypeConverterAttribute
Class

什么:达成项目转换器.aspx)
XAML
固有数据类型

CreateFromStringAttribute
Class

7. 源码

GitHub –
TypeConverterSample

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}}"/>

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中营造2个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; }
}