Udemy 8. ユーザーモデル開発 #08
2020年07月15日に公開

Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする

今回達成すること

本番環境のNuxt.js上にユーザーテーブルを表示します。

2020-07-15 16-40-33

具体的な手順は以下のとおりです。

  1. 必要のないhelloコントローラーを削除
  2. usersコントローラーの作成
  3. Nuxt.jsでユーザーテーブルを取得
  4. 本番環境にデプロイ
    • Herokuにユーザーテーブルを作成し、Seedデータを投入する

それでは参りましょう。

helloコントローラーを削除する

下記の記事で作成したhello_controller.rbは使用しません。

【Rails6】“Hello” jsonを返すコントローラを作成する

忘れないうちに削除しておきましょう。

root $ docker-compose run --rm api rails destroy controller Api::V1::Hello

rails generateコマンドで作成したコントローラーやモデルはdestroyコマンドで削除します。

このように関連あるファイルも同時に削除してくれます。

remove  app/controllers/api/v1/hello_controller.rb
      invoke  test_unit
      remove    test/controllers/api/v1/hello_controller_test.rb

ユーザーコントローラーを作成する

続いてテーブルからユーザー一覧を取得するユーザーコントローラーを作成します。

root $ docker-compose run --rm api rails g controller Api::V1::Users

  create  app/controllers/api/v1/users_controller.rb
  invoke  test_unit
  create    test/controllers/api/v1/users_controller_test.rb

ユーザーを取得するアクションを追加する

作成したusers_controller.rbに、ユーザー一覧を取得するアクションを作成しましょう。

api/app/controllers/api/v1/users_controller.rb
class Api::V1::UsersController < ApplicationController
  # 追加
  def index
    users = User.all
    render json: users.as_json(only: [:id, :name, :email, :created_at])
  end
end

アクションへのルートを追加する

indexアクションへアクセスするルートをroutes.rbに追加しましょう。

ついでに「hello」へのルートは削除します。

api/config/routes.rb
Rails.application.routes.draw do
  namespace :api do
    namespace :v1 do
      # 追加
       resources :users, only:[:index]
      # 削除
      # resources :hello, only:[:index]
    end
  end
end

ユーザー取得を確認する

コンテナを起動してユーザーが取得できているか確認してみましょう。

root $ docker-compose up api

http://localhost:3000/api/v1/users にアクセスすると。。。

2020-07-02 09-32-58

ユーザー情報が取れてますね。

それではコンテナを削除しておきましょう。

root $ 「controll」+「C」
root $ docker-compose down

以上でRailsサイドの準備は整いました。

Nuxt.jsからユーザーテーブルを取得する

次はNuxt.jsからユーザーテーブルを取得します。

トップページのindex.vueをまるっと書き換えましょう。

front/pages/index.vue
<template>
  <div>
    <h2>
      Usersテーブルの取得
    </h2>
    <table v-if="users.length">
      <thead>
        <tr>
          <th>id</th>
          <th>name</th>
          <th>email</th>
          <th>created_at</th>
        </tr>
      </thead>
      <tbody>
        <tr
          v-for="(user, i) in users"
          :key="`user-${i}`"
        >
          <td>{{ user.id }}</td>
          <td>{{ user.name }}</td>
          <td>{{ user.email }}</td>
          <td>{{ dateFormat(user.created_at) }}</td>
        </tr>
      </tbody>
    </table>

    <div v-else>
      ユーザーが取得できませんでした
    </div>
  </div>
</template>

<script>
export default {
  async asyncData ({ $axios }) {
    let users = []
    await $axios.$get('/api/v1/users')
      .then(res => (users = res))
    return { users }
  },
  computed: {
    dateFormat () {
      return (date) => {
        const dateTimeFormat = new Intl.DateTimeFormat(
          'ja', { dateStyle: 'medium', timeStyle: 'short' }
        )
        return dateTimeFormat.format(new Date(date))
      }
    }
  }
}
</script>
  • asyncData(エイシンクデータ) … コンポーネントのデータを表示する前に実行されるメソッド。

    usersを取得した後にコンポーネントデータを表示しないと「usersが無いよ」というエラーになるため、ここで取得しています。

  • dateFormat() … 日付のフォーマットを変換する関数。

    new Intl.DateTimeFormat(lang, {options}) はJavascriptの日付変換コンストラクター。

    Styleの値はfulllongmediumshortから選択します。

    参考 Intl.DateTimeFormat - MDN Web Docs - Mozilla

asyncとは?

これが付いた関数は常にpromiseを返します

