C# クラスについて

Question

現在C#の勉強を少し前から始め、
フォームアプリを使いチャットやソケット通信などをしております。

クラスやオブジェクト継承などについて
最初に軽く勉強はしたのですが（とは言っても、こんな感じかぁ...程度です）
実際にコードを書いていくうちに、
ひとつのクラスがメソッドだらけでとても長く見づらいものとなってしまいました。

そこでこれから先、もし同じようなプログラムを組むときに、
使い回し等が効くようにクラス分けしたいと思いました。

例えば今やっているシリアル通信で、
1.今回のアプリで使う具体的な数値や設定
2.使い回しのきく、送受信の処理
3.使い回しのきく、COMポートをOPENする処理
4.メッセージボックスにて使う処理
のようにクラス分けするのかな？という考えに現在至っているわけですが、
相違があれば教えていただきたいです。

また、使い回す際のコードの書き方がいまいちわからないです。
例えば、

 recData += System.Text.Encoding.ASCII.GetString(buffer);
            var temporary = Sendbuffa + recData;
            while (true)
            {
                newline = temporary.IndexOf(Environment.NewLine);
                if (newline >= 0)
                {
                    string[] lines = temporary.Split(
                        new[] { Environment.NewLine },
                        StringSplitOptions.None
                    );
                    logText(lines[0], ComPort);

                    if (lines.Length > 1)
                    {
                        // temporaryに残りを詰めなおす
                        temporary = temporary.Substring(newline + 2);
                    }
                }
                else
                {
                    Sendbuffa = temporary;       //データをいったん保存
                    break;
                }
            }

このコード（前回質問させていただいた時の教えていただいたコードなのですが...）を
使い回しのきくクラスとメインの今回のアプリで使うクラスに分けるには、
どのようにすればいいのでしょうか？

気をつける点やポイント等教えていただきたいです。
長くなりましたがよろしくお願いいたします。

