注目イベント!
春の新人向け連載企画開催中
新人エンジニアの皆さん、2024春、私たちと一緒にキャリアアップの旅を始めませんか?
IT業界への最初の一歩を踏み出す新人エンジニアをサポートする新連載スタート!
mameyose

7歳娘「パパのサービスクラス、肥大化しそうだよ?」

| 8 min read
Author: masahiro-shimokawabe masahiro-shimokawabeの画像

とある休日の我が家

#

ワイ「おいおい」
ワイ「ワイって天才とちゃうか?」
ワイ「(カタカタカタ...)」
ワイ「(ッターーーン!!!)」
ワイ「あ、死んだ」

娘(7歳)「パパ、今日は何してるの?」

ワイ「おお、娘ちゃん」
ワイ「今日はな、SpringBootでサービスクラスを実装するお勉強してねん」
ワイ「お題はシンプルにタスク管理ツールや!」

娘「わぁ、すごい!」

ワイ「ゲヘヘ///」
ワイ「せやろ〜?」

娘「ちょっと、見ても良い?」

ワイ「おお、ええでええで!」
ワイ「いまちょうど」

ワイ「↑こんなユースケースを実装し終わったところや」

TaskService.java
@RequiredArgsConstructor
@Service
public class TaskService {

    private final ITaskRepository repository;
    private final INotifier notifier;

    @Transactional
    public Long add(final String title, final String description, final Long assigneId) {

        var task = Task.create(title, description, assigneId);
        var savedTask = this.repository.save(task);

        if (task.isAssigned()) {
            this.notifier.notify(task.getAssigneId());
        }

        return savedTask.getId();
    }

    public Task get(final Long taskId) {

        var maybeTask = this.repository.findById(taskId);
        var foundTask = maybeTask
            .orElseThrow(() -> new UseCaseException("Task not found."));

        return foundTask;
    }

}

ワイ「↑コードはこんな感じや」

娘「えっと――」

TaskService.java
@Transactional
public Long add(final String title, final String description, final Long assigneId) {

    var task = Task.create(title, description, assigneId);
    var savedTask = this.repository.save(task);

    if (task.isAssigned()) {
        this.notifier.notify(task.getAssigneId());
    }

    return savedTask.getId();
}

娘「↑これが、タスクを追加できる」
娘「っていうユースケースを実装したメソッドで」

TaskService.java
public Task get(final Long taskId) {

    var maybeTask = this.repository.findById(taskId);
    var foundTask = maybeTask
        .orElseThrow(() -> new UseCaseException("Task not found."));

    return foundTask;
}

娘「↑こっちが、タスクを取得できる」
娘「っていうユースケースを実装したメソッドなんだね」

ワイ「せやせや」

娘「なるほど~」
娘「でも、なんだか」
娘「パパのサービスクラス、肥大化しそうだよ?

ワイ「なん・・・だと・・・」

肥大化しそうなサービスクラスとは?

#

娘「例えば、このあと」

娘「↑こんなユースケースも実装することになると思うんだけど」
娘「このロジックってどこに書くつもりなの?」

ワイ「そら、TaskServiceやろな」

娘「じゃあ、さらに」

娘「↑こういうユースケースが追加されることになったら?」

ワイ「TaskServiceやろな」

娘「どうして?」

ワイ「え?だって」
ワイ「タスクに関するサービスを提供することが責務の」
ワイ「TaskServiceっていうクラスがあるんやから」
ワイ「そこに実装するのがええんやない?」

娘「そうそれなの!」

ワイ「と言いますと?」

娘「えっとね」
娘「TaskServiceっていう」
娘「意味範囲の広い抽象的なクラス名から連想される」

ワイ「タスクに関するサービスを提供すること・・・」

娘「↑こういう抽象的な責務によって」
娘「タスクに関するあらゆるロジックが」
娘「TaskServiceに実装できそうに見えちゃってるの」

ワイ「えっと、つまり・・・」
ワイ「サービスクラスの名前が」
ワイ「あれやこれやと色んな解釈がなされてしまう」
ワイ「そんな曖昧な名前やから」
ワイ「あんな処理も」
ワイ「こんな処理も」
ワイ「TaskServiceに実装したくなってる」
ワイ「・・・ってこと?」

