Udemy 13. フロントエンドのログイン認証 #02
2020年11月03日に公開

【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する

今回達成すること

今回は、Railsから返されるログイン成功時のレスポンスを、フロントに保存する実装を行います。

nuxt auth2

レスポンスJSONの保存先

Railsから返されるレスポンスJSONの保存先は、

  • user => Vuexに、
  • exp(有効期限) => ローカルストレージに

保存します。

認証クラスの作成

認証関連を一手に請け負うAuthenticationクラスを新たに作成し、その中で今回の実装を行います。

認証を扱うプラグインを作成する

まずは、Nuxt.jsの「plugins」ディレクトリにauth.jsを作成しましょう。

root $ touch front/plugins/auth.js

作成したプラグインの読み込み設定を、nuxt.config.jsに追加します。

最初に処理を行うため、plugins一番上に追加してください。

front/nuxt.config.js
export default {
  ...
  plugins: [
    // 1番上に追加
    'plugins/auth',
    'plugins/axios',
    'plugins/myInject'
  ],
  ...
}

Authenticationクラスを作成する

作成したauth.jsに、Authenticationクラスを宣言します。

このクラスは、

  • 有効期限の保存
  • ログインフラグ
  • ログイン業務
  • ログアウト業務

の認証関連業務を一手に請け負います。

front/plugins/auth.js
class Authentication {
  constructor (ctx) {
    this.store = ctx.store
    this.$axios = ctx.$axios
  }
}

export default ({ store, $axios }, inject) => {
  inject('auth', new Authentication({ store, $axios }))
}
  • inject(<呼び出し名>, クラスの初期化)injectすることにより、クラス内のメソッドをthis.$auth で呼び出すことができます。

  • { store, $axios } … Nuxt.jsのcontextを取得し、constructor内で代入しています。

    これにより、クラス内でVuex$axiosが扱えるようになります。

ストレージに有効期限を保存するメソッド

Railsから返ってきた有効期限をローカルストレージに保存する、setStorageを追加します。

front/plugins/auth.js
// 追加
const storage = window.localStorage
const keys = { exp: 'exp' }

class Authentication {
  constructor (ctx) {
		...
  }

  // 追加
  // storageに保存
  setStorage (exp) {
    storage.setItem(keys.exp, exp * 1000)
  }
}
...
  • setItem(<キー>, 値) … ローカルストレージに保存する。

    キーには'exp'が入ります。

    値には、有効期限を1000ミリ秒に変換して保存しています。

    これは、JavaScriptのgetTime()が1000ミリ秒を返すためです。

ストレージを削除するメソッド

ローカルストレージを削除するremoveStorageを追加します。

front/plugins/auth.js
...
class Authentication {
  ...
  setStorage (exp) {
    storage.setItem(keys.exp, exp * 1000)
  }

  // 追加
  // storageを削除
  removeStorage () {
    for (const key of Object.values(keys)) {
      storage.removeItem(key)
    }
  }
}
...
  • removeItem(<キー>) … 引数のキーと一致するローカルストレージの値を削除する。

有効期限を取得する

ローカルストレージから有効期限を取得するgetExpireを作成します。

front/plugins/auth.js
...
class Authentication {
  ...
  removeStorage () {
    for (const key of Object.values(keys)) {
      storage.removeItem(key)
    }
  }

  // 追加
  // storageの有効期限を複合して返す
  getExpire () {
    return storage.getItem(keys.exp)
  }
}

有効期限内であるかを判定するメソッド

現時刻と有効期限を比較して、

  • 期限内である場合true
  • 期限外の場合falseを返す

isAuthenticatedを追加します。

front/plugins/auth.js
...
class Authentication {
  ...
  removeStorage () {
    for (const key of Object.values(keys)) {
      storage.removeItem(key)
    }
  }

  // 追加
  // 有効期限内の場合はtrueを返す
  isAuthenticated () {
    return new Date().getTime() < this.getExpire()
  }
}
...

ログイン業務を行うメソッド

ログイン時は、

  • 有効期限をローカルストレージに保存し
  • ユーザーをVuexに保存します。
front/plugins/auth.js
...
class Authentication {
  ...
  isAuthenticated () {
    return new Date().getTime() < storage.getItem(keys.exp)
  }

