クラスにカスタムキャストサポートを提供するにはどうすればよいですか?


102

クラスを他の型にキャストするためのサポートを提供するにはどうすればよいですか?たとえば、を管理する独自の実装があり、プライベートメンバーを返すだけのbyte[]クラスをにキャストさせたい場合、どうすればbyte[]よいですか?

これも文字列にキャストできるようにするのは一般的な方法ですか、それともオーバーライドToString()(またはその両方)だけにする必要がありますか?

回答:


112

変換演算子をオーバーライドする必要があります。これは、ユーザーがキャストする必要があるかどうか、または自動的に実行するかどうかのいずれimplicitかを使用するか、それexplicitによって異なります。通常、一方の方向が常に機能します。これが使用する場所implicitであり、もう一方の方向が失敗することがありますexplicit。それが使用する場所です。

構文は次のとおりです。

public static implicit operator dbInt64(Byte x)
{
    return new dbInt64(x);
}

または

public static explicit operator Int64(dbInt64 x)
{
    if (!x.defined)
        throw new DataValueNullException();
    return x.iVal;
}

あなたの例では、カスタムタイプから言います(MyType-> byte[]は常に機能します):

public static implicit operator byte[] (MyType x)
{
    byte[] ba = // put code here to convert x into a byte[]
    return ba;
}

または

public static explicit operator MyType(byte[] x)
{
    if (!CanConvert)
        throw new DataValueNullException();

    // Factory to convert byte[] x into MyType
    MyType mt = MyType.Factory(x);
    return mt;
}

36

explicitまたはimplicitキーワードを使用して、クラスで変換演算子を宣言できます。

一般的な経験則として、implicit変換が失敗する可能性がない場合にのみ変換演算子を提供する必要があります。explicit変換が失敗する可能性がある場合は、変換演算子を使用します。

public class MyClass
{
    private byte[] _bytes;

    // change explicit to implicit depending on what you need
    public static explicit operator MyClass(byte[] b)
    {
        MyClass m = new MyClass();
        m._bytes = b;
        return m;
    }

    // change explicit to implicit depending on what you need
    public static explicit operator byte[](MyClass m)
    {
        return m._bytes;
    }
}

を使用explicitすると、クラスのユーザーは明示的な変換を行う必要があります。

byte[] foo = new byte[] { 1, 2, 3, 4, 5 };
// explicitly convert foo into an instance of MyClass...
MyClass bar = (MyClass)foo;
// explicitly convert bar into a new byte[] array...
byte[] baz = (byte[])bar;

を使用implicitすると、クラスのユーザーは明示的な変換を実行する必要がなくなり、すべて透過的に行われます。

byte[] foo = new byte[] { 1, 2, 3, 4, 5 };
// imlpicitly convert foo into an instance of MyClass...
MyClass bar = foo;
// implicitly convert bar into a new byte[] array...
byte[] baz = bar;

6

キャスト演算子をオーバーロードするのではなく、それを行ういくつかのメソッドを使用することを好みます。

参照の明示的および暗黙のC#のが、あなたがしなければその例から、明示的な方法を使用していることをメモして:

string name = "Test";
Role role = (Role) name;

その後、すべてが正常です。ただし、使用する場合:

object name = "Test";
Role role = (Role) name;

文字列をRoleにキャストできないため、InvalidCastExceptionが発生します。コンパイラは、コンパイル時に、コンパイルされた型に基づいて暗黙的/明示的キャストのみを検索します。この場合、コンパイラは名前を文字列ではなくオブジェクトと見なし、ロールのオーバーロードされた演算子を使用しません。


リンクした例を見ると、キャストごとにオブジェクトの新しいインスタンスが作成されているようです。クラスの現在のメンバーで操作のタイプを取得/設定する方法はありますか?
esac 2009

3

カスタムキャストサポートの場合は、キャスト演算子(明示的または暗黙的)を提供する必要があります。次のEncodedStringクラスの例は、カスタムエンコーディングを使用した文字列の単純化した実装です(.Net文字列はUnicodeであり、すべての文字が2バイトのメモリを消費するため、巨大な文字列を処理してメモリ消費の問題が発生する場合に役立ちます。 EncodedStringは文字ごとに1バイトを使用できます)。

EncodedStringは、byte []およびSystem.Stringに変換できます。コード内のコメントは、いくつかの光を放ち、暗黙の変換が危険な場合の例も説明します。

通常、変換演算子を最初に宣言するのに十分な理由が必要です。

詳細については、MSDNを参照してください

class Program
{
    class EncodedString
    {
        readonly byte[] _data;
        public readonly Encoding Encoding;

        public EncodedString(byte[] data, Encoding encoding)
        {
            _data = data;
            Encoding = encoding;
        }

        public static EncodedString FromString(string str, Encoding encoding)
        {
            return new EncodedString(encoding.GetBytes(str), encoding);
        }

        // Will make assumption about encoding - should be marked as explicit (in fact, I wouldn't recommend having this conversion at all!)
        public static explicit operator EncodedString(byte[] data)
        {
            return new EncodedString(data, Encoding.Default);
        }

        // Enough information for conversion - can make it implicit
        public static implicit operator byte[](EncodedString obj)
        {
            return obj._data;
        }

        // Strings in .Net are unicode so we make no assumptions here - implicit
        public static implicit operator EncodedString(string text)
        {
            var encoding = Encoding.Unicode;
            return new EncodedString(encoding.GetBytes(text), encoding);
        }

        // We have all the information for conversion here - implicit is OK
        public static implicit operator string(EncodedString obj)
        {
            return obj.Encoding.GetString(obj._data);
        }
    }

    static void Print(EncodedString format, params object[] args)
    {
        // Implicit conversion EncodedString --> string
        Console.WriteLine(format, args);
    }

    static void Main(string[] args)
    {
        // Text containing russian letters - needs care with Encoding!
        var text = "Привет, {0}!";

        // Implicit conversion string --> EncodedString
        Print(text, "world");

        // Create EncodedString from System.String but use UTF8 which takes 1 byte per char for simple English text
        var encodedStr = EncodedString.FromString(text, Encoding.UTF8);
        var fileName = Path.GetTempFileName();

        // Implicit conversion EncodedString --> byte[]
        File.WriteAllBytes(fileName, encodedStr);

        // Explicit conversion byte[] --> EncodedString
        // Prints *wrong* text because default encoding in conversion does not match actual encoding of the string
        // That's the reason I don't recommend to have this conversion!
        Print((EncodedString)File.ReadAllBytes(fileName), "StackOverflow.com");

        // Not a conversion at all. EncodingString is instantiated explicitly
        // Prints *correct* text because encoding is specified explicitly
        Print(new EncodedString(File.ReadAllBytes(fileName), Encoding.UTF8), "StackOverflow.com");

        Console.WriteLine("Press ENTER to finish");
        Console.ReadLine();
    }
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.