Zenn
🍎

【Rails】deviseの導入

2023/07/20に公開
Rails
gem
#
devise
#
ログイン機能
#
認証機能
tech

はじめに

ログイン機能を実装する際に使用する便利なdevise！
何度かアプリケーションを作成する中でエラーが出たり、導入の手順がわからなくなったり…困りごとが多かったので、使いこなせるようになるためにまとめてみました。

  • deviseとは・・・webアプリケーションに簡単に認証機能を実装できるgem。
  • gemとは・・・必要な機能が収められているため、一からコードを記述しなくとも効率よく開発を進めることができるもの。インストールして使う。
  • 認証機能とは・・・IDやパスワード等でユーザーを確認する機能。操作しているユーザーを特定したり、操作できるユーザーを制限する機能。

1.deviseをインストールする

1.Gemfileの最後の行に下記を追記する

Gemfile
gem 'devise'

2.gemをインストールする

ターミナル
$ bundle install
インストールが完了するまで少し待つ。

3.deviseをインストールする

ターミナル
$ rails g devise:install

🌸インストール完了！

2.モデルを作成

ターミナル
※今回はモデル名を「User」で作成する
$ rails g devise User
モデル名は単数形＋一文字目は大文字

以下のように出力されればOK！

ターミナル
Running via Spring preloader in process 7856
      invoke  active_record
      create    db/migrate/20230720112240_devise_create_users.rb
      create    app/models/user.rb
      invoke    test_unit
      create      test/models/user_test.rb
      create      test/fixtures/users.yml
      insert    app/models/user.rb
       route  devise_for :users
  • 作成したUserモデルを確認！
    以下のように「devise」で利用する機能が自動的に記述される👌
app/models/user.rb
class User < ApplicationRecord
  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
  devise :database_authenticatable, :registerable,
         :recoverable, :rememberable, :validatable
end
  • モデル作成時にマイグレーションファイルも作成されているので確認！
db/migrate/XXXXXXXXXXXXXX_devise_create_users(XXの部分は作成年月日時分秒)
# frozen_string_literal: true

class DeviseCreateUsers < ActiveRecord::Migration[6.1]
  def change
    create_table :users do |t|
      ## Database authenticatable
      t.string :email,              null: false, default: ""
      t.string :encrypted_password, null: false, default: ""

      ## Recoverable
      t.string   :reset_password_token
      t.datetime :reset_password_sent_at

      ## Rememberable
      t.datetime :remember_created_at

      ## Trackable
      # t.integer  :sign_in_count, default: 0, null: false
      # t.datetime :current_sign_in_at
      # t.datetime :last_sign_in_at
      # t.string   :current_sign_in_ip
      # t.string   :last_sign_in_ip

      ## Confirmable
      # t.string   :confirmation_token
      # t.datetime :confirmed_at
      # t.datetime :confirmation_sent_at
      # t.string   :unconfirmed_email # Only if using reconfirmable

      ## Lockable
      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
      # t.string   :unlock_token # Only if unlock strategy is :email or :both
      # t.datetime :locked_at


      t.timestamps null: false
    end

    add_index :users, :email,                unique: true
    add_index :users, :reset_password_token, unique: true
    # add_index :users, :confirmation_token,   unique: true
    # add_index :users, :unlock_token,         unique: true
  end
end
  • ログイン時にユーザー名を使用したいため、マイグレーションファイルに追記
db/migrate/XXXXXXXXXXXXXX_devise_create_users
class DeviseCreateUsers < ActiveRecord::Migration[6.1]
  def change
    create_table :users do |t|
      ## Database authenticatable
      t.string :email,              null: false, default: ""
      t.string :encrypted_password, null: false, default: ""

      ##名前を保存するためのカラム
      t.string :name　　　←こちらを追記！！
  • データベースへマイグレーション
ターミナル
$ rails db:migrate
  • 以下のように出力されればOK！
ターミナル
Running via Spring preloader in process 14257
== 20230720112240 DeviseCreateUsers: migrating ================================
-- create_table(:users)
   -> 0.0061s
-- add_index(:users, :email, {:unique=>true})
   -> 0.0014s
-- add_index(:users, :reset_password_token, {:unique=>true})
   -> 0.0011s
== 20230720112240 DeviseCreateUsers: migrated (0.0109s) =======================

3.サインアップ、ログイン後の遷移先としてTOPページ作成

サインアップ後はデフォルトで「/(ルート)」ページへ遷移するため、
TOPページを作成し、遷移先に設定する。

ターミナル
$ rails g controller homes top
config/routes.rb
Rails.application.routes.draw do
  devise_for :users
  root to: 'homes#top'　　←homesコントローラー#topアクションを探しに行く
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
end
  • 「devise_for :users」は、deviseを使用するURLに「users」を含むという記述。
ターミナル
$ rails routes
ルーティングにusersが含まれていることが確認できる◎

4.ページを表示

ここまででサインアップページやログインページが表示できるようになっているので、確認！

ターミナル
サーバーを起動
$ rails s
  • URLの末尾に /users/sign_up と入力　→　サインアップページ
  • URLの末尾に /users/sign_in と入力　→　ログインページ

※試しにサインアップしちゃった場合、この時点ではまだログアウトを実装していないのでサインアップページ、ログインページが確認できないかも・・(実際に自分がやって焦りました😇)
そんなときは　$ rails db:reset　でデータをリセットできます！
コマンドを実行したあとに再度ページを表示してみてください。

devise導入編は以上！

続きます🙋

Discussion