  // 追加
  // ログイン業務
  login ({ exp, user }) {
    this.setStorage(exp)
    this.store.dispatch('getCurrentUser', user)
  }
}
...

ログアウト業務を行うメソッド

ログアウト時は、

  • アクセストークンの削除
  • ローカルストレージを削除
  • Vuexのユーザーをnullにします。
front/plugins/auth.js
...
class Authentication {
  ...
  login ({ exp, user }) {
		...
  }

  // 追加
  // ログアウト業務
  logout () {
    this.$axios.$delete('/api/v1/user_token')
    this.removeStorage()
    this.store.dispatch('getCurrentUser', null)
  }
}
...

Vuexにユーザーを保存する

Railsから返ってきたユーザーをVuexに保存する実装を行います。

index.js

  1. ストア
  2. アクション
  3. ミューテーション

を追加します。

front/store/index.js
export const state = () => ({
  ...
  current: {
    // user追加
    user: null,
    project: null
  },
  ...
})

export const getters = {}

export const mutations = {
  ...
  setCurrentProject (state, payload) {
    state.current.project = payload
  },
  // 追加
  setCurrentUser (state, payload) {
    state.current.user = payload
  }
}

export const actions = {
  ...
  getCurrentProject ({ state, commit }, params) {
    ...
  },
  // 追加
  // 現在のユーザーを設定する
  getCurrentUser ({ commit }, user) {
    commit('setCurrentUser', user)
  }
}

ログインメソッドを追加する

ここまでに、

  • 有効期限をローカルストレージに保存、
  • ユーザーをVuexに保存
  • それらを実行するloginメソッド

を作成しました。

このloginメソッドをlogin.vueに追加します。

確認の為、Vuexのユーザーをコンソールで出力してみましょう。

front/pages/login.vue
...
export default {
  ...
  methods: {
    async login () {
      ...
    },
    // ログイン成功
    // async 追記
    async authSuccessful (response) {
      // 変更
      await this.$auth.login(response)
      console.log(this.$store.state.current.user)
      // 削除
      // console.log(response)
    },
    ...
  }
}

ログインを実行する

コンテナを起動して、http://localhost:8080/login にアクセスしましょう。

メールとパスワードを打ち込んで、ログインしてください。

コンソールを確認する

Vuex内のユーザーが保存されているか確認します。

2020-10-05 06-57-45

ローカルストレージを確認する

ローカルストレージに有効期限が保存されているか確認します。

「Application」タブ => 「Storage」=>「Local Storage」を見てください。

Keyに「exp」、Valueに「1000ミリ秒に変換した有効期限」が保存されていれば成功です。

2020-10-05 07-01-55

コンソールを削除する

login.vueに追加した、確認のためのコンソールは削除します。

front/pages/login.vue
...
<script>
export default {
  ...
    // ログイン成功
    async authSuccessful (response) {
      await this.$auth.login(response)
      // console.log(this.$store.state.current.user) 削除
    },
    ...
  }
}
</script>

ローカルストレージを削除する

ローカルストレージのexpにカーソルを合わせ「deleteキー」で値を削除してください。

コミットする

今回の作業は以上です。

「front」ディレクトリ内でコミットしておきましょう。

root $ cd front
front $ git add -A && git commit -m "add_plugins_auth.js" && cd ..
root $

まとめと予告

今回は、Nuxt.jsにログイン成功後に返ってくるレスポンスを保存する実装を行いました。

これでNuxt.js側でログインユーザーが扱えるようになりましたね。

ただ、ローカルストレージに保存した有効期限は、誰でも簡単に改ざんできる状態です。

そこで、次回はこの有効期限を暗号化処理を行います。

それでは!

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
アプリケーション仕様書
1. このカテゴリーの歩き方 #03
このカテゴリーの歩き方(まずはここをチェック)
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
13. フロントエンドのログイン認証 #01
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
13. フロントエンドのログイン認証 #02
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
13. フロントエンドのログイン認証 #03
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
13. フロントエンドのログイン認証 #04
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
13. フロントエンドのログイン認証 #05
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
13. フロントエンドのログイン認証 #06
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
13. フロントエンドのログイン認証 #07
【Nuxt.js】エラーページを作成する
13. フロントエンドのログイン認証 #08
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
14. 本番環境への対応 #01
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する
SPA開発
ブログ構築
小ネタ集