【C#】メッセージクラスにユニークなIDをつけたい

Question

##前提
イベントビューアに出力するログを管理したく、
メッセージ・ID・メッセージの種類(通知/エラー)をひとまとめにして合理的に管理したいです。
悩んでいたところ以下のようなコードを教えていただくことが出来ました。

public enum MessageLevel
{
    Info,
    Error
}

// メッセージ本体の抽象構造定義

public abstract class Message
{
    public abstract int Id { get; }

    public abstract string Text { get; }

    public abstract MessageLevel Level { get; }
}

public abstract class Info : Message
{
    public override MessageLevel Level => MessageLevel.Info;
}

public abstract class Error : Message
{
    public override MessageLevel Level => MessageLevel.Error;
}


// 共通メッセージ定義

public class TaskDone : Info
{
    public override int Id => 1;

    public override string Text => "all tasks are done";

}

public class CommandLineArgumentsError : Error
{
    public override int Id => 2;

    public override string Text => "need some command-line arguments";
}

public class SpecialError : Error
{
    public override int Id => 3;

    public override string Text => "failed to backup log files";
}


// ================================================================
// Project1 アセンブリ内

// 追加メッセージ

public class Project1HogeError : Error
{
    public override int Id => 4;

    public override string Text => "project1 local error";
}


// ================================================================
// クライアントコード

class Test
{
    public void Main()
    {
        var message = new TaskDone();

        System.Console.WriteLine($"ID:{ message.Id }, Level:{ message.Level }, Content:{ message.Text }");
    }
}

このコードは私が最初に書いたものより格段に分かりやすくなっているのですが、
個人的な都合により、いくつか課題があります。

##課題

1... IDをユニークにしやすいような仕組みがないこと

イベントログに出力するIDとメッセージは1対1にしたいため、
各クラスのIdプロパティにハードコーディングでIDを設定するよりは
簡単で安全な方法で各メッセージのIDを設定したいです。

2... IDを連番にしやすいような仕組みがないこと

1つ目の理由に近いのですが、IDは連番にしたいため
やはりIDはより簡単な方法で設定したいです。

私が最初に書いたコードは、
目も当てられないほど酷いコードだったのですが、
各メッセージを列挙体のメンバーと1対1で定義していたため、
IDをユニークにしたり連番にしたりすることは簡単でした。
列挙体なら各メンバーはデフォルトで一意かつ連番な整数値を持つからです。
##やりたいこと
前述のコードの良いところを利用しながら、IDの管理も合理的にできるようなコードを書きたいです。
アドバイスをよろしくお願いいたします。

##補足
この質問はひとつ前の質問の続きになっています。
見ても意味はないかもしれませんが、何か気になる点が御座いましたら御覧ください。
当該の質問につきましても、回答を受付中です。

→ ひとつ前の質問

Answer 1

こんにちは。

• Idは一意かつ連番とする
• Message種別毎にIdの範囲を設定する

という2つのみを加えて実現するように書いてみました。

public abstract class Message
{
    public int Id { get; } // ベースクラスがIdの実体を持つように

    public abstract string Text { get; }

    public abstract MessageLevel Level { get; }

    public Message(int id)
    {
        this.Id = id;
    }
}

public abstract class Info : Message
{
    private static int id = 10000; // 初期値

    public override MessageLevel Level => MessageLevel.Info;

    public Info() : base(Interlocked.Increment(ref id)) // newする度にインクリメントする
    { }
}

public abstract class Error : Message
{
    private static int id = 20000;

    public override MessageLevel Level => MessageLevel.Error;

    public Error() : base(Interlocked.Increment(ref id))
    { }
}


// 共通メッセージ定義

public class TaskDone : Info
{
    public static Message Instance { get; } = new TaskDone(); // シングルトンインスタンス

    public override string Text => "all tasks are done";

    private TaskDone() // コンストラクタを非公開に
    { }
}

public class CommandLineArgumentsError : Error
{
    public static Message Instance { get; } = new CommandLineArgumentsError();

    public override string Text => "need some command-line arguments";

    private CommandLineArgumentsError()
    { }
}

public class SpecialError : Error
{
    public static Message Instance { get; } = new SpecialError();

    public override string Text => "failed to backup log files";