[++C++;//未確認飛行C]
http://ufcpp.net/study/csharp/oo_class.html
こちらのサイトも参考にさせていただいたのですが自分の知識がついてこず..
いまいちピンと来てくれませんでした :(

Answer 1

このコードに使いまわせる部分は無いと思います。

###追記

使いまわすならこんな風に書きます。

public static IEnumerable<string> SplitLines(byte[] buffer, Encoding encoding)
{
	using (var reader = new StringReader(encoding.GetString(buffer)))
	{
		while (true)
		{
			string result = reader.ReadLine();
			if (result == null) break;
			yield return result;
		}
	}
}

もっと簡単にこうも書けます。Encoding は省いて文字列対象にしました。
バイトデータから文字列を取り出すのは上記のように簡単なので。

static IEnumerable<string> SplitLines(string str)
{
	return Regex.Split(str, "\r?\n");
}

Comments

[退会済みユーザー]

コメントありがとうございます。
こんなにコードが簡潔でとても見やすくなるんですね！！
参考にさせていただきます！

Answer 2

通信部分に関してはよくわからなかったのですが、要は区切り文字毎にLogに書き出すという内容と理解しました。

であれば、そのように書くのがオブジェクト指向の醍醐味です。

再利用性はあまり考えない方がクラス分けはしやすいです。
例えばこんなのはどうでしょうか？
（あくまで例です。雰囲気をつかんでもらえれば・・・）

var receiver = new XXRciver(env);
receiver.Receive((string line) => {logText(lines[0], ComPort);});

１行目は、動作に関して初期値を与えています。
引数は一つになっていますが、実際はたくさんあったり、それをまとめたクラスだったりを入れます。

XXRciverの中身はクラスの設計時には気にしないようにしてください。

２行目は、受信時の動作を定義しています。
レシーバーは受信するのが目的のオブジェクトです。
受信した後の動作は、外部から指定してあげる必要があります。
ループの内側にある部分なので、処理を渡してます。

ラムダ式に慣れていないなら、インターフェイス越しに書きこんでもいいです。
（このインターフェイスは再利用のためというわけではなく、受け取り側がどのメソッドを気にして、どのメソッドを気にしていないのかを宣言するためのものです。場合によっては不要です。）

interface IAtRecieved{
    void AtRecieved(string line);
}

class LogWriter : IAtRecieved{
    void AtRecieved(){
        logText(lines[0], ComPort);
    }
}

このように関心事を明確にして、簡潔に記述し段階を分けることを主眼としてください。

適切に分割されていれば、再利用が可能が場合もあると思います。

再利用を目的として書くとどうしても”かもしれない”で余分な機能を作りこみます。しかし、大体において予想外の機能が必要になるため、余分な機能がてんこ盛りのクラスの変更が大変だということになりますのでご注意を。関心事ごとに分割されているのが大事です。

Comments

[退会済みユーザー]

コメントありがとうございます。
おっしゃる通り再利用のことばかり考えておりました。。
これからは、事柄ごとに分割してすっきり見やすいコードかけるように頑張ります！

Answer 3

別解をひとつ。

前の質問で、バイナリ通信にこだわられてたようなので、

• バイナリ受信クラス

バイナリデータ列をリングバッファやStreamかなんかで保持
バイナリデータによりIndexOfメソッド、
先頭からnバイト取得／削除するメソッド

• バイナリデータを文字列に変換するクラス

おそらくStringBuilderあたりをつかって、
バイナリ受信クラスに改行コードのバイト文字列を与えて先頭データ列を取得、文字列に変換して返す
存在する行を全部string配列／Enumerableにして返すメソッド

まあ、こういうふうに分ければ、バイナリ通信の場合に使いまわしできるし、バイナリ-文字列変換ってのも他に使いまわしできるように思います

＃再利用できるように、ちとムリクリですがｗ

Comments

[退会済みユーザー]

なるほど。結構細かく分けるのですね！
やっと少しは分け方がわかって来た気がします。
用途ごとややっていることの種類が同じようなことをまとめてクラス分けのような感じで徐々にできるようになります！
ありがとうございます！！

Answer 4

a. コードで気になった点。
1, 受信処理の解析と思われる部分に変数名:Sendbuffaがあるのが気になります。
送受信データの混在を避けるため送信バッファ/受信バッファの変数は分けると思いますが、単純に変数名の命名がそうなっていただけでしょうか？

var temporary = Sendbuffa + recData;

2,temporary.IndexOfとtemporary.Splitを同時に行っているのが気になります。
whileループからforループに変換して、以下のコードでも。

var temporary = Sendbuffa + recData;
var lines = temporary.Split(new[] { Environment.NewLine },
     StringSplitOptions.None
     );
for (int i=0; i< lines.Length - 1; i++)
{
    logText(lines[i], ComPort);
}
Sendbuffa = lines.Last();

3,デミリタ（区切り文字）にEnvironment.NewLineを使っている点
参考 ->environment.newline

UNIX 以外のプラットフォームでは "\r\n" を含む文字列。UNIX プラットフォームでは "\n" を含む文字列。

Unixプラットフォームではenvironment.newlineの改行コードが違うため、このプログラムをUnixで動かした時に注意が必要です。

---

b. クラス分けについて
SerialPortServerクラスを新規作成して、2)と3)の処理を行います。

4)はクラスを作らずにAction<string>をSerialPortServerクラスに定義します。
参考 -> Action<T> デリゲート

public Action<string> logWrite; 

呼び出し方
logWrite(lines[0]);

画面を更新する必要がある時は、Actionイベント内でコントロール名.Dispatcher.BeginInvoke();を呼び出すのをお忘れなく。

最後に通信に関わる部分は通信プロトコル解析処理(Parser)がどうしても必要になるので、使い回しはしずらいと思いますー。
自作せずにHTTPなどのプロトコルを上に被せる形がいいのではと。
どうしても自作するなら、状態遷移図と通信プロトコルのドキュメントは最初に作成するほうが後々苦労しないです。

Comments

[退会済みユーザー]

コメントありがとうございます！
まずバッファ変数名については、自分の命名が下手でした。。
「送られて来た」ということでsendにしていましたが、今考えると変ですね。。。
まだプログラミング勉強し始めたばかりで、C言語C++そしてC#の順に勉強しており、「これからのことを考えてこうするといいよ。」というのは本当に助かります！(やっぱりやるからにはこれからの事を見据えた勉強をしていきたいと思っておりますので : )
ありがとうございました！！