RailsでのAjax処理

2022年6月15日 22:20

Ajax on jQuery

jQueryでAjax処理を書くと以下のような感じになります。
<input type="textbox" id="sample" />

<script>
  $(function() {
    $('#sample').on('change', function() {
      $.ajax({
        type: 'POST',
        url: '/funds/set_category',
        data: { category: $(this).val,
        dataType: 'json'
      }).done(function(data, textStatus, jqXHR) {
        // 成功時の処理
      }).fail(function(jqXHR, textStatus, errorThrown) {
        // 失敗時の処理
      }).always(function() {
        // 結果にかかわらず実行される処理
      });
    });
  });
</script>
Ajax通信を開始する処理にメソッドチェーンで成功時の処理や失敗時の処理を付け足していきます。
成功時の処理や失敗時の処理を書いていくと、JavaScriptの部分がどんどん肥大化していくことになります。

Ajax on Rails

Railsでは以下のように書くことができます。
<%= text_field_tag 'sample', data: { remote: true,
                                     method: 'POST',
                                     url: set_sample_path } %>

<script>
  document.body.addEventListener('ajax:success', function(event) {
    // 成功時の処理
  });
  document.body.addEventListener('ajax:error', function(event) {
    // 失敗時の処理
  });
  document.body.addEventListener('ajax:complete', function(event) {
    // 結果にかかわらず実行される処理
  });
</script>
少しすっきりした気がします。
data-remoteをtrueに変更し、他のパラメーターもdata-***で指定します。
Rubyの処理内なのでurlの指定にはset_sample_pathがそのまま使えます。
また、コントローラーに渡すデータは、テキストボックスならvalue属性が、セレクトボックスならselected optionが自動的に設定されます。
その他のデータを渡したい場合、data { params: 'id=' + fund.id, type: 'json' }のような感じで設定すればOK。

ひとつ注意があります。
例ではページ内にAjax処理を行う場所がひとつだけなので、結果を受け取る処理もひとつだけで大丈夫です。
しかし、Ajax処理を行う場所が複数あると、処理の種類によって結果を受け取る処理を変えなければなりません。
具体的な方法については次のセクションで説明します。

Controller

def set_sample
  // データ更新などの処理
  result = {
    event: 'sample',
    data: samples
  }
  render json: result, status: 200
end
データとステータスコードを返却します。
このとき、データの中にどの処理かが識別できる情報を入れておきます。例ではevent: 'sample'の部分です。
また、ステータスコードを設定しないとビューでの受信時にデータの形がおかしくなるので必ず設定します。

Re:View

<script>
  document.body.addEventListener('ajax:success', function(event) {
    // 成功時の処理
    var data = event.detail[0];
    switch(data.event) {
      'sample':
        // 処理
        break;
      ...
    }
  });
  ...
</script>
再びビューの処理です。
コントローラー側から受信した返却データはevent.detail[0]の中に入っています。
さらに今回はJSON形式でeventというパラメーターを設定しているので、event.detail[0].eventで処理が識別できます。
しまった、eventとeventでeventがかぶってしまった。
ページ内に複数のAjax処理があるとswitchなどを使って受信処理を分岐させる必要があります。
しかし失敗時の処理は分岐させる必要がないなど、状況に応じて共通化させることもできます。

関連記事

【Rails】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12