オブジェクト指向のクラス設計について

Question

前提

C#(WPF)にてクイズゲームのようなアプリを開発しています。
オブジェクト指向についての理解が浅く、どのようにクラスの設計したらよいか迷っています。

実現したいこと

クイズのコンテンツ(png,mp3等)をローカルに配置し、それらを参照して画面に表示させたり、音声を再生させるつもりです。
そこで1問のクイズを表すQuizクラスを作成しました。機能としてはローカルの読み取りを行い、適切な形に成形してプロパティにセットするといった内容です。(コンストラクタの引数で取得したいコンテンツ郡を指定しています。)
作っている中で、コンテンツを読み取ることはQuizクラスの責務ではないような気がしていて、クラスを分離したほうが良いのではないかと感じています。しかし具体的にどのようにクラスを設計したら良いかがよく分かりません。
この場合、どのように設計すると良いのでしょうか？

ソースコード

Quizクラス

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.IO;
using System.Linq;

namespace QuizSample
{
    public record Quiz
    {
        private readonly string _contentsPath = @"resources\quizset";

        /// <summary>
        /// 難易度
        /// </summary>
        public string Level { get; init; }

        /// <summary>
        /// 問題文画像
        /// </summary>
        public Question Question { get; init; }

        /// <summary>
        /// 回答ボタン画像
        /// </summary>
        public ReadOnlyCollection<Answer> Answers { get; }

        /// <summary>
        /// </summary>
        /// <param name="level">問題の難易度</param>
        /// <param name="number">問題フォルダの番号</param>
        public Quiz(string level, int number)
        {
            //対象ファイルを取得
            var quizFolder = _contentsPath + @"\" + level + @"\" + number;
            string[] quizElements = Directory.GetFiles(quizFolder);

            //Questionを生成
            var questions = new List<Question>();
            var questionImgPath = quizElements.Where(o => o.Contains("question.png"));
            var questionVoicePath = quizElements.Where(o => o.Contains("question.mp3"));
            var questionPaths = questionImgPath.Zip(questionVoicePath, (iPath, vPath) =>
                new { ImgPath = iPath, VoicePath = vPath });
            foreach (var path in questionPaths)
            {
                var question = new Question(path.ImgPath, path.VoicePath);
                questions.Add(question);
            }
            Question = questions[0];

            //Answersを生成
            var answers = new List<Answer>();
            var answerPath = quizElements.Where(o => o.Contains("answer", StringComparison.CurrentCulture));
            foreach (var path in answerPath)
            {
                var answer = new Answer(path);
                answers.Add(answer);
            }
            Answers = answers.AsReadOnly();
        }
    }
}

resources
    └─quizset
       ├─easy
       │  └─1
       │          answer1-correct.png
       │          answer2.png
       │          answer3.png
       │          question.mp3
       │          question.png
       │
       ├─hard
       │  └─1     answer1-correct.png
       │          answer2.png
       │          answer3.png
       │          question.mp3
       │          question.png
       │
       └─normal
          └─1     answer1-correct.png
                  answer2.png
                  answer3.png
                  question.mp3
                  question.png

補足情報（FW/ツールのバージョンなど）

Visual Studio 2022
C#10.0
WPF

Comments

[Zuishin]

クイズはファイルからのみ読み取るようになっていますが、将来データベースやネットから読み取る可能性も考えると、読み取り部分は確かに分離した方が良さそうです。
ファイルやネットからデータを読み取る Stream クラスを参考にしてみては？
データを mp3 や png ではなく今は未対応のファイル形式や複数のファイルになることもあると仮定すると、JSON や XML などを利用してデータの種類や数や読み取り方法を指定するのも良いかもしれません。
クラスを設計するのであれば、どのようなクラスを作れば拡張しやすいか、そしてクラス自体を交換しやすいかを考えるのが良いでしょう。
これを開放/閉鎖原則と言います。
https://ja.wikipedia.org/wiki/%E9%96%8B%E6%94%BE/%E9%96%89%E9%8E%96%E5%8E%9F%E5%89%87

[Zuishin]

過去の質問を見ると、どうも自分の中に正解があって回答者がそれを答えられるかどうかをテストしてるみたいだな。

[Hottopia]

そんなことはないです。。。

[Zuishin]

この質問も自分の中で答えが出てるようだけど？

[Hottopia]

なんとなく、こうしたほうがいいんじゃないかみたいなものはありますが、正解なのかがわからないので、質問しました。

[Zuishin]

動けば正解。

[Hottopia]

動けば正解はそうかも知れませんが、Zuishin様がコメントおっしゃったように、拡張性だったり修正の容易性を意識したいのですが、どういう設計にすればよいかがわからないため今回の質問に至りました。

[Zuishin]

プログラミングは、無いものを作る作業であって、学力テストではないので、決められた正解を目指すのではなく、自分でできるやり方で動くものを作ればいいだけ。
最初に作るものはプロトタイプと割り切り、動くようになってからリファクタリングしてもいい。
良いものを作るには経験が必要なので、最初から完璧にできなくていいし、人に設計してもらったのではその経験すら積めない。
良い設計だったかどうかは改修時にわかる。

[Hottopia]

>>良いものを作るには経験が必要なので、最初から完璧にできなくていいし、人に設計してもらったのではその経験すら積めない。

おっしゃる通りですね。精進します。
ご丁寧にありがとうございました！

Answer 1

Quizクラスが持つべき役割を整理すると「質問と答えのセットを提供すること」でしょうから、「クイズ用のアイテムを読み込む」のは２つ目の役割といえるかもしれません。クラスに担わせる役割は一つだけのほうがいいでしょうから、２つでも十分多いと言えます。

