あるクラスのpublicメンバを呼び出す必要がない別クラスで、そのメンバの呼び出しを行わないことを明示したい

Question

実現したいこと

C#において、あるクラスにpublic set可能なプロパティを定義しつつも、public setを呼び出すつもりがない処理でそのクラスのインスタンスを扱うときには呼び出しをしないことをコード上明確にし、誤って呼び出したときにはコンパイルエラーとする良い方法はないでしょうか？

イメージはListが必要だが内容操作が不要なとき、IReadOnlyListとして受け渡すことで（無理やりキャストしない限り）エラーとなるといった手法を自ら定義したクラスで行いたい形です。

質問の背景

System.Xml.Serializationでシリアライズ/デシリアライズしているデータがあるのですが、
そのデータはxmlファイルから読み込む場合には読み込み時以外には触ることがなく、
新規作成する場合にも新規作成を行う機能だけが触れればいい内容です。
System.Xml.Serializationの仕様上setをpublicにしないといけないのと、
新規作成機能だけは自由にデータを弄らせたいこともあってset自体をprivateにするのは難しいと考えています。

ソースコード(イメージ）

[XmlRoot("myData")]
public class MyData
{
        public MyData() { }

        [XmlElement("data1")]
        public string Data1 { get; set; }

        [XmlElement("data2")]
        public string Data2 { get; set; }
        
        ....
}

public class DataUser
{
        public DataUser(MyData myData)  //IReadOnlyMyDataを定義してそちらで受け渡す？ 
        {
            //MyDataの値を変更すべきではない処理
        }
}

動かせるソースコード例（追記）

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Xml.Serialization;

namespace TestApp
{
    class Program
    {
        static void Main(string[] args)
        {
            //新規データ作成(デスクトップ）
            string xmlFile = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.Desktop), "myData.xml");
            var generator = new MyDataGenerator();
            generator.GenerateAndSave(xmlFile);

            //ファイルからロード
            MyData myData = MyDataLoader.Load(xmlFile);

            //利用（編集しない）
            var user = new MyDataUser();
            user.UseData(myData);

            Console.ReadLine();
        }
    }

    [XmlRoot("myData")]
    public class MyData
    {
        public MyData() { }

        [XmlElement("data1")]
        public string Data1 { get; set; }

        [XmlElement("data2")]
        public string Data2 { get; set; }
    }


    class MyDataGenerator
    {
        public void GenerateAndSave(string path)
        {
            var myData = new MyData();
            myData.Data1 = "abcde"; //実際はユーザー入力などを受け取って設定する
            myData.Data2 = "fghij";

            var xmlSerializer1 = new XmlSerializer(typeof(MyData));
            using (var streamWriter = new StreamWriter(path, false, Encoding.UTF8))
            {
                xmlSerializer1.Serialize(streamWriter, myData);
                streamWriter.Flush();
            }
        }
    }

    static class MyDataLoader
    {
        public static MyData Load(string path)
        {
            var xmlSerializer = new XmlSerializer(typeof(MyData));
            MyData myData;
            using (var streamReader = new StreamReader(path, Encoding.UTF8))
            using (var xmlReader = System.Xml.XmlReader.Create(streamReader))
            {
                myData = (MyData)xmlSerializer.Deserialize(xmlReader);
            }

            return myData;
        }
    }

    class MyDataUser
    {
        public void UseData(MyData myData)
        {
            myData.Data1 = "hogehoge"; //コンパイルを通したくない
            Console.WriteLine(myData.Data1);
            Console.WriteLine(myData.Data2);
        }
    }
}

自分で考えた実現方法

