RailsのConcern(ActiveSupport::Concern)は、モデルやコントローラの振る舞いをモジュールに切り出してincludeする仕組みです。「アンチパターンだ」という批判がある一方、Rails作者のDHHが率いる37signalsはBasecampとHEYでConcernを多用しています。評価が割れる理由は、同じ道具を「役割の切り出し」にも「行数の隠し場所」にも使えるためです。この記事では、Rails 8.1.4とRuby 4.0.6で実際に動かしたコードで基本の使い方を確認し、アンチパターンになる症状と、Concernにする・しないの判断基準を整理します。
まとめ:Concernがアンチパターンになるのは行数で切ったとき
- Concern自体はアンチパターンではありません。Rails 4.0から
app/models/concernsとapp/controllers/concernsが標準ディレクトリになり、Rails 8の認証ジェネレータもAuthenticationというConcernを生成します。 - 問題になるのは、行数や種類(バリデーション・コールバック)で機械的に切ったConcernです。クラスの責務は減らず、メソッドの定義元とコールバックの実行順が見えにくくなります。
- 1つのモデル専用でも、役割に名前を付けられるならConcernにしてよい。37signalsは単一モデル内の整理を最も多い用途に挙げ、
app/models/<モデル名>/に置いています。「2つ以上のクラスで使うまで切り出さない」は厳しすぎる基準です。 - 複数モデルをまたぐ手続きはConcernの外へ出します。Concernは入口のメソッドだけを持ち、処理本体は別のクラス(PORO)に任せます。
- RuboCopの
Metrics/ClassLength警告を消すためだけの分割は、警告が消えても責務は減りません。Concern自体もMetrics/ModuleLengthの100行制限を受け、concerningで同じファイル内に書いた行はクラスの行数に数えられます。
ActiveSupport::Concernの基本:included・class_methods・依存の解決
ActiveSupport::ConcernはRails 3.0から同梱されているモジュールで、素のRubyモジュールに3つの機能を足します。include先のクラスで評価するincludedブロック、クラスメソッドを定義するclass_methodsブロック、Concern同士の依存の自動解決です(Rails APIドキュメントのActiveSupport::Concern)。app/models/concernsはZeitwerkの自動読み込みのルートなので、commentable.rbの定数名はConcerns::CommentableではなくCommentableになります(読み込みの規則はZeitwerkの解説を参照)。
# app/models/concerns/commentable.rb
module Commentable
extend ActiveSupport::Concern
included do
has_many :comments, as: :commentable, dependent: :destroy
end
class_methods do
def commented
joins(:comments).distinct
end
end
def latest_comment
comments.order(created_at: :desc).first
end
end
# app/models/post.rb
class Post < ApplicationRecord
include Commentable
end
Concernまわりの機能は版ごとに追加されてきました。古い記事のコードを読むときは、どの版の書き方かを確かめてください。
| 機能 | 追加された版 | 用途 |
|---|---|---|
| ActiveSupport::Concern・included | Rails 3.0 | include時にクラス側で評価 |
| concernsディレクトリ | Rails 4.0 | models・controllersの標準配置 |
| Module#concerning | Rails 4.1 | クラス内でConcernを定義 |
| class_methods | Rails 4.2 | module ClassMethodsの代替 |
| prepend対応・prepended | Rails 6.1 | prepend時にクラス側で評価 |
根拠はRailsの各版のCHANGELOGです(4.2のclass_methods、6.1のprepend対応)。1つのConcernにincludedを2回書くとActiveSupport::Concern::MultipleIncludedBlocksが発生します。
素のmoduleとの違い:依存するConcernの自動解決
ActiveSupport::Concernを使う最大の理由は、Concernが別のConcernに依存するときの扱いです。素のモジュールでself.includedを書くと、内側のモジュールのincludedは外側のモジュールに対して実行されます。次の素のモジュールの例では、クラスメソッドを最終的なinclude先へ渡す処理がないため、呼び出し時に例外になります。
# 素のmodule:PlainTrackable の included は PlainAudited に対して走る
module PlainTrackable
def self.included(base)
base.class_eval { def self.track_field(n) = (@tracked ||= []) << n }
end
end
module PlainAudited
include PlainTrackable
def self.included(base)
base.track_field(:updated_at)
end
end
begin
Class.new { include PlainAudited }
rescue NoMethodError => e
puts e.message # undefined method 'track_field' for class ...
end
# Concern:依存先の class_methods も include 先へ付く
module Trackable
extend ActiveSupport::Concern
class_methods do
def track_field(n) = (@tracked ||= []) << n
def tracked = @tracked
end
end
module Audited
extend ActiveSupport::Concern
include Trackable
included do
track_field :updated_at
end
end
Class.new { include Audited }.tracked
# => [:updated_at]
インスタンスメソッドを共有するだけなら素のモジュールで足ります。has_manyやscopeのようなクラスマクロを呼ぶ場合と、Concern同士に依存がある場合はActiveSupport::Concernを使います。
モデルのConcern:共通Concernとモデル専用Concernの置き場所
モデルのConcernには2つの使い方があり、置き場所も分かれます。37signalsのJorge Manrubiaは「Good concerns」(2022年10月10日)で、複数モデルの共通Concernをapp/models/concernsに、1モデル専用のConcernをapp/models/<モデル名>/に置く規約を紹介しています。
複数モデルで共有するConcern:app/models/concerns
公開状態・論理削除・タグ付けのように、複数のモデルが同じインターフェースで持つ振る舞いは共通Concernにします。DHHは2012年12月18日の「Put chubby models on a diet with concerns」で、BasecampにTrashable・Visible・Taggableなど約40のConcernがあると書いています。
# app/models/concerns/publishable.rb
module Publishable
extend ActiveSupport::Concern
included do
scope :published, -> { where.not(published_at: nil) }
end
def publish!
update!(published_at: Time.current)
end
end
# posts・articles の両テーブルに published_at(datetime)がある前提
class Post < ApplicationRecord
include Publishable
end
class Article < ApplicationRecord
include Publishable
end
Post.published # 公開済みの投稿
Article.published # 公開済みの記事
1モデルの役割を切り出すConcern:app/models/<モデル名>/
「Good concerns」によると、37signalsでConcernを最も多く使う場面は1つのモデルの中のコード整理です。BasecampのRecordingはRecording::Completableをapp/models/recording/completable.rbに置き、モデル側はinclude Completableと書くだけです。HEYのTopicモデルは、Accessible・Deletable・Incineratableなど20個以上のConcernをincludeしています。Rails 8.1.4で同じ構成を作ると、名前空間付きの定数として自動読み込みされました。
# app/models/post/archivable.rb
module Post::Archivable
extend ActiveSupport::Concern
def archive!
update!(published_at: nil)
end
end
# app/models/post.rb
class Post < ApplicationRecord
include Archivable # Post::Archivable が読み込まれる
end
Post.instance_method(:archive!).owner # => Post::Archivable
bin/rails zeitwerk:checkも「All is good!」を返しました。1モデル専用のConcernが成立する条件は、名前が役割を表していることです。ArchivableやExaminerのように「何ができるか」を言い表せるなら、モデルを読む人は名前だけで中身を推測できます。
コントローラのConcern:Rails 8の認証ジェネレータが作るAuthentication
コントローラのConcernには、Rails自身が生成する実例があります。Rails 8.1.4でbin/rails generate authenticationを実行すると、app/controllers/concerns/authentication.rbが作られ、ApplicationControllerにinclude Authenticationが挿入されます(Rails Security Guide)。生成されたファイルの冒頭は次のとおりです。
# app/controllers/concerns/authentication.rb(生成直後・抜粋)
module Authentication
extend ActiveSupport::Concern
included do
before_action :require_authentication
helper_method :authenticated?
end
class_methods do
def allow_unauthenticated_access(**options)
skip_before_action :require_authentication, **options
end
end
private
def require_authentication
resume_session || request_authentication
end
# resume_session・start_new_session_for などが続く
end
このConcernはcookies・session・requestに依存しています。これらはActionController::Baseを継承する通常の構成では利用できますが、API専用構成ではCookieやセッションの追加設定が必要です。Concernを組み込む前に、include先が必要な機能を備えているか確認します。避けるべきなのは、特定のコントローラにしかないインスタンス変数(@postなど)を前提にすることと、モデルに置くべき業務ロジックを「コントローラ間で重複しているから」とコントローラのConcernへ移すことです。重複しているロジックは、まず該当するモデルのメソッドにします。APIモードでの認証の扱いはRails APIの作成手順とJWT認証の解説で扱っています。
ルーティングのconcern:concern :commentableでネストルートを共通化
config/routes.rbのconcernは、ActiveSupport::Concernとは別の機能です。複数のリソースに同じネストルートを付けるときに使います(Rails Routing GuideのRouting Concerns)。
# config/routes.rb
Rails.application.routes.draw do
concern :commentable do
resources :comments, only: [:index, :create]
end
resources :posts, concerns: :commentable
resources :articles, only: [:show], concerns: :commentable
end
bin/rails routesの結果には、/posts/:post_id/commentsと/articles/:article_id/commentsのGETとPOSTが並びました。モデルのCommentableと名前を揃えると、ルートとモデルの対応を追いやすくなります。
Concernがアンチパターンになる4つの症状
「Good concerns」の著者自身も、Concernで「整理されて見えるだけの太ったモデル」を作った経験を書いています。次の症状が1つでも出ていれば、Concernの切り方を見直します。
行数や種類で切った分割:validations.rb・callbacks.rb
User::Validations・User::Callbacksのように種類で切ったConcernや、RuboCopの警告を消すために行数で切ったConcernは、名前から業務上の役割がわかりません。各クラスやモジュールを上限以内に分割すれば行数警告は消せますが、それだけでは責務の整理になりません。RuboCop 1.92.1の既定値ではMetrics/ClassLengthとMetrics/ModuleLengthがどちらも100行で、110行のconcerningブロックを持つクラスは「Class has too many lines. [112/100]」、110行のConcernは「Module has too many lines. [111/100]」と警告されました(RuboCopのdefault.yml)。Rails 7.2以降の新規アプリが使うrubocop-rails-omakaseは、Metrics系の警告を最初から無効にしています。RuboCopの設定方法はRuboCopの使い方と.rubocop.ymlの解説を参照してください。
コールバックの実行順:include位置による変化
Concernのincludedで登録したbefore_saveは、モデル本体のbefore_saveとの前後関係がinclude行の位置で決まります。検証用のPublishableのincludedにbefore_saveを1つ足してRails 8.1.4で確かめると、include Publishableを先に書いたPostは[:publishable, :post]、before_saveを先に書いたArticleは[:article, :publishable]の順で実行されました。モデル側に呼び出しが書かれていないまま値が書き換わるので、保存時の不具合を追うときに見落とします。順序に意味のあるコールバックは、Concernに入れずモデル本体に並べて書きます。
include先のメソッドや変数への暗黙依存
Concernの中でinclude先の@current_planやtax_rateのようなメソッドを黙って呼ぶと、モデル側の変更でConcernが壊れます。前提のメソッドがあるなら、Concern側に同名のメソッドを置いて必要な戻り値をコメントで示し、未実装のクラスでは呼び出した時点で例外になるようにします。このときNotImplementedErrorがよく使われますが、Rubyのドキュメントでは「現在のプラットフォームで実装されていない機能」に使う例外とされています(Ruby公式ドキュメントのNotImplementedError)。ScriptErrorの子クラスなので、Ruby 4.0.6でもrescue => eでは捕捉されませんでした。アプリケーション内の約束を示すなら、StandardErrorを継承した例外を使います。値を受け取れる処理は引数で渡す形にすると、依存がメソッドの定義に現れます(依存性逆転の原則とDIの違い)。
module Billable
extend ActiveSupport::Concern
def total_with_tax
(subtotal * (1 + tax_rate)).round
end
private
# include先で税率(0.1 など)を返す
def tax_rate
raise MissingImplementation, "#{self.class} は tax_rate を実装してください"
end
end
# app/models/missing_implementation.rb
class MissingImplementation < StandardError; end
テストでは、Concernを実際にincludeするモデルごとにtotal_with_taxを呼び、戻り値まで確かめます。例外を置くだけでは、誤った値を返す実装は見つけられないためです。
Concernへの業務手続きの集中と別クラスへの委譲
複数のモデルを更新する手続き、外部APIの呼び出し、数十行の処理フローをConcernに書くと、Concernはモデルの外に置いた「Fat Model」になります。37signalsの「Vanilla Rails is plenty」(2022年11月8日)では、Recordingの削除をRecording::IncineratableというConcernが受け持ちますが、Concernは入口のincinerateメソッドだけを持ち、処理本体は別のクラスに任せています。
# 「Vanilla Rails is plenty」掲載のコード
module Recording::Incineratable
def incinerate
Incineration.new(self).run
end
end
呼び出し側はrecording.incinerateと書けて、処理の中身はRecording::Incinerationという普通のRubyクラスで単体テストできます。この形にすると、Concernは役割の窓口になり、モデルが手続きを抱え込むことを防げます。
判断基準:Concernにする・しないの分かれ目
「Concernはアンチパターンか」に対する答えは、切り出す単位で変わります。迷ったときは次の表で選びます。
| 状況 | 選ぶもの | 置き場所 |
|---|---|---|
| 複数モデルが同じ振る舞いを持つ | 共通Concern | app/models/concerns |
| 1モデルの役割に名前を付けられる | モデル専用Concern | app/models/モデル名/ |
| 1ファイルのまま区切りたい | concerning | モデル本体 |
| 複数モデルをまたぐ手続き | PORO・サービス | app/models か app/services |
| 行数警告を消したいだけ | 分割しない | – |
判定で使う問いは1つです。そのConcernに「〜できる」「〜の役割」と言える名前を付けられるか。名前が付けにくい場合は、異なる責務が混ざっていないかを疑います。名前を付けられた場合も、中身がその役割の処理だけでまとまっているかを確かめます。判断の軸は再利用の有無ではなく、この凝集性です。2つ目の利用箇所が出るまで待つべきなのは、共通Concernのほうです。
逆に、Concernを採用しないほうがよいのは、チームに命名と置き場所の規約が無い場合です。規約の無いまま増やすと、定義元やConcern間の依存関係を追いにくくなります。個数や入れ子の有無だけでなく、責務のまとまりと依存関係を説明できるかで判断します。分割の受け皿をサービスやquery objectまで含めて選ぶ手順はRailsのFat Model対策の記事、InteractorなどのパターンはRubyのデザインパターンで解説しています。長く運用したRailsアプリでConcernの整理と機能追加を並行して進める体制を作りたい場合は、保守運用・内製化支援で相談を受けています。
Concernのメソッドの定義元を調べる方法とテスト
Concernの定義元と探索順:source_location・ancestorsによる確認
Concernを使うと、メソッドがどのファイルにあるかを読んだだけではわからなくなります。調べるには、Rubyの標準メソッドで定義元を出します。Rails 8.1.4のコンソールで実行した結果です。
Post.instance_method(:publish!).source_location
# => [".../app/models/concerns/publishable.rb", 9]
Post.method(:commented).owner
# => Commentable::ClassMethods
Post.ancestors.take(4).map(&:name)
# => ["Post", "Post::Ranking", "Post::Archivable", "Publishable"]
ancestorsの並びはメソッド探索の順番です。同じ名前のメソッドがクラス本体とConcernの両方にあると、クラス本体の定義が使われます。この検証用のPostは、本体の中に次の区切りを持っています。concerningで書いた区切りもPost::Rankingというモジュールとして並びます。
class Post < ApplicationRecord
include Commentable
include Publishable
include Archivable
concerning :Ranking do
def score
comments.size * 10
end
end
end
Concernの単体テスト:ダミーモデルへのincludeによる検証
共通Concernは、実在のモデル経由ではなく、テストの中に置いたダミーのモデルでテストすると、include先の都合から切り離して確かめられます。次のテストはRails 8.1.4のMinitestで通りました(1 runs, 4 assertions, 0 failures)。
# test/models/concerns/publishable_test.rb
require "test_helper"
class PublishableTest < ActiveSupport::TestCase
class Host < ApplicationRecord
self.table_name = "posts"
include Publishable
end
test "publish! で published スコープに入る" do
host = Host.create!(title: "draft")
assert_not_includes Host.published, host
host.publish!
assert_includes Host.published, host
end
end
モデル専用Concernは、モデルの一部として既存のモデルのテストに含めます。単体で取り出してテストしたくなるなら、そのConcernは独立したクラスにできる候補です。
よくある質問
RailsのConcernは使わないほうがよいのですか?
いいえ。Rails 4.0からconcernsディレクトリが標準で用意され、Rails 8の認証ジェネレータもConcernを生成します。避けるべきなのは、行数や種類で機械的に切り出して、名前から役割がわからないConcernを作ることです。
concernとconcerningの違いは何ですか?
concerningはRails 4.1で追加された、クラスの中でConcernを定義するメソッドです。別ファイルに分けずに区切りを付けられますが、RuboCopのMetrics/ClassLengthではクラスの行数に数えられます。複数のモデルで使うなら別ファイルのConcernにします。
ActiveSupport::Concernを使わず素のmoduleでもよいですか?
インスタンスメソッドを共有するだけなら素のmoduleで足ります。has_manyやscopeなどのクラスマクロを使う場合と、Concernが別のConcernに依存する場合は、ActiveSupport::Concernを使うとinclude先へのクラスマクロの適用と依存先のクラスメソッドの取り込みを簡潔に書けます。素のmoduleでも実装できますが、includedフックやextendなどを自分で組み合わせる必要があります。
Concernの中でinclude先のメソッドを前提にしてよいですか?
前提にするなら、必要なメソッドと戻り値をConcern側に明記し、include先との組み合わせをテストします。未実装を例外で知らせる場合は、NotImplementedErrorではなくStandardErrorを継承した例外を使うと、通常のrescueで扱えます。黙って呼ぶと、モデル側の名前変更でConcernが壊れても気づくのが遅れます。
Concernとサービスクラスはどう使い分けますか?
モデルの役割(公開できる、アーカイブできる)を表す振る舞いはConcern、複数のモデルをまたぐ手続きや外部連携はサービスクラスやPOROにします。37signalsのように、Concernには入口のメソッドだけを置き、処理本体を別クラスへ任せる組み合わせもあります。サービスクラスを何にでも使うと、今度はサービスが乱立する別のアンチパターンになります。