こういう時はQuizManagerなどとQuizを管理する側のクラスを別途用意して読み込み処理を担わせる、といった形で処理の分担を考えるとQuizクラス自体をシンプルに保てます。

---

（以下、だいぶ長めの回答になります。）

QuizManagerを作ろうという時に、追加でもう一点「読み込み処理そのものの抽象化」をしておくと便利です。

どういうことかといいますと↓

Quizを取得するだけの役割を持った interface が以下のように表現できます。

public interface IQuizLoader
{
     Task<QuizMode[]> GetAllQuizModeAsync();
     Task<Quiz> GetQuizAsync(QuizMode quizMode);
}

public record QuizMode(string Level, int Number);

このようなIQuizLoaderインターフェイスを用意するとクイズ読み込みの「手段だけ」が提示されることになります。

具体的な読み込み方法、ストレージの存在などはこのIQuizLoaderから伺い知ることは出来ないため、このIQuizLoaderを使う人に対して「Quizの取得手段だけを知っている」という状態を実現できます。

一方でQuizを使いたい側（QuizManager、または何らかのViewModel）はIQuizLoader.GetQuizAsync(quizMode)を呼び出して使います。そのためにはまずQuizを使いたい側のコンストラクタでIQuizLoaderを受け取れるようにします。

IQuizLoaderの実装クラスのインスタンスを渡す方法に関しては、DI Container（DI=Dependency Injection=依存性の注入）で実現するのがベターです。

DI Containerがわからないようなら、後で「MVVM toolkit DI」で調べてみてください。今はわからなくても読み進めて大丈夫です。回答最後のところに参考リンクが貼ってあります。

次に、IQuizLoader の実装は例として以下のように書けます。

public class ResourceBasedQuizLoader : IQuizLoader
{
    public Task<QuizMode[]> GetAllQuizModeAsync()
    {
        // TODO: クイズの種類を取得して返す
    }
    public Task<Quiz> GetQuizAsync(QuizMode quizMode)
    {
        // TODO: クイズの種類からクイズを読み込んで返す
    }
}

リソースファイルベースで読み込む場合は上記のように ResourceBasedQuizLoader を実装したり、あるいは別途サーバーを立ててWebから取得する場合には WebBasedQuizLoader を実装したりすることで、IQuizLoaderの実装を切り替えることで多様なソースからのデータ取得の切り分けが表現できるようになります。

実装が出来たら QuizManagerないしViewModelのコンストラクタにnew QuizManager(new ResourceBasedQuizLoader())といった形でIQuizLoaderを実装したクラスのインスタンスを提供します。

public class QuizManager
{
    private readonly IQuizLoader _quizLoader;
    public QuizManager(IQuizLoader quizLoader)
    {
        _quizLoader = quizLoader;
    }

    // TODO: QuizModeやQuizの取得を実装する
}

var quizManager = new QuizManager(new ResourceBasedQuizLoader());

// DI Containerを使う場合は、IQuizLoaderを解決する場合の実装クラスを指定して
Container.Register<IQuizLoader, ResourceBasedQuizLoader>();
// QuizManagerのインスタンスを生成する場合にコンストラクタで求められる IQuizLoader が
// Containerから提供され（この場合はRegisterしたResourceBasedQuizLoaderが選択され）
// QuizManagerクラスのインスタンスがResolve（解決）されます。
var quizManager = Container.Resolve<QuizManager>();

最終的に以下のような形でクイズ取得を呼び出して使います。

var quizManager = new QuizManager(new ResourceBasedQuizLoader());
var quizModes = await quizManager.GetAllQuizModeAsync();
var quiz = await quizManager.GetQuizAsync(quizModes.Where(x => x.Level == "hard").First());

以上です。

ちなみに、ここまで提示したのはいわゆる SOLID原則 を踏まえた設計の一つになろうかと思います。「オブジェクト指向」だとまだふわっとしてるので SOLID原則 など具体的な設計指針（デザインパターン）を参考にしながら考えていけるといいのかなと思います。

参考

イラストで理解するSOLID原則
https://qiita.com/baby-degu/items/d058a62f145235a0f007

DI Containerによるコンストラクタ インジェクションの説明
https://learn.microsoft.com/ja-jp/dotnet/communitytoolkit/mvvm/ioc#constructor-injection

オススメ書籍

• .NETのクラスライブラリ設計 改訂新版
• 良いコード/悪いコードで学ぶ設計入門 ―保守しやすい 成長し続けるコードの書き方

Comments

[Hottopia]

ありがとうございます。上手く行きそうです。

[Kodzura]

何を「どう」したいかまで決めてから質問するよりも「何をしたいか」段階で聞いた方が「答えられる」。
新しい世代のオブジェクト指向プログラミング技術の「基本設計構築」のひとつの特長になっています。
基本設計への強い制約や矛盾が避けられなくなるまで「作り込んで」から質問するより、ずっと良いかと。
→そうした技術がなかった頃の質問との大きな違い

Answer 2

オブジェクト指向で開発するならば、コードを先におこすのでなく、
オブジェクト指向分析や設計を先に行った方がよいかと思います。

今回の場合、Quiz, Question, Answer などの単語がプログラムに記載されていますが、
それらがどういう関係なのかを先に整理した方がよいのではないでしょうか。

なんとなくプログラムをみている限り下記のような構造が見えてきました

Comments

[Hottopia]

回答ありがとうございます。