【RailsAPI】例外処理 create! or createなのか ベストプラクティスを知りたいです。

Question

状況

Rails APIに処理が失敗しても成功しても、てフロント側(React)にjsonでエラーメッセージを送りたいときがあるとします。

現在Userモデルに対してcreateを行なっていますが、バリデーションがかかって上手く処理ができないとします。
save!とすると例外処理がレスポンスとして(バリデーションのメッセージ)かえってくるとは思いますが、saveとすると "失敗しました"とフロント側に送られます。

どう使い分けるべきなのでしょうか？

そもそもif文での分岐と例外処理を出す時の違いはいまいち調べても分かりません。。。

宜しくお願い致します。

def create

def create

if User.create
  render status: 200 , json: {message : "成功しました。"}
else
  render status: 400 , json:{ message : "失敗しました。"}
end

end

def create

begin
  User.create!
  render status: 200 , json: {message : "成功しました。"}
else
  render status: 400, json: { message : "失敗しました。"}
end

end

Answer 1

一般的なサービスにおいて1つのテーブルだけを更新するといった事は少なくて、
だいたい複数のテーブルをまとめて更新するようなケースが多いです。
そのためには、トランザクションを用いて成功(commit)か失敗(rollback)の状態にする必要があります。
例えば、A、B、Cのテーブル3つを同時に更新する必要があったとして、
何らかの不備(パラメータの間違いなど)があった時、基本的にA,B,Cに対して一切の変更がされてはいけません。
なので、rollbackするべきです。

こういう時は

ActiveRecord::Base.transaction do 
  A.create!(...)
  B.create!(...)
  C.create!(...)  
end

という感じで、トランザクションのブロックで囲み、
失敗したら例外を発生させる＝rollbackが実行されるという状態にする必要があります。
なので、基本的にcreate!、update!、save!など失敗したら例外が発生するメソッドを使うべきです。
逆に、create, update, saveの出番はありません。
通常のケースでも常にcreate!、update!、save!で良いくらいです。

さて、基本的にReactとRailsでアプリを作る場合、Rails＝コントローラ側はjsonを返すだけになります。

class XxxxController

  def sample
    begin
      ActiveRecord::Base.transaction do
        更新処理
      end      
 
      # 成功時に返すべきレスポンスを設定
      result =  {
      }

    
      # jsonを返す。HTTPステータスコードは成功を示す200になる(statusオプション省略時)
      render json: result
    rescue Excetption => e
      # エラーを示すレスポンス
      result = {
        error: {
          message: e.message
        }
      }

      # HTTPステータスコードは実際にはある程度使い分ける必要がある気がするが、
      # 成功時200とエラー時(200以外)でReact側で判定すれば良いと思う
      
      render json: result, stauts: 500
    end 
  end

end

要点は、データベースへの変更はトランザクションを使う。
ロールバックをするには必ずビックリマーク付きのメソッドを使う(create!, update!, save!)です。

Comments

[rzz]

本当にご丁寧なご回答ありがとうございます。トランザクションとは知らない概念で大変勉強になりました。大事な事を知れて嬉しかったです。
既存の現在開発しているコードを全て見直すことになりました。
3点ほど気になることがございまして、
コードブロックで書きたかったので別ページで載せてみました。
以下になります。

https://teratail.com/questions/342651

宜しくお願い致します。