【Rails】デザインパターン「Service Object」の基本情報と実装方法

はじめに

Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。

MVCフレームワークでありがちなアンチパターンの一つとして「ファットコントローラー」があります。これは読んで字のごとく、コントローラーにいろいろな処理を詰め込んでしまった結果、コントローラーが肥大化してしまっている状態です。

ファットコントローラーを解消する手段として、コントローラー内の処理をモデルなどに移動する方法があります。しかし、それもいつかは限界が来て今度は「ファットモデル」という別のアンチパターンに陥る可能性が出てきます。

MVCフレームワークでは"Skinny Controllers, Fat Models"、つまり「痩せたコントローラー、太ったモデル」が推奨されています。コントローラーを太らせるよりモデルを太らせるほうがよいということです。

しかし、だからといって何千行、何万行もあるモデルでは全体の見通しが悪く、可読性・保守性が低いと言わざるを得ません。

そこで、MVCフレームワークでシステム開発を行う際には「デザインパターン」の設計が重要になってきます。コントローラーやモデルではない別のロジック層を用意し、処理を適切に分散することで可読性・保守性が向上します。

デザインパターンには多くのロジック層が存在します。この記事では「Service Object」について説明します。

Service Objectについて

概要

Service Objectとは、アプリケーションの中心となる処理を独立したクラスに集約するデザインパターンのことです。これを活用することで、以下のようなメリットが得られます。

  • コントローラーからビジネスロジックを分離できるので、コントローラーのコードが簡潔になり、責任範囲が明確になる
  • ビジネスロジックを再利用しやすくなるので、同じ処理を複数の場所で書く必要がなくなる
  • ビジネスロジックがService Objectに集約されているので、単体テストが容易になる

実装例

ユーザー登録処理を例にService Objectを実装してみます。

app/services/user_registration_service.rb

class UserRegistrationService
  def initialize(params)
    @params = params
  end

  def call
    user = User.new(@params)
    if user.save
      # 成功時の処理
    else
      # 失敗時の処理
    end
  end
end

app/controllers/users_controller.rb

class UsersController < ApplicationController
  def create
    service = UserRegistrationService.new(user_params)
    service.call
  end

  private

  def user_params
    params.require(:user).permit(:name, :email, :password)
  end
end

コントローラーはService Objectに処理を委譲し、ビジネスロジックの実装をService Objectに任せています。これにより、コントローラーのコードが簡潔になり、ビジネスロジックの再利用性が高まります。

Service Objectを効果的に活用するためのポイントは以下の通りです。

  • callメソッドはシンプルに保ち、それ以外のロジックは別のメソッドに分離する
  • 直接インスタンス化を避け、クラスメソッド経由で呼び出せるようにする
  • コンストラクターはできる限りシンプルに保ち、依存関係の管理を容易にする
  • 責任範囲は適切な粒度に保ち、肥大化を避ける
  • ビジネスロジックの意図が明確に伝わるよう、命名に工夫を凝らす

まとめ

Service Objectは、コントローラーの肥大化を防いだり、モデルの肥大化を防いだりと、様々な場面で活用できます。また、ビジネスロジックの再利用性が高まるので、DRYの原則に沿ったコーディングが可能になります。

ただし、過剰な抽象化は避け、適切な粒度でService Objectを設計することが重要です。また、依存関係の管理にも注意を払う必要があります。

Railsアプリケーションの設計を改善し、保守性と拡張性を高めるために、Service Objectパターンを活用してみてはいかがでしょうか。ビジネスロジックを適切に集約することで、よりメンテナンス性の高いアプリケーションを構築できるはずです。

関連記事

【Rails】RSpecを使った自動テスト《システムスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 17:07
【Rails】RSpecを使った自動テスト《リクエストスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 16:06
【Rails】RSpecを使った自動テスト《コントローラースペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 15:39
【Rails】RSpecを使った自動テスト《モデルスペック編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月11日 11:50
【Rails】RSpecを使った自動テスト《基本編》
# はじめに Railsでアプリケーションを開発する際、品質を担保するためにテストは欠かせません。その中でも、RSpecは多くの開発者に愛用されているテストフレームワークです。 今回は、RSpecを使ったRailsアプリケーションのテスト方 [...]
2024年7月10日 17:49
【Rails】デザインパターン「Concern」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月10日 13:32
【Rails】デザインパターン「Form Object」の基本情報と実装方法
# はじめに Ruby on RailsなどのMVCフレームワークで構築したWebシステムにはアンチパターンというものが存在します。システム開発におけるアンチパターンとは、避けるべき悪い設計や実装方法のことを指します。 MVCフレームワーク [...]
2024年7月6日 22:50
【Rails】Dockerを使用してRuby on Railsの開発環境を構築
# はじめに Ruby on Railsは強力なWebアプリケーションフレームワークですが、開発環境の構築には時間がかかることがあります。特に、チーム全体で一貫した環境を維持することは困難な場合があります。 Dockerを使用することで、R [...]
2024年7月5日 18:49