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

【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する

今回達成すること

今回は、ログインに失敗した際に出力するトースターをVuetifyを使って実装します。

また、今回実装するトースターは、Vuex経由でどこからでも呼び出し可能なグローバルイベントとなります。

完成イメージ

2020-10-11 22-00-16

トースターコンポーネントを作成する

トースターは、「components/ui」ディレクトリ内で管理します。

まずは、コンポーネントファイルを作成します。

root $ touch front/components/ui/toaster.vue

Vuetifyのsnackbarを使用する

トースターには、Vuetifyのv-snackbar(スナックバー)を使用します。

まずは表示させましょう。

front/components/ui/toaster.vue
<template>
  <v-snackbar
    v-model="snackbar"
    top
    text
  >
    トースター
    <template v-slot:action="{ attrs }">
      <v-btn
        v-bind="attrs"
      >
        Close
      </v-btn>
    </template>
  </v-snackbar>
</template>

<script>
export default {
  data () {
    return {
      snackbar: true
    }
  }
}
</script>

参考: Snackbar component — Vuetify

ログインページに表示する

作成したトースターはログインページで使用します。

login.vueの先頭にコンポーネントを差し込みます。

Nuxt.js v2.12以下の場合は、import文でコンポーネントをインポートしてください。

front/pages/login.vue
<template>
  <bef-login-form-card #form-card-content>
    <!-- 追加 -->
    <!-- toaster -->
    <toaster />
    ...
</template>
...

トースターを確認しよう

コンテナを起動して、http://localhost:8080/login にアクセスすると、ブサイクなトースターが表示されます。

2020-10-11 11-50-47

このトースターは、timeoutプロパティを指定していないので、デフォルトの5000ミリ秒が適用されています。5秒後にはうっすら消えていきます。

グローバルイベントのトースターを作成する

トースターはどの場面でも使用します。

そこで状態管理にVuexを使用し、どこからでも呼び出せるトースターを作成します。

親子関係にないコンポーネント間通信でよく使用されていた、イベントバスはVue3で削除されました。

Nuxt.jsでも非推奨になると思うので、Vuexを使ったグローバルイベントを作成します。

Vue 3.x アップデート
インスタンスからon、off、$onceメソッドを完全に削除しました。

引用: Vue.js

トースター表示のロジック

トースターは常に表示するコンポーネントではなく、何かしらのメッセージがあったときに表示されます。

今回の場合は、ログインが失敗した時の「ユーザーが見つかりません」ですね。

ここから考えると、

  • Vuexに空のメッセージを用意し、
  • その値が存在する場合に、トースターを表示する。
  • そして、一定時間が経過すればメッセージを削除します。

nuxt toaster

Vuexにトースターの値を用意する

トースターのカスタマイズできる値は、

  • メッセージ
  • カラー
  • 表示時間

とします。それぞれの値をindex.jsに用意しましょう。

front/store/index.js
export const state = () => ({
  ...
  rememberRoute: {
    name: 'index',
    params: {}
  },
  // 追加
  toast: {
    msg: null,
    color: 'error',
    timeout: 4000
  }
})
  • color: 'error' … トースタには、エラーメッセージを表示することが多いので、デフォルトカラーをerror(赤)としています。

  • timeout: 4000 … Vuetifyのsnackbarのタイムアウトは1000ミリ秒で指定します。

    4000 ~ 10000の値が推奨されています。

    表示したままにする場合は-1を指定します。

    参考: Snackbar API - Vuetify

Vuexにアクションを追加する

toastオブジェクトの値を変更するアクションとミューテーションを追加します。

front/store/index.js
...
export const mutations = {
  ...
  setRememberRoute (state, payload) {
    state.rememberRoute = payload
  },
  // 追加
  setToast (state, payload) {
    state.toast = payload
  }
}

export const actions = {
  ...
  getRememberRoute ({ commit }, route) {
		...
  },
  // 追加
  // トーストデータをセットする
  getToast ({ commit }, toast) {
    toast.color = toast.color || 'error'
    toast.timeout = toast.timeout || 4000
    commit('setToast', toast)
  }
}

これでVuexの準備が整いました。

メッセージがあればトースターを出力する

コンポーネントの編集に移ります。

