維持業務におけるリファクタリング

こんにちは。

 ファンデリーでは受託ではなく、自社で企画・開発・運用しているプロダクトで事業を進めています。サービス自体は10年以上前から続いており、機能追加や改修を重ねながら今に至っています。

 事業が続くほどコードの量も判断の分岐も増えます。正常に動いている処理まで、常に細部を見続けるのは現実的に難しいです。だからこそ、あとから触る人が迷わない状態へ少しずつ寄せていく必要があります。

 私は現在自社サービスの管理・維持のなかでリファクタリングを中心に担当しておりますので、そのときに自分が基準にしている考え方と、実際に手を入れている点をまとめてみようと思います。


目次

・チームでのリファクタリングの方針
・約束がないと起きること
・処理の散在
・実際に取り組んでいること
・AIが増えるほど、読みやすさの価値は上がるかもしれない?
・おわりに

チームでのリファクタリングの方針

 ルールは企業や事業、チームによって様々ですが、私たちは以下のようなことに気をつけるようにしています。至って一般的なものだと思います。

  • マジックナンバーは使わない
  • 二重否定になる条件式や変数名は使わない
  • 命名は、責務や役割が直感的に伝わるものにする
  • コメントはドメイン知識(仕様の背景や、なぜその実装にしたか)に限定
  • 小さく作る(YAGNI原則のようなもの)
  • 単一責任(1つのメソッドやクラスが担う役割は1つにする)
  • 処理の正本はバックエンドに置く

 長く動いているサービスでは、「動いているから触らない」ものが増えていくため、「動いているうちに読みやすくしておく」タイミングを意図的に作らないと不具合が起こった時に初めてコードの複雑さに気がつくということが起きてしまいます。

 また上記のような約束ごとがチームやアプリケーション単位でない場合、実装や直し方が属人的になってしまいます。


約束がないと起きること

 例えば命名規則の約束事が曖昧だと、同じ判定でも「売れるか」「買えるか」「表示するか」が混ざります。
二重否定が多いと、レビューで条件の真偽を毎回読み直すことになります。
コメントが処理の見出しばかりだと、仕様変更の背景が残らず、後から「なぜこうなっているか」をコードから推測するしかありません。

 私たちのチームではコードの説明(メソッド名の日本語訳的な内容)をメソッドの上に書くようなコメントの使い方をやめようと決まっています。それはコードの中身を見ればわかるし、一目でわからないような複雑なメソッドを作らないというYAGNI原則や単一責務の約束にもつながります。

悪い例

# 終了日を見て false を返す
def available?
  return false unless !item.not_invalidated?
  return false if !item.not_ended?
  return false unless !hidden_on_ec?(item)
  true
end

良い例

# 終了日当日は販売可。翌日以降を不可とする(コードの訳ではなく、運用ルールの説明)
def sellable?
  return false if invalidated?
  return false if ended?
  return false if hidden_on_ec?
  true
end

 かなり極端な例ですが、一見した時の読みやすさはかなり違うと思います。
この違いが数百行、数百ファイルにわたり存在すると考えると後者であるべき理由は明確に感じます。

 約束そのものは地味ですが、約束がないまま機能だけ増やすと、可読性が悪くなり調査のたびに「この分岐はどの画面用か」、「どちらが正か」調査や改修の影響範囲が大きく、多大な時間を費やすことになります。


処理の散在

 これは、ビューには価格が直書きされている一方で、計算処理側では定数として定義されている、といったケースです。

 長く維持されているアプリケーションほど、その場の緊急対応や部分的な機能追加で孤立したコードが生まれ、そのまま残ってしまうことがあります。またファイルが多く、画面・バッチ・管理画面・APIなどが、同じ意味の定義を別の場所で持っていると、次のようなことが起きやすくなります。

  • 同じ販売可否の条件が、一覧・詳細・保存の各所に別々の書き方で残る
  • 料金や購入条件の参照先が複数あり、改定や仕様変更のたびに影響範囲が読みにくい
  • フロントとサーバのどちらを信じるかが、処理ごとに違う

いずれもその瞬間は動いていても、次の改修や調査のコストを上げる要因となります。

 データ改ざんなどのセキュリティや信頼性の観点でも、金額や購入可否のような確定に効く判断は画面側の一時的な計算ではなく、サーバ側で揃えておく必要があります。画面の数字は、ユーザー操作や表示タイミングで変わり得るからです。

