はじめに
string型の変数をint型もしくはenum型に変換することを考えます。変換の直前まで変換後の型は分からず動的に変換することを想定しています。
// 結果確認用プログラム
class Program
{
// 変換後のenum
enum Status
{
Success = 0,
Error = 99,
}
static void Main(string[] args)
{
{
var convertedText = ConvertToTextType<int>("99");
Console.WriteLine(convertedText.GetType().Name + ", " + convertedText);
// Int32, 99
}
{
var convertedText = ConvertToTextType<Status>("99");
Console.WriteLine(convertedText.GetType().Name + ", " + convertedText);
// Status, Error
}
}
// text を 型 T に変換するメソッド
private static object ConvertToTextType<T>(string text)
{
// ここに何か実装したい
}
}
結果確認用として、文字列99をint型およびenum型に変換できているか確認するプログラムを用意しました。型変換の具体的な実装はメソッドConvertToTextTypeで行うものとしパラメータTで変換後の型を指定します。
自力で実装した場合
はじめに自力で実装するとどのような感じになるのか確認します。
// text を 型 T に変換するメソッド
private static object ConvertToTextType<T>(string text) where T : struct
{
if (typeof(T) == typeof(int))
{
var canConvert = int.TryParse(text, out int result);
if (!canConvert)
{
throw new Exception("エラー");
}
return result;
}
else if (typeof(T).IsEnum)
{
var canConvert = Enum.TryParse(text, out T result);
if (!canConvert)
{
throw new Exception("エラー");
}
return result;
}
return default(T);
}
適当に実装した例がこちらです。変換後の型を自力で調べ、エラー処理をし、変換したものを返すという構造になっています。これには以下のような課題があります。
- エラー処理を自前で実装しなければいけない。
- 変換後の型が増えるたびにif文が増えていき冗長となる。例えばdouble型への変換も追加したいとなった場合。
以降このメソッドに改良を加えたいと思います。
TypeConverterを利用
// text を 型 T に変換するメソッド
private static object ConvertToTextType<T>(string text)
{
if (typeof(T) == typeof(int))
{
var converter = new Int32Converter();
return converter.ConvertFrom(text);
}
else if (typeof(T).IsEnum)
{
var converter = new EnumConverter(typeof(T));
return converter.ConvertFrom(text);
}
return default(T);
}
.NetFrameWorkのTypeConverterクラスのサブクラスであるInt32Converter、EnumConverterを用いて先程のプログラムを改良したものがこちらです。既存のクラスを利用したことでエラー処理を自前で実装する必要がなくなりました。
しかし先程にもあった、変換後の型が増えるたびにif文が増えていくという課題が残っています。
TypeDescriptor.GetConverterを利用
// text を 型 T に変換するメソッド
private static object ConvertToTextType<T>(string text)
{
var converter = TypeDescriptor.GetConverter(typeof(T));
return converter.ConvertFrom(text);
}
上記を更に改良し、型を判別するためのif文を書かなくてすむように改良したのがこちらです。.NetFrameWorkのTypeDescriptor.GetConverterメソッド利用して、先程は自力で行っていたTypeConverterの生成を肩代わりさせています。TがintならconverterにInt32Converterが、enumならEnumConverterが設定されます。
これによって自力で実装する場合に比べてシンプルに型変換のプログラムを記述できることが確認できました。
TypeDescriptor.GetConverterで自作クラスを扱いたい場合
TypeDescriptor.GetConverterメソッドで引数に自作クラスを設定して動作させてもうまく動かないと思います。動作させたい場合は変換後のクラスに対してTypeConverterAttributeを設定する必要があります。
class Program
{
static void Main(string[] args)
{
// string型からMyClass型への変換
var converter = TypeDescriptor.GetConverter(typeof(MyClass));
var convertedItem = converter.ConvertFrom("aaa");
}
}
[TypeConverter(typeof(MyConverter))]
public class MyClass
{
public string X { get; set; }
}
// 自作Converter
public class MyConverter : TypeConverter
{
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
if (value is string)
{
return new MyClass { X = (string)value };
}
return base.ConvertFrom(context, culture, value);
}
}
ここでは変換後の自作クラスMyClassに対して、自作したMyConverterをTypeConverterAttributeに渡すことでTypeDescriptor.GetConverterでも扱えるようになっています。これによってstring型をMyClass型に変換できるようになりました。
MyConverterの実装は簡略化しています。詳しくは下記リンクが参考になると思います。
参考: 型コンバーターを実装する
まとめ
-
TypeDescriptor.GetConverterを使うと動的な型変換を楽に実装できる。 - 変換後のクラスが自作クラスであっても
TypeConverterAttributeを利用することでTypeDescriptor.GetConverterで汎用的に扱える。