クイックスターターズ

NuxtJSのバックエンドを構築する方法は?

47min

はじめに

このチュートリアルでは、Back4appを使用してNuxtJSアプリケーションの完全なバックエンドを構築する方法を学びます。

データベース管理、Cloud Code Functions、RESTおよびGraphQL API、ユーザー認証、リアルタイムクエリ(ライブクエリ)など、重要なBack4app機能を統合する方法を説明し、NuxtJSフロントエンドとシームレスに通信する安全でスケーラブル、かつ堅牢なバックエンドを作成します。

Back4appの迅速なセットアップと直感的な環境が、サーバーやデータベースを手動で構成するのに比べて、時間と労力を大幅に削減できることも確認できます。

その過程で、Cloud Jobsを使用したタスクのスケジューリングや、外部統合のためのWebhookの設定など、主要な機能に関する実践的な経験を得ることができます。

このチュートリアルの終わりまでには、この基盤となるセットアップを本番環境に適したアプリケーションに拡張する準備が整い、必要に応じてカスタムロジックやサードパーティAPIを簡単に組み込むことができるようになります。

前提条件

このチュートリアルを完了するには、次のものが必要です:

  • Back4appアカウントと新しいBack4appプロジェクト Back4appの始め方。 アカウントを持っていない場合は、無料で作成できます。上記のガイドに従ってプロジェクトを準備してください。
  • 基本的なNuxtJS開発環境 これを設定するには、Nuxtアプリを作成するまたは同様のツールを使用できます。マシンにNode.jsがインストールされていることを確認してください。
  • Node.js(バージョン14以上)がインストールされていること npmパッケージをインストールし、ローカル開発サーバーを実行するにはNode.jsが必要です。 Node.jsのインストール
  • JavaScriptと基本的なNuxtJSの概念に精通していること NuxtJS公式ドキュメント。 NuxtJSが初めての場合は、始める前に公式ドキュメントや初心者向けのチュートリアルを確認してください。

始める前に、これらの前提条件がすべて整っていることを確認してください。Back4appプロジェクトを設定し、ローカルのNuxtJS環境を準備しておくと、より簡単に進めることができます。

ステップ1 – Back4appプロジェクトの設定

新しいプロジェクトを作成する

Back4app上でNuxtJSバックエンドを構築する最初のステップは、新しいプロジェクトを作成することです。まだ作成していない場合は、次の手順に従ってください:

  1. Back4appアカウントにログインします.
  2. 「新しいアプリ」ボタンをクリックします あなたのBack4appダッシュボードで。
  3. アプリに名前を付けます(例:「NuxtJS-Backend-Tutorial」)。
Document image


プロジェクトが作成されると、あなたのBack4appダッシュボードにリストされているのが見えます。このプロジェクトは、このチュートリアルで説明するすべてのバックエンド設定の基盤となります。

Parse SDKを接続する

Back4appは、データを管理し、リアルタイム機能を提供し、ユーザー認証を処理するためにParseプラットフォームに依存しています。NuxtJSアプリケーションをBack4appに接続するには、parse npmパッケージをインストールし、Back4appダッシュボードの資格情報で初期化する必要があります。

