saitoxu.io

AboutTwitterGitHub

RailsのセッションをRedisに保存する (2)

November 13, 2017

前回の記事では Rails のセッションを redis-store/redis-rails を使って Redis に保存するところまでを試しました。

Rails のセッションを Redis に保存する (1) | yosuke.saito

今回は Rails の認証ライブラリで有名な plataformatec/devise と組み合わせたときの挙動を確認してみます。

Rails のプロジェクトは前回作成したものを引き続き使用します。

Devise のインストール

まずは Devise をインストールします。Gemfile にgem 'devise'を書いてbundle installを実行します。 次に Devise の README に従いrails g devise:installを実行し、 config/environments/development.rbを次のように編集します。

Rails.application.configure do
  # ...

  # 以下を追記
  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
end

最後に Devise で認証するモデルを作成します。今回はUserモデルとします。

$ rails g devise User

これで Devise の準備が完了しました。

ログイン機能を足す

次に、これまで作成してきた Todo 管理アプリケーションに変更を加え、 ログインしなければタスク一覧などを確認できないようにします。

まずはルートとなる controller を作成し、

$ rails g controller home index

config/routes.rbにroot to: 'home#index'を追加します。

次に、ナビゲーションしやすいように以下のような部分テンプレートを作成し、

<!-- app/views/layouts/_navigation.html.erb -->
<ul class="nav navbar-nav">
  <li><%= link_to 'Home', root_path %></li>
  <% if current_user %>
    <li><%= link_to 'Task list', tasks_path %></li>
    <li><%= link_to 'Settings', edit_user_registration_path %></li>
    <li><%= link_to 'Log out', destroy_user_session_path, method: 'delete' %></li>
  <% else %>
    <li><%= link_to 'Login', new_user_session_path %></li>
    <li><%= link_to 'Register', new_user_registration_path %></li>
  <% end %>
</ul>

app/views/layouts/application.html.erbに追加します。

<!DOCTYPE html>
<html>

  <body>
    <!-- 以下を追記 -->
    <%= render 'layouts/navigation' %>
    <p class="notice"><%= notice %></p>
    <p class="alert"><%= alert %></p>

    <%= yield %>
  </body>
</html>

最後にapp/controllers/tasks_controller.rbに 1 行加えてタスクの CRUD にログインを要求するようにします。

class TasksController < ApplicationController
  # 以下を追記
  before_action :authenticate_user!

  # ...
end

さて、ここまでで見た目は微妙ですが、一応ログインが必要な Web アプリになりました。

挙動の確認

ではサーバを起動して、http://localhost:3000/users/sign_upからユーザ登録してみましょう。 デフォルトであればユーザ名とパスワードを入力するとそのままログインできるはずです。

ログインに成功したら Redis を確認してみましょう。 セッションが保存されているのを確認できます。

127.0.0.1:6379> keys *
1) "session:1a502b40f8166de679d543a9684d8b17"

試しにこのセッションを削除してみましょう。キーの削除はdelコマンドを使います。

127.0.0.1:6379> del session:1a502b40f8166de679d543a9684d8b17
(integer) 1

その後ログインが必要なページ、 たとえばhttp://localhost:3000/tasks/newなどを開こうとすると、 http://localhost:3000/users/sign_inにリダイレクトされると思います。

おわりに

以上、redis-store/redis-railsと plataformatec/deviseを組み合わせてみました。 特段引っかかるところもなく簡単に導入できましたね。

ただ、実環境では Redis の冗長化が必要となることが多いでしょう。 そこで次回は Redis の死活監視や自動フェイルオーバーを行ってくれる Redis Sentinel を使ってみます。

© 2021, Yosuke Saito