• 全てのプロパティをgetのみとしたIReadOnlyMyDataインターフェースを定義し、MyDataに実装させる
• MyDataをメンバーに持ち、getのみを仲介するReadOnlyMyData(readOnlyMyData.Data1が呼ばれると内部の_myData.Data1が返る）クラスを定義する

どちらもMyDataに存在するプロパティを全て同名でインターフェースかクラスに作成しなければならず、Data側が変わったときの二重管理が非常に大変そうなので他にいい方法があるのではないかと思っています。

別のアプローチについて

DataContractSerializerを使ってsetをprivateにし、新規作成はコンストラクタ引数で行うようにすれば背景の問題は解消しそうな気がしていますが、xmlのデータ順が縛られる上、データクラスへの変更が大きいため二の足を踏んでいます。
また背景に囚われずに一般論として質問のようなことが出来るか/どうやって行うか興味があるため質問させていただきました。

補足情報（追記）

C# 7.2 / .NET4.6.1の環境を使用しています。

Comments

[Zuishin]

init が正解のクイズですか？

[退会済みユーザー]

新規作成機能？ってのが良く分からないのできちんと書いてください。
1ソースで実行可能なサンプルにして貰えると検証しやすいです。

[aki107205]

initについては完全に知りませんでした。質問に記載すべきだったのですがC#のバージョン問題で当環境では使用できないようです。教えていただきありがとうございます。
また動かせるコードを追記しました。ただこのコードが動くかどうかというよりも、実際の質問意図は「同アセンブリ内でこのクラスにはpubicで触らせたいけどこっちのクラスではダメ！」というのをC#の仕様で実現可能なのか、ということです。

Answer 1

public set可能なプロパティを定義しつつも、public setを呼び出すつもりがない処理でそのクラスのインスタンスを扱うときには呼び出しをしないことをコード上明確にし、誤って呼び出したときにはコンパイルエラーとする良い方法

public set できるプロパティがあるという条件が付いた場合はそのような方法はありません。

set キーワードを使うのではなくプロパティを get-only プロパティ として定義してコンストラクタで初期化するか、C# 9.0 以降で使える init-only プロパティ を使ってください。

追記

XmlSerializer を使う場合は読み取り専用でも逆シリアル化できるのか気になり、ふと調べたら下記質問が見つかりました。
Force XML serialization to serialize readonly property

set アクセサーで NotSupportedException をスローさせることで触れないようにしているようなので XMLSerializer を使う場合はこれが現実的な解決策かもしれません。

ただし本質的な解決策か疑問に思ったのでふと調べたら次は公式のガイドラインが見つかりました。
シリアル化のガイドライン

XmlSerializer の代わりに DataContractSerializer でも XML のシリアル化・逆シリアル化ができるようです。

これを使う場合は

Data-MemberAttribute を持つすべてのプロパティに getter と setter を実装してください

とのことなので、get-only プロパティだと駄目かもしれませんがサンプルにもある通り private set で定義してコンストラクタ経由でなら逆シリアル化できると思います。

using System.Runtime.Serialization;

[DataContract]
public class Person
{
    public Person(string firstName, string lastName)
    {
        LastName  = lastName;
        FirstName = firstName;
    }

    [DataMember]
    public string LastName { get; private set; }

    [DataMember]
    public string FirstName { get; private set; }
}

Comments

[BluOxy]

> 「同アセンブリ内でこのクラスにはpubicで触らせたいけどこっちのクラスではダメ！」というのをC#の仕様で実現可能なのか
これはできないので、やるなら private set か get-only プロパティにするか init-only プロパティにするかで他のクラスから参照できないようにするのがシンプルだと思います。

[aki107205]

ありがとうございます。「別のアプローチ」の節で記載の通りDataContractSerializerでprivate setにする方法にはたどり着いていたのですが、手間を考えて躊躇っていました。（自分で考えた他の方法よりはマシでしょうが・・・）ストレートにやる方法はないということを答えていただいてスッキリしました。

Answer 2

C#8.0以上なら、アクセサに対してObsoluteが適用出来ます。
（今回のような用途で使うのが適切かどうかは判りません）

    [XmlRoot("myData")]
    public class MyData
    {
        public MyData() { }

        [XmlElement("data1")]
        public string Data1 { get; [Obsolete("setしないでね!")]set; } //setするとwarning

        [XmlElement("data2")]
        public string Data2 { get; [Obsolete("set禁止!", true)]set; } //setするとerror
    }

別アセンブリにしていいなら、internal辺りでも何とかなるかもしれません。

Comments

[aki107205]

ありがとうございます。少し想定していたものと違う気もしますが、他に簡単な方法が無さそうな以上、実用面では便利そうに感じました。（残念ながらC#バージョンのせいで使えないのですが）

[退会済みユーザー]

真面目にやろうとするならアナライザー作ったら出来るかもしれませんけど、専門外なんで深くは触れないでおきます。