Parseキーを取得します: Back4appダッシュボードで、アプリの「アプリ設定」または「セキュリティとキー」セクションに移動して、あなたのアプリケーションIDJavaScriptキーを見つけます。ParseサーバーURLも見つかります(通常はhttps://parseapi.back4app.com)。

Document image


Parse SDKをインストールします あなたのNuxtJSプロジェクトに:

Bash


Yarnを使用している場合は、次のようにインストールできます:

Bash


NuxtJSアプリケーションでParseを初期化します:

便利なアプローチは、Nuxtプラグインを作成してParseを設定することです。Nuxtプロジェクト内に、ファイル(例:parse.client.js)をpluginsディレクトリに作成し、次の内容を追加します:

plugins/parse.client.js


次に、あなたのnuxt.config.jsファイルを開き、このプラグインを追加してクライアント側で読み込まれるようにします:

Text


このステップを完了することで、NuxtJSフロントエンドとBack4appバックエンドの間に安全な接続が確立されました。すべてのリクエストとデータトランザクションは、このSDKを通じて安全にルーティングされ、手動のRESTまたはGraphQL呼び出しの複雑さが軽減されます(必要に応じてそれらを使用することもできます)。

ステップ2 – データベースの設定

データの保存とクエリ

Back4appプロジェクトが設定され、Parse SDKがNuxtアプリに統合されたので、データの保存と取得を開始できます。レコードを作成する最も簡単な方法は、Parse.Objectクラスを使用することです。たとえば、データ操作を処理するためのコンポーザブルまたはストアメソッドを作成できます。

JS


また、Back4appのREST APIエンドポイントを使用することもできます:

Curl


Back4appはGraphQLインターフェースも提供しています:

GraphQL


これらの多様なオプションにより、Parse SDK、REST、またはGraphQLを通じて、開発プロセスに最適な方法でデータ操作を統合できます。

スキーマ設計とデータ型

デフォルトでは、Parseは スキーマを動的に作成する, しかし、より多くの制御のためにBack4appダッシュボードでクラスとデータ型を定義することもできます。

  1. Back4appダッシュボードの「データベース」セクションに移動します。
  2. 新しいクラスを作成します。(例:「Todo」)およびタイトル(String)やisCompleted(Boolean)などの関連する列を追加します。
新しいクラスを作成
新しいクラスを作成


Back4appはさまざまなデータ型もサポートしています: String, Number, Boolean, Object, Date, File, Pointer, Array, Relation, GeoPoint, そして Polygon. 各フィールドに適切な型を選択できます。希望する場合は、Nuxtアプリからオブジェクトを最初に保存するときにParseが自動的にこれらの列を作成することもできます。

列を作成
列を作成


Back4appはデータモデルの設計を手助けするAIエージェントを提供しています:

  1. AIエージェントを開く あなたのアプリダッシュボードまたはメニューから。
  2. データモデルを説明する 簡単な言葉で(例:「新しいToDoアプリをback4appで完全なクラススキーマで作成してください。」)。
  3. AIエージェントにスキーマを作成させる
Document image


AIエージェントを使用すると、データアーキテクチャの設定にかかる時間を節約し、アプリケーション全体での一貫性を確保できます。

リレーショナルデータ

リレーショナルデータがある場合 - 例えば、複数のカテゴリオブジェクトが複数のToDoアイテムを指している場合 - ポインタまたはリレーションをParseで使用できます。例えば:

JS


クエリを実行する際には、ポインタデータも含めることができます:

JS


このinclude('category')呼び出しは、各ToDoとともにカテゴリの詳細を取得し、リレーショナルデータをシームレスにアクセス可能にします。

ライブクエリ

リアルタイムの更新のために、Back4appはライブクエリを提供します。あなたのNuxtJSアプリでは、特定のクラスの変更にサブスクライブできます:

  1. ライブクエリを有効にする あなたのBack4appダッシュボードのアプリの サーバー設定. 「ライブクエリ」がオンになっていることを確認してください。
  2. ライブクエリサブスクリプションを初期化する あなたの parse.client.js または類似のファイルで:
plugins/parse.client.js


さて、あなたのコードで:

JS


サブスクリプションを行うことで、新しいTodoが作成、更新、または削除されるたびにリアルタイム通知を受け取ります。この機能は、複数のユーザーがページをリフレッシュせずに最新のデータを確認する必要があるコラボレーティブまたはダイナミックなアプリに特に価値があります。

ステップ3 – ACLとCLPによるセキュリティの適用

Back4appのセキュリティメカニズム

Back4appは、 アクセス制御リスト (ACL)クラスレベルの権限 (CLP) を提供することでセキュリティを真剣に考えています。これらの機能により、オブジェクトまたはクラスごとにデータの読み取りや書き込みを制限でき、認可されたユーザーのみがデータを変更できるようにします。

Document image


アクセス制御リスト (ACL)

ACL」は、個々のオブジェクトに適用され、どのユーザー、役割、または一般の人々が読み取り/書き込み操作を行えるかを決定します。例えば:

JS


オブジェクトを保存すると、それには指定されたユーザー以外の誰も読み取りまたは変更できないようにするACLがあります。

ACLを編集
ACLを編集


クラスレベルの権限 (CLP)

CLPは、クラス全体のデフォルトの権限を管理します。たとえば、クラスが公開されているか書き込み可能か、または特定の役割のみがアクセスできるかどうかです。

  1. Back4appダッシュボードに移動, アプリを選択し、データベースセクションを開きます。
  2. クラスを選択(例:「Todo」)。
  3. クラスレベルの権限タブを開きます。
  4. 「認証が必要」などのデフォルトを設定します。読み取りまたは書き込み用、または「アクセス不可」を公開用に設定します。
Document image


これらの権限は基本を設定し、ACLは個々のオブジェクトの権限を微調整します。堅牢なセキュリティモデルは通常、CLP(広範な制限)とACL(オブジェクトごとの細かい制限)を組み合わせます。詳細については、アプリセキュリティガイドライン。

ステップ4 – クラウドファンクションの作成とデプロイ

Cloud Codeは、サーバー側でカスタムJavaScriptコードを実行できるParse Server環境の機能であり、サーバーやインフラストラクチャを管理する必要はありません。Cloud Codeを書くことで、Back4appのバックエンドを追加のビジネスロジック、バリデーション、トリガー、およびParse Server上で安全かつ効率的に実行される統合で拡張できます。

仕組み

Cloud Codeを書くとき、通常はJavaScript関数、トリガー、および必要なNPMモジュールをmain.js(またはapp.js)ファイルに配置します。このファイルは、Parse Server環境内で実行されるBack4appプロジェクトにデプロイされます。これらの関数とトリガーはサーバー上で実行されるため、機密ロジックを処理したり、敏感なデータを処理したり、バックエンド専用のAPI呼び出しを行ったりすることを信頼できます。これらはクライアントに直接公開したくないプロセスです。

Back4appアプリのすべてのCloud Codeは、Back4appによって管理されるParse Server内で実行されるため、サーバーのメンテナンス、スケーリング、またはプロビジョニングについて心配する必要はありません。main.jsファイルを更新してデプロイするたびに、実行中のParse Serverは最新のコードで更新されます。

main.jsファイル構造 典型的なmain.jsには次のような内容が含まれる場合があります:

  1. 必要なモジュールのRequireステートメント(NPMパッケージ、組み込みNodeモジュール、または他のCloud Codeファイル)。
  2. Cloud関数の定義を使用してParse.Cloud.define().
  3. トリガーとしてParse.Cloud.beforeSave(), Parse.Cloud.afterSave(), など。
  4. インストールしたNPMモジュール(必要な場合)。たとえば、HTTPリクエストを行うためにaxiosのようなパッケージをインストールすることがあります。その後、ファイルの先頭でそれをrequire(またはimport)できます。
JS


NPMモジュールをインストールして使用する能力により、Cloud Codeは非常に柔軟になり、外部APIとの統合、データ変換の実行、または複雑なサーバーサイドロジックの実行が可能になります。

典型的な使用例

  • ビジネスロジック: 例えば、複数のオブジェクトプロパティを集計してゲーム内のユーザーのスコアを計算し、そのデータを自動的に保存することができます。
  • データ検証: レコードを保存または削除する前に、特定のフィールドが存在することやユーザーが正しい権限を持っていることを確認します。
  • トリガー: データが変更されたときにアクションを実行します(例:ユーザーがプロフィールを更新したときに通知を送信)。
  • 統合: サードパーティのAPIやサービスと接続します。例えば、Cloud Codeから直接支払いゲートウェイ、Slack通知、またはメールマーケティングプラットフォームと統合することができます。
  • セキュリティ強化: Cloud Code関数内で入力パラメータを検証およびサニタイズすることで、追加のセキュリティ層を追加します。例えば、受信データが特定の形式に一致することを確認し、無効または悪意のある入力を拒否し、機密操作を実行する前にユーザーの役割や権限に基づいてアクセスルールを強制することができます。

関数をデプロイする

以下は、クライアントから送信されたテキスト文字列の長さを計算するシンプルなCloud Code関数です。

main.js


デプロイするには Back4app CLI:

1 - CLIをインストールする:

  • Linux/MacOSの場合:
Bash

Bash


3 - クラウドコードをデプロイする:

Bash


ダッシュボードを通じてデプロイする:

  1. アプリのダッシュボードで、クラウドコード > 関数に移動します。
  2. 関数をmain.jsエディタにコピー/ペーストします。
  3. 「デプロイ」をクリックします。
Document image


関数を呼び出す

Parse SDKを使用して、NuxtJSアプリケーションから:

JS


REST経由でも呼び出すことができます:

Curl


またはGraphQL経由で:

GraphQL


この柔軟性により、NuxtJSフロントエンドやRESTまたはGraphQLをサポートする他のクライアントにカスタムロジックを統合することができます。

ステップ5 – ユーザー認証の設定

Back4appにおけるユーザー認証

Back4appは、Parse Userクラスを認証の基盤として活用しています。デフォルトでは、Parseはパスワードのハッシュ化、セッショントークン、セキュアストレージを処理します。これは、複雑なセキュリティフローを手動で設定する必要がないことを意味します。

ユーザー認証の設定

Nuxtアプリケーションでは、次のように新しいユーザーを作成できます:

JS


既存のユーザーでログインするには:

JS


REST経由でのログインは次のようになります:

Bash


セッション管理

ログインに成功すると、Parseはセッショントークンを作成し、ユーザーオブジェクトに保存します。Nuxtアプリでは、現在ログインしているユーザーにアクセスできます:

JS


Parseは自動的にトークンベースのセッションをバックグラウンドで処理しますが、手動で管理または取り消すこともできます。これは、ログアウトする必要があるときに便利です:

JS


ソーシャルログイン統合

Back4appとParseは、追加のパッケージをインストールするか、既存のアダプターを使用することで、GoogleFacebookなどの人気のあるOAuthプロバイダーと統合できます。たとえば、Facebook App IDを設定し、Parse.FacebookUtils.logIn()を使用することで、Facebookログインを設定できます。詳細な手順は異なるため、ソーシャルログインのドキュメント。

JS


メール認証とパスワードリセット

メール認証とパスワードリセットを有効にするには:

  1. Back4appダッシュボードのメール設定に移動します。
  2. メール認証を有効にすることで、新しいユーザーが自分のメールアドレスの所有権を確認できるようにします。
  3. 送信元アドレスを設定する、メールテンプレート、および必要に応じてカスタムドメインを設定します。

これらの機能は、ユーザーがメールの所有権を確認し、安全なパスワード回復方法を提供することで、アカウントのセキュリティとユーザーエクスペリエンスを向上させます。

ステップ6 – ファイルストレージの取り扱い

ファイルのアップロードと取得

Parseには、Back4appが安全に保存するファイルアップロードを処理するための Parse.File クラスが含まれています:

JS


データベース内のオブジェクトにファイルを添付するには:

JS


ファイルURLの取得は簡単です:

JS


ファイルのセキュリティ

Parse Serverは、ファイルアップロードのセキュリティを管理するための柔軟な設定を提供します。以下の例は、誰がサーバーにファイルをアップロードできるかを制御するための権限を設定する方法を示しています:

Text

  • enableForPublic: trueに設定すると、認証状況に関係なく、誰でもファイルをアップロードできるようになります。
  • enableForAnonymousUser: 匿名ユーザー(サインアップしていないユーザー)がファイルをアップロードできるかどうかを制御します。
  • enableForAuthenticatedUser: 認証されたユーザーのみがファイルをアップロードできるかどうかを指定します。これは、信頼できるユーザーのみがこの機能にアクセスできるようにするために理想的です。

ステップ7 – クラウドジョブを使用したタスクのスケジューリング

クラウドジョブ

クラウドジョブはBack4appでバックエンド上のルーチン作業をスケジュールして実行することができます - 古いデータのクリーンアップや毎日の要約メールの送信など。典型的なクラウドジョブは次のようになります:

JS

  1. クラウドコードをデプロイする 新しいジョブと共に(CLIまたはダッシュボード経由で)。
  2. Back4appダッシュボードに移動する > アプリ設定 > サーバー設定 > バックグラウンドジョブ.
  3. ジョブをスケジュールする 毎日またはニーズに合った間隔で実行されるように。
クラウドジョブのスケジューリング
クラウドジョブのスケジューリング


クラウドジョブは、バックグラウンドメンテナンスやその他の定期的なプロセスを自動化することを可能にします - 手動の介入を必要とせずに。

ステップ8 – Webhookの統合

Webhookは、特定のイベントが発生するたびに、Back4appアプリが外部サービスにHTTPリクエストを送信できるようにします。これは、決済ゲートウェイ(例:Stripe)、メールマーケティングツール、または分析プラットフォームなどのサードパーティシステムと統合するために強力です。

  1. Webhookの設定に移動し、Back4appダッシュボード > その他 > WebHooksに進み、次にWebhookを追加をクリックします。
  2. エンドポイントを設定(例: https://your-external-service.com/webhook-endpoint)。
  3. トリガーを設定して、Back4appのクラスやCloud Code関数内のどのイベントがWebhookを発火させるかを指定します。
Webhookの追加
Webhookの追加


例えば、新しいTodoが作成されるたびにSlackチャンネルに通知したい場合:

  • 受信ウェブフックを受け入れるSlackアプリを作成します。
  • SlackのウェブフックURLをコピーします。
  • Back4appダッシュボードで、「Todoクラスの新しいレコード」イベントのためにそのSlack URLにエンドポイントを設定します。
  • 必要に応じてカスタムHTTPヘッダーやペイロードを追加することもできます。

トリガーのbeforeSaveやafterSaveでカスタムHTTPリクエストを行うことで、Cloud CodeでWebhooksを定義することもできます。

BeforeSave WebHook
BeforeSave WebHook


ステップ9 – Back4app管理パネルの探索

Back4app管理アプリ」は、非技術的なユーザーがCRUD操作を行い、コードを書くことなく日常的なデータタスクを処理するために設計されたウェブベースの管理インターフェースです。これは、「モデル中心」で、「ユーザーフレンドリー」なインターフェースを提供し、データベース管理、カスタムデータ管理、エンタープライズレベルの操作を効率化します。

管理アプリの有効化

管理アプリ」を有効にするには、「アプリダッシュボード > その他 > 管理アプリ」に移動し、「管理アプリを有効にする」ボタンをクリックします。

管理アプリを有効にする
管理アプリを有効にする


最初の管理ユーザーを作成します(ユーザー名/パスワード)を作成すると、自動的に新しい役割(B4aAdminUser)とクラス(B4aSetting、B4aMenuItem、B4aCustomField)がアプリのスキーマに生成されます。

Document image


管理インターフェースにアクセスするためのサブドメインを選択し、セットアップを完了します。

Document image


ログイン 新しい管理アプリのダッシュボードにアクセスするために作成した管理者資格情報を使用してください。

Document image


一度有効にすると、Back4app管理アプリは、Parseダッシュボードやバックエンドコードを直接使用することなく、データベースのレコードを簡単に表示、編集、または削除することができます。設定可能なアクセス制御を使用することで、データを管理するための明確でポイントアンドクリックの方法が必要なチームメンバーやクライアントとこのインターフェースを安全に共有できます。

結論

この包括的なチュートリアルに従うことで、あなたは:

  • 安全なバックエンドを作成しました Back4app上のNuxtJSアプリ用です。
  • データベースを構成しました クラススキーマ、データ型、関係を使用して。
  • リアルタイムクエリを統合しました (ライブクエリ)即時データ更新のために。
  • セキュリティ対策を適用しました ACLとCLPを使用してデータアクセスを保護および管理するために。
  • クラウドコードを実装しました サーバー側でカスタムビジネスロジックを実行するための関数。
  • ユーザー認証を設定しました メール確認とパスワードリセットをサポートしています。
  • ファイルのアップロードを管理しました オプションのファイルセキュリティコントロール付きで、ファイルの取得も行います。
  • クラウドジョブをスケジュールしました 自動化されたバックグラウンドタスクのために。
  • Webhookを使用しました 外部サービスと統合するために。
  • Back4app管理パネルを探索しました データ管理のために。

堅牢なNuxtJSフロントエンドと強力なBack4appバックエンドを持つことで、機能豊富でスケーラブルかつ安全なアプリケーションを開発するための準備が整いました。より高度な機能を探求し、ビジネスロジックを統合し、Back4appの力を活用してサーバーとデータベースの管理にかかる無数の時間を節約してください。コーディングを楽しんでください!

次のステップ

  • 本番環境に適したNuxtJSアプリを構築する このバックエンドを拡張して、より複雑なデータモデル、キャッシング戦略、パフォーマンス最適化を処理します。
  • 高度な機能を統合する 特化した認証フロー、役割ベースのアクセス制御、または外部API(支払いゲートウェイなど)を含みます。
  • Back4appの公式ドキュメントをチェックする 高度なセキュリティ、パフォーマンス調整、ログ分析についての詳細な情報を得るために。
  • 他のチュートリアルを探る リアルタイムチャットアプリケーション、IoTダッシュボード、または位置情報サービスに関するものです。ここで学んだ技術をサードパーティのAPIと組み合わせて、複雑な実世界のアプリケーションを作成できます。