web-dev-qa-db-ja.com

構造体を不変にするにはどうすればよいですか?

Stack Overflowとインターネットの至る所で、構造体を不変に保つことは優れた設計原則であると思います。残念ながら、これらの構造体を実際に不変にする実装は見たことがありません。

構造体内に参照型がないと仮定すると、実際に構造を不変にするにはどうすればよいですか?つまり、プリミティブフィールドの変更を防ぐにはどうすればよいでしょう(おそらくコンパイル時/実行時の例外による)。

私は、構造体を不変にしようとする簡単なテストを書きましたが、System.ComponentModel.ImmutableObjectAttribute機能しました:

class Program
{
    static void Main(string[] args)
    {
        ImmutableStruct immStruct1 = new ImmutableStruct();
        Console.WriteLine(immStruct1); //Before mutation.

        immStruct1.field1 = 1;
        immStruct1.field2 = "Hello";
        immStruct1.field3 = new object();
        Console.WriteLine(immStruct1); //After 1st mutation.

        immStruct1.field1 = 2;
        immStruct1.field2 = "World";
        immStruct1.field3 = new object();
        Console.WriteLine(immStruct1); //After 2nd mutation.

        Console.ReadKey();
    }
}

[ImmutableObject(true)]
struct ImmutableStruct
{
    public int field1;
    public string field2;
    public object field3;

    public override string ToString()
    {
        string field3String = "null";
        if (field3 != null)
        {
            field3String = field3.GetHashCode().ToString();
        }
        return String.Format("Field1: {0}, Field2: {1}, Field3: {2}", field1, field2, field3String);
    }
}
22
Nicholas Miller

フィールドをprivate readonlyにして、コンストラクタに初期値を渡します

public struct ImmutableStruct
{
    private readonly int _field1;
    private readonly string _field2;
    private readonly object _field3;

    public ImmutableStruct(int f1, string f2, object f3)
    {
        _field1 = f1;
        _field2 = f2;
        _field3 = f3;
    }

    public int Field1 { get { return _field1; } }
    public string Field2 { get { return _field2; } }
    public object Field3 { get { return _field3; } }
}

C#6.0以降(Visual Studio 2015)ゲッターのみのプロパティを使用できます

public struct ImmutableStruct
{
    public ImmutableStruct(int f1, string f2, object f3)
    {
        Field1 = f1;
        Field2 = f2;
        Field3 = f3;
    }

    public int Field1 { get; }
    public string Field2 { get; }
    public object Field3 { get; }
}

読み取り専用フィールドとゲッターのみのプロパティは、コンストラクターで初期化できるか、クラスではフィールドまたはプロパティ初期化子public int Field1 { get; } = 7;でも初期化できることに注意してください。

コンストラクターが構造体で実行されることは保証されていません。例えば。構造体の配列がある場合は、配列要素ごとに初期化子を明示的に呼び出す必要があります。参照型の配列の場合、すべての要素は最初にnullに初期化されます。これにより、各要素でnewを呼び出す必要があることが明らかになります。しかし、構造体のような値型の場合は、忘れがちです。

var immutables = new ImmutableStruct[10];
immutables[0] = new ImmutableStruct(5, "hello", new Person());
immutables[1] = new ImmutableStruct(6, "world", new Student());
...

C#7.2以降では、 読み取り専用構造体 を使用できます

不変データを非公開にする:

struct ImmutableStruct
{
    private int field1;
    private string field2;
    private object field3;

    public ImmutableStruct(int f1, string f2, object f3)
    {
        field1 = f1;
        field2 = f2;
        field3 = f3;
    }

    public int Field1 => field1;
    public string Field2 => field2;
    public object Field3 => field3;
}

またはより散らかった:

struct ImmutableStruct
{
    public ImmutableStruct(int f1, string f2, object f3)
    {
        Field1 = f1;
        Field2 = f2;
        Field3 = f3;
    }

    public int Field1 { get; }
    public string Field2 { get; }
    public object Field3 { get; }
}
3