【Rails5】スクロールでページネーションを行う方法

2019年5月18日

YoutubeやGoogleのように、スクロールしたらどんどんコンテンツが出てくるような動作をこの記事ではご紹介します。前もって書いておきますと、この記事ではInifinite Scroll Javascript は使いません。そもそも私自身が個人的なプロジェクトでYoutubeのようなInfinite Scrollingを実装しよう思い、色々な記事を読み漁ったのですが、ほとんどの記事がKaminari + Inifinite Scroll Javascriptの組み合わせでした。Inifinite Scroll Javascriptは商用利用ですとお金が掛かる上に残念ながら私が求めるような動作では無かったため結局自前で実装しなければならず、その忘備録としてこの記事を書いています。分かりづらい所も多々あるとは思いますが、一つご参考になれば幸いです。

1.準備する

1-1. Gemのインストール

Railsを使ったアプリケーションでページネーションを行う際によく使われるgem Kaminariを使います。

  1. Kaminari

GemfileにKaminariを追加し

コンソールからgemをインストールします。

1-2. Seedデータの用意

ページネーションを行うには何かしらのデータが必要になってきますので、適当にPost Modelを作り、レコードを大量生産します。

1-3.Viewの用意

一から作るのも面倒だったのでBootstrap4の「Dashboard 」サンプルから一部拝借してます。

先ほどscaffoldで生成されたPostsControllerに「dashboard」というactionを追加し、Post.allで大量生産したPostレコードを呼び出します。

consoleからrails sをした後にlocalhost:3000/dashboardにアクセスして見ます。

先ほど作ったデータがずらっと並んでいると思います。

2.ページネーション

準備は整ったので、ここからページネーションを加えて行きます。PostsControllerに以下を加えます。

.pageを付け加えることによって、Kaminariが小分けにしてレコードを呼び出してくれるようになります(デフォルトだと25)。

もう一度localhost:3000/dashboardにアクセスして見ましょう。

25番目のレコードまで呼び出されていますね。

それでは一旦dashboard.html.erbの該当部分に以下を加えて見ましょう

もう一度localhost:3000/dashboardにアクセスして見ると、ページネーションのリンクが表示されていると思います。

先ほどrakeしたデータの個数は全部で100個なので、100 / 25の4ページに分割されています。2ページ目のリンクをクリックして見てください。タイトル25からタイトル49が表示されるようになるはずです。更に、URLにも注目して見ましょう。

http://localhost:3000/dashboard?page=2

URLの末尾に「?page=2」と表示されています。ここのパラメーター部分は後ほど使いますので覚えておきましょう。

3.Infinite Scrolling

3-1.目的の言語化

さて、ここからが本番です。YoutubeやGoogleみたいにスクロールした際にどんどんコンテンツを出すようにするには上記でやったページネーションの表現方法を変えているだけに過ぎません。やっていることは同じです。やりたい事を言語化すると、要は

ページネーションリンクをクリックする代わりにリストの一番最後までスクロールしたら次の25件を取得し、リストに加える

ということになります。

やりたいことは分かったので、更に細かく考えて行きましょう。「最後までスクロールしたら」ということはクライアントのスクロールを感知し、それがリストの最後まで行ったかの判定を行わないといけません。そして最後までスクロールした際に「次の25件を取得」するにはcontrollerを呼び出す必要があります。次の25件を取得した後にはそれを「リストに加える」必要があるので、今のリストに新しい25件を加える処理をしないといけません。

上記をまとめると、3つのアクションに分けられると思います。

  1. リストのスクロール判定
  2. クライアント側からcontrollerに通信を行い、次の25件を取得
  3. 取得した次の25件をリストに加える

3-2. ①リストのスクロール判定

これはjavascriptでスクロールされる度に呼び出される便利なon scroll functionがあるのでそれを使います。私はcoffeescriptを書く事を断念した人間なのでassets/javascriptsのposts.coffeeをposts.jsに変更し、以下を追加します。

読み砕いて行きましょう。

はそのまま、リストがスクロールする度に呼び出される関数です。

次のif分岐を見て行きましょう。