娘「うん、そういうことだね」
娘「だからこのままだと」
娘「タスクに関する仕様が追加されるたびに」
娘「TaskServiceにそのロジックが追加され」
娘「そのロジックに必要な依存クラスが追加され」
娘「だんだんサービスクラスが肥大化していくんだよ」

ワイ「なるほどな」
ワイ「ってことは、TaskServiceっていう名前を」
ワイ「もっと具体的なアレな感じにすればええわけやから――」

- public class TaskService {
+ public class TaskAddAndGetService {
}

ワイ「↑こうやな!」

娘「ううん、全然違う」
娘「それじゃ何の解決にもなってないの」
娘「なんなら、さらに悪化してる」

ワイ「Oh・・・」
ワイ「ほな、どないしたらええんや・・・」

娘「パパ、そんなときは」
娘「ユースケース単位でサービスクラスを定義してあげたら良いんだよ!」

ユースケース単位でサービスクラスを定義する

#

娘「そしたら、ちょっと」

娘「↑このユースケースを実装し直して見せるね」

ワイ「おお、さすが娘ちゃん!」
ワイ「ありがとうやで」

娘「じゃあ、まず」
娘「このユースケースに対応するクラスを定義すると」

TaskAddUseCase.java
@Service
public class TaskAddUseCase {
}

娘「↑こうなるよ」

ワイ「ふむふむ」
ワイ「タスク追加できるユースケースだから」
ワイ「TaskAddUseCaseってことね」

娘「そう」
娘「で、このTaskAddUseCaseに」
娘「TaskServiceadd()を移動してあげて――」

TaskAddUseCase.java
@Service
public class TaskAddUseCase {
+   @Transactional
+   public Long add(final String title, final String description, final Long assigneId) {
+
+       var task = Task.create(title, description, assigneId);
+       var savedTask = this.repository.save(task);
+
+       if (task.isAssigned()) {
+           this.notifier.notify(task.getAssigneId());
+       }
+
+       return savedTask.getId();
+   }
}

娘「↑こうだね」

娘「でもこのままだと」
娘「コントローラークラスからこのメソッドを呼び出したときに――」

TaskController.java
taskAddUseCase.add(title, description, assigneId);

娘「↑こう、なんだかユースケースに何かを追加する」
娘「みたいな文脈になっちゃうから」

娘「メソッド名は――」

TaskAddUseCase.java
@Service
public class TaskAddUseCase {
    @Transactional
-   public Long add(final String title, final String description, final Long assigneId) {
+   public Long execute(final String title, final String description, final Long assigneId) {

        var task = Task.create(title, description, assigneId);
        var savedTask = this.repository.save(task);

        if (task.isAssigned()) {
            this.notifier.notify(task.getAssigneId());
        }

        return savedTask.getId();
    }
}

娘「↑こうしておくね」

ワイ「なるほどね」
ワイ「たしかにこっちのが――」

TaskController.java
taskAddUseCase.execute(title, description, assigneId);

ワイ「↑ユースケースを実行する」
ワイ「って感じで、違和感ないな!」

娘「そう」
娘「他にもhandleっていう名前にしても良いかもね」

ワイ「ふむふむ」

娘「それで最後にadd()が依存してるクラスを」
娘「TaskServiceから持ってきて――」

TaskAddUseCase.java
@RequiredArgsConstructor
@Service
public class TaskAddUseCase {

+   private final ITaskRepository repository;
+   private final INotifier notifier;

    @Transactional
    public Long execute(final String title, final String description, final Long assigneId) {

        var task = Task.create(title, description, assigneId);
        var savedTask = this.repository.save(task);

        if (task.isAssigned()) {
            this.notifier.notify(task.getAssigneId());
        }

        return savedTask.getId();
    }
}

娘「↑完成だよ!」

ワイ「おお、なんかめっちゃシンプルになったな!」

娘「でしょう」
娘「ユースケース単位でサービスクラスを定義するから」
娘「そのユースケースにあった具体的な名前を付けようってなるでしょ?」

ワイ「せやな」

娘「そうすると、責務が明確になって」
娘「そのユースケースを実現するためのロジックと」
娘「それに必要な依存クラスだけが集約されるようになるの」

ワイ「なるほどな」
ワイ「たしかに、これだったら」
ワイ「さっき娘ちゃんが言ってたような」

ワイ「↑こんなユースケースが追加になっても」
ワイ「TaskAddUseCaseに実装しようとはならんよな」

娘「そう」
娘「だから、ひとつのサービスクラスがどんどん肥大化する」
娘「ってことが避けられるんだよ」

ワイ「なるほどなぁ」
ワイ「やっぱり、名前設計って大事なんやな」

娘「そうだね」
娘「名は体を表すっていうからね」

ワイ「たしかに」

娘「あ、それからね」
娘「他にも良いことがあるの」

ワイ「そうなん?」

娘「うん」

ユースケースが把握しやすい

#

娘「まず」
娘「ディレクトリを見ただけで」
娘「このシステムにどんなユースケースがあるのかが把握しやすくなってるの」

usecase
└tasks
 ├TaskAddUseCase.java
 ├TaskDeleteUseCase.java
 ├TaskEditUseCase.java
 └TaskGetUseCase.java

娘「↑ほら」

ワイ「おお、ほんまや!」
ワイ「ユースケース図とのマッピングも簡単やし」
ワイ「なんだか、ユースケースの自己文書化って感じやな」

娘「そう!」
娘「それからね?」

テストが書きやすくなる

#

娘「サービスクラスのテストが書きやすくなるの」

ワイ「と言うと?」

娘「肥大化したサービスクラスって」
娘「たくさんの依存クラスがあるでしょ?」

娘「↑こんな感じで」

ワイ「せやな」

娘「でも、テスト対象のメソッドでは」
娘「その一部しか使ってないことが多いの」

娘「↑こんな風に」

ワイ「あ〜、たしかに」
ワイ「サービスクラスにあれこれとDIせなアカンわりには」
ワイ「テスト対象のメソッドでモックするクラスって意外と少ないよな」

娘「そうなの」
娘「それに、そのモックしないといけないクラスがどれなのかって」
娘「コードを読み解くのがちょっと面倒じゃない?」

ワイ「せやな」

娘「でも、ユースケース単位でサービスクラスが定義されてると」
娘「そのユースケースの実現に必要な依存クラスだけが集約されてるから」
娘「必要なクラスだけをDIすれば良いし」
娘「そのクラスはテスト対象のメソッドで必ず使われてるの」

ワイ「なるほどね」
ワイ「つまり、どのクラスをモックすれば良いのか」
ワイ「迷わなくなるってわけやな」

娘「そういうこと!」

ワイ「ありがとうやで、娘ちゃん」
ワイ「勉強になったわ」

まとめ

#
  • サービスクラスが意味範囲の広い抽象的な名前になっていると
    責務が曖昧になって肥大化しやすい

  • ユースケース単位でサービスクラスを定義すると
    具体的な名前が付けられ、責務が明確になり、肥大化しずらい

  • おまけに
    • ユースケースが把握しやすくなる
    • テストコードが書きやすくなる

ワイ「↑ってことやな!」

娘「そうだね!」

おまけ

#

ワイ「TaskAddUseCaseexecute()の引数と戻り値は」

TaskAddUseCase.java
public TaskAddResponse execute(final TaskAddRequest request) {

    var task = Task.create(
        request.getTitle(),
        request.getDescription(),
        request.getAssigneId());

    // ~省略~

    return new TaskAddResponse(savedTask);
}

ワイ「↑こんな感じでDTOにしておくと」

  • プレゼンテーション層から渡されるデータに変更があってもシグネチャを変更しなくてよい
  • ドメインオブジェクトをプレゼンテーション層に非公開にできる

ワイ「↑っていうメリットがありますやで!」

娘「じゃあ、ディレクトリ構造は」

usecase
└tasks
 └add
  ├TaskAddRequest.java
  ├TaskAddResponse.java
  └TaskAddUseCase.java

娘「↑こんな感じだね」

ワイ「せやな!」

豆蔵では共に高め合う仲間を募集しています!

recruit

具体的な採用情報はこちらからご覧いただけます。