toaster.vueに、「Vuex内のメッセージが存在するときにトースターを出力する」編集を行います。

front/components/ui/toaster.vue
<template>
  <!-- v-model="setSnackbar" へ書き換え -->
  <v-snackbar
    v-model="setSnackbar"
    top
    text
  >
    トースター
    <template v-slot:action="{ attrs }">
      <v-btn
        v-bind="attrs"
      >
        Close
      </v-btn>
    </template>
  </v-snackbar>
</template>

<script>
export default {
  // 削除
  // data () {
  //   return {
  //     snackbar: true
  //   }
  // },
  // 以下、追加
  computed: {
    toast () {
      return this.$store.state.toast
    },
    setSnackbar: {
      get () {
        return !!this.toast.msg
      },
      set (val) {
        return val
      }
    }
  }
}
</script>
  • toast () … Vuexのステートの値をthis.toastで扱えるようにしています。

  • setSnackbar: {}v-modelの値として指定しています。

setSnackbarは、Vuexのメッセージを常に参照しており、

  1. msgに値が代入された時にtrueを返します。
  2. ゲッター内でtrueが返れば、v-model=trueとなり、<v-snackbar>が表示されます。
  3. timeoutに設定した時間が経過すると、<v-snackbar>falseを返します。
  4. falseはセッターの引数valに入っており、その値をv-modelに渡します。
  5. v-model=falseとなった時、<v-snackbar>は非表示となります。

メッセージと値を追加する

toaster.vueに、Vuexのメッセージ、カラー、タイムアウトを追加します。

front/components/ui/toaster.vue
<template>
  <!-- timeout、color追加 -->
  <v-snackbar
    v-model="setSnackbar"
    top
    text
    :timeout="toast.timeout"
    :color="toast.color"
  >
    <!-- 追加 -->
    {{ toast.msg }}
    <!-- トースター 削除 -->
    <template v-slot:action="{ attrs }">
      <v-btn
        v-bind="attrs"
      >
        Close
      </v-btn>
    </template>
  </v-snackbar>
</template>
...

トースターを呼び出してみる

login.vueのログインの失敗時に呼び出されるauthFailure()から、トースターを呼び出します。

front/pages/login.vue
<script>
export default {
  ...
  methods: {
    ...
    // ログイン失敗
    authFailure ({ response }) {
      // 追加
      if (response.status === 404) {
        this.$store.dispatch('getToast', { msg: 'ユーザーが見つかりません😷' })
      }
      // 削除
      // console.log(response)
    }
  }
}
</script>

トースターの状態を確認するために、login.vueのトップにテストコードを追加します。

front/pages/login.vue
<template>
  <bef-login-form-card #form-card-content>
    <!-- 追加 -->
    {{ $store.state.toast }}
    <!-- toaster -->
    <toaster />
    ...
</template>
...

存在しない適用なユーザーでログインしてみましょう。

トースターが出力され、Vuexのtoastにはメッセージが入りました。

2020-10-11 18-02-46

現状の問題点

トースターが出力された後、2度目のクリック時にトースターが表示されません。

これは、メッセージが変化していないため、toaster.vueの算出プロパティが再計算処理を行わないことが原因です。

算出プロパティとは

算出プロパティとは、computed内に作成される関数のことで、依存関係にある値の変更が検知されたときに再評価した値を返します。

つまり、メッセージが変わらない限りは、関数を再び実行する事はなく、以前計算された結果を即時に返します。

参考: 算出プロパティとウォッチャ - Vue.js

解決策

この解決には、トースターが消えると同時に、メッセージを初期値のnullに戻す必要があります。

トースターは、消えるタイミングでセッターのset()を通過します。

そのセッター内でメッセージをnullにするメソッドを呼び出せばOKです。

front/components/ui/toaster.vue
...
<script>
export default {
  computed: {
    ...
    setSnackbar: {
      get () {
        return !!this.toast.msg
      },
      set (val) {
        // 追加
        // timeout: -1の場合は通過しない
        this.resetToast()
        return val
      }
    }
  },
  // 追加
  methods: {
    resetToast () {
      return this.$store.dispatch('getToast', { msg: null })
    }
  }
}
</script>

これで何度クリックしてもトースターが出力されるようになりました。

閉じるボタンを完成させる