このif分岐に含まれる4つの要素を説明します:

  1. $(‘#infiniteScrollingContainer’).scrollTop() //要素のスクロール位置を返します
  2. $(‘#infiniteScrollingContainer’).height() //画面上に表示されている要素の高さを返します
  3. $(‘#infiniteScrollingContainer’)[0].scrollHeight //画面上に表示されていない、溢れた(overflow)要素を含めた高さを返します
  4. 16 //これはリストのpadding-topの高さです

上記を踏まえた上でもう一度if分岐の内容に当てはめて行きましょう。

$(‘#infiniteScrollingContainer’)要素のスクロール位置

+

$(‘#infiniteScrollingContainer’)要素の表示されている高さ(これは固定です)

上二つの値が

$(‘#infiniteScrollingContainer’)要素の画面上に表示されていない、スクローリング領域を含めた高さ

16 ( $(‘#infiniteScrollingContainer’)要素のpadding-topの高さ)

と同等の場合、alertが出るになっています。

3-3. ②クライアント側からcontrollerに通信を行い、次の25件を取得

最後までスクロールしたかどうかの判定処理は整いましたので、次はクライアントからcontrollerに通信を行い、次の25件のレコードを取得しないといけません。これを非同期的に行いたいので ajax関数を使います。

if分岐の中に以下を追加してください。

細かく見て行きましょう。

は500ミリ秒(0.5秒)後に中の関数を呼び出しています。

は、非同期的に指定したurlにpostやgetリクエストを行うことができます(デフォルトはgetです)。まずは infiniteScrolling actionをPostsControllerに作り、ルーティングを設定しましょう。

PostsControllerの infiniteScrolling actionで何をしているのかを見て行きましょう。まず、params[:page]でリクエストと一緒に送られてきているパラメータを取得しています。先ほどajax関数で明示的に指定したURLを例にした場合、

“/infiniteScrolling?page=2”

params[:page]は 「2」になります。

つまり、

@posts = Post.all.page(2)ということになりますので、Postモデルの全てのレコードの2ページ目(次の25件)を取得していることになります。

3-4. ③取得した次の25件をリストに加える

さて、次の25件を取得出来たので、次はそれをリストに加える必要があります。Railsのcontrollerは基本的に指定しない限りはactionと同名のview fileを探そうとします(この場合は /views/posts/infiniteScrolling.html.erbを探します)。しかしリストの最後までスクロールする度にページ全体が更新されるのは少しユーザビリティに欠けるかもしれません。動的に変化するのはリストの部分のみで、リストの最後に次の25件が付け加えられていく形で実装して行きます。

具体的な方法としてはJavascriptとパーシャル(部分テンプレート)の合わせ技で実現します。

RailsではView テンプレートの一部分のみを切り出して使いまわしたい時によく使用されるパーシャル (部分テンプレート)という便利な仕組みが存在します。

リストのフォーマットは統一されているので、

  1. リストのパーシャル(部分テンプレート)を作成する
  2. Javascriptを使い、パーシャル(部分テンプレート)をリストの最後に付け加える

これだけです。

 

①リストのパーシャル(部分テンプレート)を作成する

②Javascriptを使い、パーシャル(部分テンプレート)をリストの最後に付け加える

Railsのcontrollerでは出力するフォーマットを指定する事ができます。
infiniteScrolling actionの最後の3行を見て行きましょう。

ここでは明示的に、javascriptのファイルを探すように指定しています。(renderのオプションを使えばファイル名での指定も可能です。)この形式の指定によってcontrollerはinifiteScrolling.html.erbの代わりにinfiniteScrolling.js.erbを優先的に探すようになります。それではinifiniteScrolling.js.erbの中身を分解しながら見ていきましょう。

ここではappend メソッドを使って、リストの要素にコンテンツを追加しています。

追加するコンテンツは先ほど作成したリストのパーシャル(部分テンプレート)です。ここで一度テストしましょう。

リストの最後までスクロールするとPostモデルの全てのレコードの2ページ目(次の25件)を取得していることが分かります。ただこのままですとposts.jsのajax関数で明示的に「page=2」と直書きしているため、常に2ページ目を取得し続けます。ですので、pageパラメータを変数化する必要があります。

3-5. 取得するページの変数化

まず、ajax関数でinfiniteScrolling actionを呼び出す時に最後のページであるかどうかの判定を行い、最後のページでは無い場合はpageパラメータに +1 し、最後のページだった場合はこれ以上取得しないように、「”last”」を代入します。

一つずつ見ていきましょう。

dashboard.html.erbでは「data-page=2」を付け足しました。data 属性を使い、次に何ページ目を取得するかを管理します。

posts.jsでは最後までスクロールした際に、付け足したdata属性を取得し動的にajax関数のURLを変えています。

infiniteScrolling actionではPostモデルの全ページ数がpageパラメータより少ない場合は@nextPage変数に「”last”」を代入し、そうで無い場合はpageパラメータに +1をして@nextPage変数にそれを代入します。

inifiniteScrolling.js.erbでは@nextPage変数が「”last”」じゃ無い場合はリストのパーシャル(部分テンプレート)をリストに追加し、@nextPage変数が「”last”」の場合は何もしません。そして最後に@nextPage変数をリスト要素のdata属性に代入します。

実際の動作を見て見ましょう。

ちゃんと100件目のレコードまでスクロールされますね。

おまけ:ローディングの表示など

現状だと最後のページまでスクロールした後でも、もう次のページが無いことを分かっているのに毎度ajax関数でinfiniteScrolling actionにリクエストを送ります。無駄なので最後のページの場合はinifiniteScrolling actionへのリクエストを止めましょう。

もし data-pageが”last”の場合はreturnします。

 

さらに、現状だとスクロールした後に次の25件を取得しているかどうかが分かりづらいです。ローディングの表示があったほうがユーザビリティが少し向上するかもしれません。

ローディングの表示は@lukehaasさんのcss-loaders プロジェクトの中からお借りします(MITライセンスです)。

以下が実際の動作です。

おまけ:その②

スクロールした際に、ajax関数が2回呼び出されることがあった場合は以下を追加してください。

ajaxStopperという変数を作り、ajax関数の2回目の呼び出しを防いでいます。

以上、YoutubeやGoogleのようにスクロールしたらどんどんコンテンツが出てくるInfinite Scrollingのご紹介でした。

コードまとめ

最終コードは以下になります。