promiseとは、非同期処理の最終的な完了、もしくは失敗を表すオブジェクトのことです。

  • 処理が完了した場合 … then()の中で完了した処理を受け取ります。
  • 処理が失敗した場合 … catch()の中でエラーを受け取ります。

具体的な事例を見ていきましょう。

通常の関数の場合

この場合、コンソールには「hoge」という文字列が返されます。

mounted () {
  console.log(this.hoge()) // hoge
},
methods: {
  hoge () {
    return 'hoge'
  }
}
asyncの場合

「hoge」という文字列は返されず、説明の通りPromise {<pending>}というオブジェクトが返されます。

mounted () {
  console.log(this.hoge()) // Promise {<pending>}
},
methods: {
  async hoge () {
    return await 'hoge'
  }
}
Promiseで返ってきた処理結果を取り出す

処理の結果(hogeという文字列)はPromiseにラップされており、then()の第一引数で受け取ることができます。

mounted () {
  this.hoge().then(response =>
    console.log(response) // hoge
  )
},

以上がpromiseを返すということであり、asyncの動作でもあります。

awaitとは?

await(アウェイト)が付いた処理は、結果(promise)を返すまでJavascriptを待機させます。

そしてpromiseが確定したら次の処理へ進みます。

awaitasyncの関数内でしか動作しません。


ユーザーを取得する$axios(アクシオス)の処理は比較的時間がかかるため、確実に処理の結果を待つためにawaitをつけています。

async asyncData ({ $axios }) {
  let users = []
  await $axios.$get('/api/v1/users')
    .then(res => (users = res))
  return { users }
},

参考 Async/await - Javascript.info

ブラウザでユーザーテーブルを確認しよう

それではコンテナを起動して、http://localhost:8080/ にアクセスしてください。

root $ docker-compose up

このようにユーザー一覧が表示できれば成功です。

2020-07-15 14-37-40

確認が取れたらコンテナを停止し、削除しておいてください。

root $ 「control」+「C」
root $ docker-compose down

本番環境にデプロイしよう

それでは各ディレクトリに移動してHerokuにpushしていきます。

frontディレクトリをHerokuにpush

「front」ディレクトリはコミット後、そのままpushしましょう。

root  $ cd front
front $ git commit -am "show_users_index.vue"
front $ git push
front $ git push heroku

apiディレクトリをHerokuにpush

「api」ディレクトリに移動してコミットします。

front $ cd ../api
api   $ git add -A
api   $ git commit -m "add_users_controller.rb"

今のブランチから抜け、マスターブランチにマージします。

api $ git checkout master
api $ git merge 20200708_modeling_users <自身のブランチ名に変更>

GitHubとHerokuにpushします。

api $ git push
api $ git push heroku

Herokuにユーザーテーブルを作成する

Herokuのデータベースには、まだユーザーテーブルがありません。

そこでherokuコマンドを使ってユーザーテーブルを作成します。

# ユーザーテーブルの作成
api $ heroku run rails db:migrate

# Seedデータの投入
api $ heroku run rails db:seed

# herokuオープン
api $ heroku open

ブラウザが開いたら、<HerokuのURL>/api/v1/users にアクセスしてみましょう。

2020-07-15 16-29-43

ユーザー一覧が表示されていますね。

「root」ディレクトリをpushする

それでは最後に「root」ディレクトリをpushしましょう。

api  $ cd ..
root $ git commit -am "finished_modeling_users"
root $ git push

本番環境のNuxt.jsを確認してみよう

ユーザー一覧が取得できているか、Nuxt.jsの稼働を確認してみましょう。

「front」ディレクトリに移動してHerokuを開きます。

root  $ cd front
front $ heroku open

開発環境と同じようにユーザー一覧が表示されていれば成功です!

2020-07-15 16-40-33

以上でユーザーテーブルのデプロイが完了しました。

この記事まとめ

今回はRailsに作成したユーザーテーブルを、Nuxt.jsから取得し、Herokuにデプロイしました。

heroku.ymlを使ったDockerデプロイでは、いつもと同じmigrateコマンドでテーブルが作成で切るんですね。(知らなかった)

皆さんも覚えておきましょう。

# ユーザーテーブルの作成
api $ heroku run rails db:migrate

# Seedデータの投入
api $ heroku run rails db:seed

このチャプターまとめ

以上で「ユーザモデル開発」を終了します。

このチャプターでは以下のことを行いました。

次回予告

次回から新チャプター「Nuxt.jsフロント開発事前準備(仮)」が始まります。

たらたら書いていたら新機能搭載のNuxt.js v2.13が出ちゃいました。

まずは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
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集