トースターの閉じるボタンを完成させます。

@clickイベントでresetToast()メソッドを呼び出せばOKです。

front/components/ui/toaster.vue
<template>
  ...
    <template v-slot:action="{ attrs }">
      <!-- 追加 -->
      <v-btn
        v-bind="attrs"
        text
        :color="toast.color"
        @click="resetToast"
      >
        Close
      </v-btn>
      <!-- 削除 -->
      <!-- <v-btn
        v-bind="attrs"
      >
        Close
      </v-btn> -->
    </template>
  </v-snackbar>
</template>
...

無期限トースターに対応する

メール認証を促すような重要なトースターは、ユーザーが閉じるボタンをクリックするまで表示した方が親切です。

トースターの表示時間timeout-1を渡し、消えないトースターを表示してみましょう。

front/pages/login.vue
...
<script>
export default {
  ...
    // ログイン失敗
    authFailure ({ response }) {
      if (response.status === 404) {
        // timeout: -1を追加
        this.$store.dispatch('getToast', { msg: 'ユーザーが見つかりません😷', timeout: -1 })
      }
    }
  }
}
</script>

このトースターは、閉じるボタンを押さない限り消えるません。

そのままページ遷移して、また戻るとどうでしょうか。あ、まだ表示されていました。

2020-10-11 20-38-43

ページ遷移直前にトースターを削除する

この、ページ遷移後にも表示されたままのトースターを削除するには、beforeDestroy()内でトースターの値をリセットします。

beforeDestroy()は、そのページのVueインスタンス(ページ内にあるデータや関数)が破棄される直前に呼び出されます。

「ページの後処理を行う場所」としてよく使われます。

toaster.vuebeforeDestroy()を追加しましょう。

front/components/ui/toaster.vue
...
<script>
export default {
  computed: {
    ...
  },
  // 追加
  beforeDestroy () {
    // ページ遷移前に削除する(-1に対応)
    this.resetToast()
  },
  methods: {
    resetToast () {
      return this.$store.dispatch('getToast', { msg: null })
    }
  }
}
</script>

これでページ遷移後にはトースターが削除されるようになりました。

テストコードを削除する

これで実装は完了です。

toaster.vueに追加した、

  • {{ $store.state.toast }}
  • timeout: -1

削除します。

front/pages/login.vue
<template>
  <bef-login-form-card #form-card-content>
    <!-- {{ $store.state.toast }} 削除 -->
    ...
</template>

<script>
export default {
    ...
    // ログイン失敗
    authFailure ({ response }) {
      if (response.status === 404) {
        // 追加
        this.$store.dispatch('getToast', { msg: 'ユーザーが見つかりません😷' })
        // 削除
        // this.$store.dispatch('getToast', { msg: 'ユーザーが見つかりません😷', timeout: -1 })
      }
    }
  }
}
</script>

ミドルウェアにトースターを追加する

ミドルウェアのauthenticator.jsにもトースターを追加します。

front/middleware/authenticator.js
export default async ({ $auth, store, route, redirect }) => {
  if (!$auth.isAuthenticated()) {
    // 有効期限外の時
    let msg = 'ログインが必要です'

    if ($auth.isUserPresent()) {
      // ログイン中のユーザー
      msg = 'もう一度ログインしてください'
      await $auth.logout()
    } else {
      // ログイン前ユーザー
      store.dispatch('getRememberRoute', route)
    }

    // 追加
    store.dispatch('getToast', { msg })
    // 削除
    // console.log(msg)
    return redirect('/login')
  } else if (!$auth.isUserPresent()) {
    ...
  }
}

リダイレクト時にトースターが現れるようになりました。

2020-10-12 07-47-55

コミットしよう

コミットしましょう。

root $ cd front
front $ git add -A && git commit -m "add_toaster.vue" && cd ..
root &

まとめ

今回実装したトースターは、$store.dispatchからメッセージを送ると、どこからでも呼び出すことができます。

例えばレイアウトファイルに<toaster />を置くことで、そのレイアウトを使用する全てのページがらトースターを呼び出すことができます。

今回はログインページだけですが、どうぞ使い回してください。

次回は?

次は、エラーページの実装です。

お疲れ様でした。(長かった…)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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開発
ブログ構築
小ネタ集