こういった理由で「全部を一気に書き換える」のではなく、「正の置き場所を決めて、そこに寄せる」ようにしています。


実際に取り組んでいること

弊社の主軸は冷凍食品の販売です。触っているコードも、販売可否・購入条件・料金まわりが多いです。直近では、前節までに書いた散在を一度に解消しようとはせずに以下のように進めています。

実際にどんなコードをリファクタリングしているのかのイメージをしやすいようにコード例も書いておきます。

1. 別定義になっていた販売条件をそろえる

「今売ってよいか」が、一覧用の絞り込みと、1件判定と、保存前チェックで別々に書かれている箇所がありました。
 今回は対象の商品・セットまわりに限定し、結論が食い違わない形へ定義を寄せています。

# 一覧
scope :visible, -> { where("opened_on <= ? AND (closed_on IS NULL OR closed_on >= ?)", today, today) }

# 詳細
def ok?
  enabled? && Time.current.between?(from, to)
end

# 登録前
raise "受付期間外です" if record.to.present? && record.to < Date.current

2. 確定に効く判定をサーバ側へ寄せる

カートや購入画面の表示用判定は残します。
一方で、最低購入条件や利用上限のように注文の成立に効くものは、画面だけの判定に頼らず、サーバ側でも検証できる位置へ移しています。表示の便利さと、確定時の正を分けています。

// 画面(案内用)
if (subtotal < LIMIT) {
  lockButton();
}

# 受付処理(確定)
def accept
  ticket = build_ticket(params)
  ticket.persist!
end

3. 繰り返し変わる値の参照先を狭くする

 料金のように、事業側の改定が繰り返し入る値は、画面や処理の途中に直書きされたままだと抜けが起きます。
改修のたびに触る箇所を減らすため、参照先をそろえる改修を進めています。

<%# 表示 %>
<p>追加料金: 980円〜</p>

# 集計A
extra = 980
extra = 680 if amount >= 3000

# 集計B
extra = subscribed_member? ? 480 : 980

4. 羅列されていた処理を、段階の見える形へ分ける

こちらは長くなってしまうのでコードは割愛しますが、以前は1つのアクションの中に処理が長く並び、「どこからどこまでが何の処理をしているのか」を追いにくい箇所がありました。
いまは理想形へ一気に変更するのではなく、モジュール化しながらパイプラインのように視覚的にわかりやすい責務ごとに分け、呼び順が追える形へ寄せています。

対象はすでに稼働している処理がほとんどです。そのため、本番への影響がないと保証できるようにするために振る舞いを変えずに構造から整え、影響が広いものは段階を分けています。


AI開発が増えるほど、読みやすさの価値は上がるかもしれない?

このようなリファクタリングを行う中で最近強く感じていることがあります。

 AIを使った開発が進むと、人間が一度に把握しきれない量のコード変更が増えていきます。生成の速度は上がっても、本番に出す責任は残ります。変更の意図が追えないコードが増えると、レビューは「動いたか」だけを見る作業になりやすく、条件や事業ルールのずれを見落とします。

 そうなったとき、目で追いやすいコードの基盤を先に作っておくことやコードだけでは追えない業務ルールをコメントで残すことは、人間がレビューする前提を支えることができます。
 命名が安定している、責務が分かれている、正の置き場所が決まっている。こうした土台があるとAIが出した差分を人間が判断しやすくなります。

 既に人間の介在がなくても修正の必要がないクオリティのコードが生成できるようになってきています。とは言え企業としては手放しでAIを信じ切ってリリースすることは責任の観点から難しいと思います。
少なくとも今は人がレビューできる粒度にコードを寄せる重要性は高いと感じます。

リファクタリングはアプリケーションの運用現場から見れば変化がないですし、エンジニアの花形の業務ではないような気もしてしまいます。それでも次の改修や次のレビューをしやすくすることに繋がり、結果としてこれからの現場の使いやすさを促進できるものだと思いながら日々取り組んでおります。


おわりに

現在デザイン・システム室では、新しいメンバーを募集しています。少しでも興味を持たれた方は、ぜひご応募ください✨
皆様からのご応募、心よりお待ちしております。