メッセージ通知先の変更方法について。

Question

###前提・実現したいこと
作成しているアプリケーションに自動実行オプションを追加するにあたって困っていることがございます。
ロジック内にはメッセージボックスを表示する箇所が多く存在し、自動化とは言えメッセージが表示されることにより止まってしまいます。bat等からキックし自動で処理を行うのが目的のためコマンドラインからの実行時にはメッセージ表示を行わないようにと考えております。別のプロジェクトに分けてしまうのも冗長的ですし、かと言って引数がある場合のみ表示しないような条件分岐は実装箇所が多くメンテの面でも微妙です。関数化し、引数を受けたときのみメッセージ通知を変更することも考えたのですが何か良き方法はございますでしょうか。

分かりにくい説明で申し訳ございません。

###該当のソースコード

        'ダミーコマンドライン引数。
        Dim opt As Boolean = True

        If opt Then
            Console.WriteLine("自動実行処理")
        Else
            MessageBox.Show("手動実行処理", "テスト", MessageBoxButtons.OK, MessageBoxIcon.Information)
        End If

###補足情報(言語/FW/ツール等のバージョンなど)
上記のような分岐ではメンテに手間がかかる上、コードが読みにくい。
設計時から問題といえばそうかもしれません。

Answer 1

こんにちは。
VB.NETはちょっと詳しくないのでC#で失礼します。
以下のようなユーティリティクラスを作ってしまい、MessageBoxの呼び出し自体をそれ経由に置き換えてしまえば良いと思います。

public static class MyMessageBox
{
    private readonly static bool opt = <コマンドライン引数>;

    public static DialogResult Show(string text, string caption, MessageBoxButtons buttons, MessageBoxIcon icon)
    {
        if (opt)
        {
            // opt == true の処理
            return DialogResult.OK; // okが押されたことにする
        }
        else
        {
            return MessageBox.Show(text, caption, buttons, icon); // 戻り値を一切使わないならvoidにしてしまうでも良い
        }
    }
}

// 使う時は
MyMessageBox.Show("手動実行処理", "テスト", MessageBoxButtons.OK, MessageBoxIcon.Information); // optがtrueの時は何も実行されない

Answer 2

MessageBoxやConsoleを直接呼ぶのではなく一旦受け皿となるクラスを定義しましょう。

例えば、IMessagingインターフェースを定義し、MessageBoxを利用したもの、Consoleを利用したものそれぞれを実装します。

public interface IMessaging
{
    void Information(string message);
}

public class UIMessaging : IMessaging
{
    public void Information(string message)
    {
        MessageBox.Show(message, "確認", MessageBoxButtons.OK, MessageBoxIcon.Information)
    }
}

public class ConsoleMessaging : IMessaging
{
    public void Information(string message)
    {
        Console.WriteLine($"{DateTime.Now:hh:mm:ss} {message}");
    }
}

IMessagingの取得方法については、Depenency Injectionを使用するのが最良ですが、それが分からない場合にはstaticクラスにこのIMessagingインターフェースを実装したクラスを持たせてしまいましょう。後は、コンソール呼び出しが確定する何等かのオプション指定でコレを差し替えれば完成。

public static My
{
    public static IMessaging Messaging { get; set; }
}

public void Main()
{
     if (/* コンソールで実行された場合 */)
     {
         My.Messaging = new ConsoleMessaging();
     }
     else
     {
         My.Messaging = new UIMessaging();
     }

     My.Messaging.Information("アプリケーションを起動しました。");
}

この場合、UIMessagingとConsoleMessagingは別々に定義できるので、それぞれの処理が混在することもなく、すっきりします。
難点は途中で差し替えれないことですが、たぶん不要だろうと思うのでこういう形で提案させて戴きます。

Comments

[yuki00079]

当方の求める実装に近いと考え、ベストアンサーとさせていただきました。