Day 83:クラス設計
Day 82では、読書管理アプリの要件を整理しました。Day 83では、その要件を実現するためのクラス設計を行います。アプリの構造を「Model」「Service」「Repository」の3層に分け、それぞれの役割と関係を明確にします。
この設計は、アプリの機能を追加・変更しやすくするための土台になります。特に、データの保存方法やビジネスロジックを分離することで、将来的な拡張やテストが容易になります。
ステップ1:3層アーキテクチャを理解する
読書管理アプリを、以下の3つの層に分けて設計します。
- Model層:アプリが扱うデータを表します。本の情報や読書状況など、データの構造とルールを定義します。
- Repository層:データの保存・読み込みを担当します。JSONファイルやデータベースとのやり取りをここに閉じ込めます。
- Service層:ビジネスロジックを担当します。本の登録や検索、評価の更新など、アプリの核心的な機能を実装します。
この分離により、たとえば「JSONファイルの代わりにデータベースを使う」場合でも、Service層のコードをほとんど変更せずに済みます。
ステップ2:Model層を設計する
Model層は、アプリが扱うデータの構造を定義します。Day 82で決めたデータ項目を、C#のクラスとして実装します。
1. 本の情報を表す BookItem クラス
namespace ReadingApp.Models
{
// 本の読書状況を表す列挙型です
public enum ReadingStatus
{
Unread, // 未読
Reading, // 読書中
Finished // 読了
}
// 本1冊分の情報を表します
public class BookItem
{
// 本を識別するためのIDです
public int Id { get; set; }
// 本のタイトルです。必須項目として扱います
public string Title { get; set; } = "";
// 著者名です。省略可能です
public string Author { get; set; } = "";
// 本のカテゴリです。例:「小説」「技術書」
public string Category { get; set; } = "";
// 読書状況の初期値は未読です
public ReadingStatus Status { get; set; } = ReadingStatus.Unread;
// 評価は1〜5、未評価の場合はnullにします
public int? Rating { get; set; }
}
}C#2. 入力チェック用のヘルパークラス(オプション)
入力ルールを一元化するために、InputValidator クラスを追加します。
namespace ReadingApp.Models
{
// 入力チェックを担当する静的クラスです
public static class InputValidator
{
// タイトルが有効か確認します
public static bool IsValidTitle(string title)
{
return !string.IsNullOrWhiteSpace(title);
}
// 評価が有効か確認します
public static bool IsValidRating(int? rating)
{
return rating == null || (rating >= 1 && rating <= 5);
}
}
}C#ステップ3:Repository層を設計する
Repository層は、データの永続化(保存・読み込み)を担当します。ここではJSONファイルを使いますが、インターフェースを定義しておくことで、将来的にデータベースに切り替えやすくします。
1. データ保存用のインターフェース
namespace ReadingApp.Data
{
// 本のデータを永続化するためのインターフェースです
public interface IBookRepository
{
// すべての本を取得します
List<BookItem> GetAll();
// 指定したIDの本を取得します
BookItem? GetById(int id);
// 本を追加または更新します
void Save(BookItem book);
// 本を削除します
void Delete(int id);
// 変更を保存します
void SaveChanges();
}
}C#2. JSONファイルを使った実装
using System.Text.Json;
using ReadingApp.Models;
namespace ReadingApp.Data
{
// JSONファイルを使って本のデータを永続化します
public class JsonBookRepository : IBookRepository
{
private readonly string _filePath;
private List<BookItem> _books;
// コンストラクタでファイルパスを指定します
public JsonBookRepository(string filePath)
{
_filePath = filePath;
_books = LoadBooks();
}
// ファイルから本のデータを読み込みます
private List<BookItem> LoadBooks()
{
if (!File.Exists(_filePath))
{
return new List<BookItem>();
}
string json = File.ReadAllText(_filePath);
return JsonSerializer.Deserialize<List<BookItem>>(json) ?? new List<BookItem>();
}
// すべての本を取得します
public List<BookItem> GetAll()
{
return _books;
}
// 指定したIDの本を取得します
public BookItem? GetById(int id)
{
return _books.FirstOrDefault(b => b.Id == id);
}
// 本を追加または更新します
public void Save(BookItem book)
{
var existing = _books.FirstOrDefault(b => b.Id == book.Id);
if (existing == null)
{
// 新しい本のIDを決定します
book.Id = _books.Count > 0 ? _books.Max(b => b.Id) + 1 : 1;
_books.Add(book);
}
else
{
// 既存の本を更新します
existing.Title = book.Title;
existing.Author = book.Author;
existing.Category = book.Category;
existing.Status = book.Status;
existing.Rating = book.Rating;
}
}
// 本を削除します
public void Delete(int id)
{
var book = _books.FirstOrDefault(b => b.Id == id);
if (book != null)
{
_books.Remove(book);
}
}
// 変更をファイルに保存します
public void SaveChanges()
{
string json = JsonSerializer.Serialize(_books);
File.WriteAllText(_filePath, json);
}
}
}C#ステップ4:Service層を設計する
Service層は、アプリの核心的な機能を実装します。Repository層を利用してデータを操作し、ビジネスロジックを実行します。
1. 本のサービスインターフェース
using ReadingApp.Models;
namespace ReadingApp.Services
{
// 本の操作を提供するサービスのインターフェースです
public interface IBookService
{
// すべての本を取得します
List<BookItem> GetAllBooks();
// 本を検索します
List<BookItem> SearchBooks(string keyword);
// 本を追加します
void AddBook(BookItem book);
// 本を更新します
void UpdateBook(BookItem book);
// 本を削除します
void DeleteBook(int id);
// 読書状況を更新します
void UpdateReadingStatus(int id, ReadingStatus status);
// 評価を更新します
void UpdateRating(int id, int? rating);
}
}C#2. 本のサービスの実装
using ReadingApp.Data;
using ReadingApp.Models;
namespace ReadingApp.Services
{
// 本の操作を提供するサービスです
public class BookService : IBookService
{
private readonly IBookRepository _repository;
// コンストラクタでリポジトリを注入します
public BookService(IBookRepository repository)
{
_repository = repository;
}
// すべての本を取得します
public List<BookItem> GetAllBooks()
{
return _repository.GetAll();
}
// 本を検索します
public List<BookItem> SearchBooks(string keyword)
{
if (string.IsNullOrWhiteSpace(keyword))
{
return _repository.GetAll();
}
return _repository.GetAll()
.Where(b => b.Title.Contains(keyword, StringComparison.OrdinalIgnoreCase) ||
b.Author.Contains(keyword, StringComparison.OrdinalIgnoreCase))
.ToList();
}
// 本を追加します
public void AddBook(BookItem book)
{
if (!InputValidator.IsValidTitle(book.Title))
{
throw new ArgumentException("タイトルは必須です。");
}
_repository.Save(book);
_repository.SaveChanges();
}
// 本を更新します
public void UpdateBook(BookItem book)
{
if (!InputValidator.IsValidTitle(book.Title))
{
throw new ArgumentException("タイトルは必須です。");
}
_repository.Save(book);
_repository.SaveChanges();
}
// 本を削除します
public void DeleteBook(int id)
{
_repository.Delete(id);
_repository.SaveChanges();
}
// 読書状況を更新します
public void UpdateReadingStatus(int id, ReadingStatus status)
{
var book = _repository.GetById(id);
if (book == null)
{
throw new ArgumentException("指定されたIDの本が見つかりません。");
}
book.Status = status;
_repository.Save(book);
_repository.SaveChanges();
}
// 評価を更新します
public void UpdateRating(int id, int? rating)
{
if (rating != null && !InputValidator.IsValidRating(rating))
{
throw new ArgumentException("評価は1〜5の範囲で指定してください。");
}
var book = _repository.GetById(id);
if (book == null)
{
throw new ArgumentException("指定されたIDの本が見つかりません。");
}
book.Rating = rating;
_repository.Save(book);
_repository.SaveChanges();
}
}
}C#ステップ5:依存関係を整理する
各層の関係を整理し、依存の方向を一方向に保ちます。
- Model層:他の層に依存しません。データの定義だけを行います。
- Repository層:Model層に依存します。データの保存・読み込みを担当します。
- Service層:Model層とRepository層に依存します。ビジネスロジックを実装します。
この構造により、たとえば「JSONファイルの代わりにデータベースを使う」場合でも、IBookRepository を実装した新しいクラスを作成するだけで済みます。
ステップ6:Program.cs で各層を統合する
最後に、Program.cs で各層を組み合わせ、アプリを起動します。
using ReadingApp.Data;
using ReadingApp.Models;
using ReadingApp.Services;
namespace ReadingApp
{
class Program
{
static void Main()
{
// リポジトリとサービスを初期化します
var repository = new JsonBookRepository("books.json");
var bookService = new BookService(repository);
// メインループ
while (true)
{
Console.WriteLine("\n読書管理アプリ");
Console.WriteLine("1. 本を追加");
Console.WriteLine("2. 本の一覧を表示");
Console.WriteLine("3. 本を検索");
Console.WriteLine("4. 読書状況を更新");
Console.WriteLine("5. 評価を更新");
Console.WriteLine("6. 本を削除");
Console.WriteLine("7. 終了");
Console.Write("選択: ");
string choice = Console.ReadLine()?.Trim() ?? "";
try
{
switch (choice)
{
case "1":
AddBook(bookService);
break;
case "2":
ShowAllBooks(bookService);
break;
case "3":
SearchBooks(bookService);
break;
case "4":
UpdateReadingStatus(bookService);
break;
case "5":
UpdateRating(bookService);
break;
case "6":
DeleteBook(bookService);
break;
case "7":
return;
default:
Console.WriteLine("1から7の番号を選んでください。");
break;
}
}
catch (Exception ex)
{
Console.WriteLine($"エラー: {ex.Message}");
}
}
}
// 以下は各操作の実装(省略)
}
}C#ステップ7:設計のポイントを確認する
- 単一責任の原則:各クラスは1つの役割だけを持ち、変更する理由を1つに限定します。
- 依存性逆転の原則:具象クラスではなくインターフェースに依存することで、実装の切り替えが容易になります。
- テスト容易性:Service層はRepository層のインターフェースに依存しているため、モックを使って単体テストが行いやすくなります。
Day 83のゴール
- Model層、Repository層、Service層の役割を理解し、設計できます。
- インターフェースを定義し、具象クラスを実装できます。
- 各層の依存関係を整理し、変更に強い構造を作れます。
まとめ
Day 83では、読書管理アプリのクラス設計を行いました。Model層でデータを定義し、Repository層でデータの永続化を担当させ、Service層でビジネスロジックを実装しました。この3層構造は、多くのアプリで通用する基本的な設計パターンです。
- Model層はデータの構造とルールを定義します。
- Repository層はデータの保存・読み込みを担当します。
- Service層はアプリの核心的な機能を実装します。
- インターフェースを活用し、依存関係を整理します。