    private SpecialError()
    { }
}


class Test
{
    public void Main()
    {
        var message = TaskDone.Instance; // シングルトンインスタンスを取得

        System.Console.WriteLine($"ID:{ message.Id }, Level:{ message.Level }, Content:{ message.Text }");
    }
}

各Messageをnewする度にIdをインクリメントし、各Messageをシングルトンとすることで、「各Messageに『一意』かつ『連番』なIdを自動で設定する」ことを実現しました。
問題があるとすると、どのMessageに対してどのIdが振られるかが決まらないため、「初回の実行時にId1だったあのメッセージは、次の実行時にはId2に割り当てられているかもしれない」ということです。
各回実行毎の一意性は確保していますが、同一性が保証できないという話になりますね。
質問の要件には含まれていなかったのでこの問題について完全に無視していますが、こちらも要件に含む場合は、ハードコーディング以外の道は殆ど残っていないと思います。
他には、全てのMessageを最初にまとめて順番にインスタンス化してリストなどに突っ込んでしまい、割り振られる順番を固定してしまうという方法もなくはないですね。ほぼハードコーディングのようなものですが。

Comments

[syogakusya]

回答ありがとうございます。
IDの同一性を要件に含むことを失念していました。
言及いただきありがとうございます。
御推察のとおり、仕様書にIDと内容の対応を載せたりといったことがあるので、
IDとメッセージの同一性は要件に含めるべきでした。
そうなるとやはりハードコーディングになってしまうのですね。
列挙体を継承さえできればと思わずにはいられません。

[syogakusya]

アプリケーションの設計について真剣に考えてみましたところ、
そもそも共有メッセージと固有のメッセージは連番にしてはならないことが分かりました。
共有メッセージを増やすことで各プロジェクトの固有メッセージのIDがずれていってしまうのでは、メッセージのIDに同一性があるとは言えないからです。
固有メッセージは1~5000、共有メッセージは5001～10000といった形でもう一度考え直してみます。
その際、頂いたソースを参考にしようと思います。
お付き合いいただきありがとうございました。

Answer 2

こんにちは。

たぶん、シングルトンを作って、その中でIDをインクリメントすれば行けると思います。

例えば、上記リンク先のシングルトンに、int id;を追加（コンストラクタで0クリア）。
メソッドint getId() { return id++; }を追加ですね。
そして、各メッセージのidをstaticにして、上記値をセットするイメージです。

すいません。最近、C#を触ってないのでコードをパッと書けません。

Comments

[syogakusya]

インスタンスをnewするたびに1ずつIDを増やすことはできましたが、
クラスに紐づけてIDを設定する方法は分かりませんでした。
また、newした順にIDがつけられていくため、同じメッセージに対し同じIDが割り当てられることが保証できませんでした。

[Chironian]

> クラスに紐づけてIDを設定する方法は分かりませんでした。

staticフィールドはご存知ないですか？
上記のリンク先を見て頂ければ解説されてます。
staticフィールドの初期化は上記のリンク先の「静的コンストラクター」でいけると思います。
静的コントラクタでid=シングルトンのgetInstance().getId();です。

基底クラスから派生クラスのstaticフィールドをアクセスしたい場合は、仮想関数で各クラスのstaticフィールド(id)を返却すれば良いです。

> 同じメッセージに対し同じIDが割り当てられることが保証できませんでした。

この要件は満たせないかも知れません。アプリ起動後終了するまでは変化しない筈です。
しかし、C#の厳密な仕様を知りませんが、静的コンストラクターが呼び出される順序が不変であることは保証されていないだろうと思います。つまり、アプリを再起動した時に変化しないことは保証できないと思います。

代替案ですが、各メッセージをシングルトン化し、コンストラクタで「直前」のメッセージをgetInstance()して、そのIDを+1し自分のIDとすることが考えられます。
基底クラスからそれを取り出す際は冒頭で述べた考え方で行けると思います。
その仮想関数で自分をgetInstance()することをお忘れなく。（はじめての呼び出し時に、このgetnstance()でコンストラクタを起動し、IDを設定します。）

なお、同じメッセージを複数のメッセージが参照するとIDが重複するので要注意です。

コードを示せないので分かり難いと思います。申し訳ないです。