NodeJSのバックエンドを構築する方法は?
このチュートリアルでは、Back4appを使用してNodeJSアプリケーションの完全なバックエンドを構築する方法を学びます。
データベース管理、Cloud Code Functions、RESTおよびGraphQL API、ユーザー認証、リアルタイムクエリ(ライブクエリ)など、Back4appの重要な機能を統合する方法を説明し、NodeJSコードとシームレスに通信する安全でスケーラブル、かつ堅牢なバックエンドを作成します。
また、Back4appの迅速なセットアップと直感的な環境が、サーバーやデータベースを手動で構成するのに比べて、時間と労力を大幅に削減できることを確認します。
その過程で、高度なセキュリティ機能、Cloud Jobsを使用したタスクのスケジューリング、外部統合のためのWebhookの設定など、主要な機能に関する実践的な経験を得ることができます。
このチュートリアルの終わりまでには、この基本的なセットアップを本番環境に適したアプリケーションに拡張する準備が整い、必要に応じてカスタムロジックやサードパーティAPIを簡単に組み込むことができるようになります。
このチュートリアルを完了するには、次のものが必要です:
- 基本的なNodeJSのセットアップ npm init(または yarn init)を実行してNodeプロジェクトを初期化できます。依存関係を管理するためにpackage.jsonファイルが必要です。
- JavaScriptと基本的なNodeJSの概念に精通していること NodeJS公式ドキュメント。 Nodeに不慣れな場合は、開始する前に公式ドキュメントや初心者向けのチュートリアルを確認してください。
始める前に、これらの前提条件がすべて整っていることを確認してください。Back4appプロジェクトを設定し、ローカルのNodeJS環境を準備しておくことで、より簡単に進めることができます。
Back4app上でNodeJSバックエンドを構築する最初のステップは、新しいプロジェクトを作成することです。まだ作成していない場合は、次の手順に従ってください:
- Back4appアカウントにログインする.
- 「新しいアプリ」ボタンをクリックする あなたのBack4appダッシュボードで。
- アプリに名前を付ける(例:「NodeJS-バックエンド-チュートリアル」)。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/drXO0UqsgxhFvRDiVmsMb_image.png?format=webp)
プロジェクトが作成されると、あなたのBack4appダッシュボードにリストされているのが見えます。このプロジェクトは、このチュートリアルで説明するすべてのバックエンド設定の基盤となります。
Back4appは、データを管理し、リアルタイム機能を提供し、ユーザー認証を処理するためにParseプラットフォームに依存しています。NodeJSアプリケーションをBack4appに接続するには、parse npmパッケージをインストールし、Back4appダッシュボードからの資格情報で初期化する必要があります。
Parseキーを取得する: Back4appダッシュボードで、アプリの「アプリ設定」または「セキュリティとキー」セクションに移動して、あなたのアプリケーションIDとJavaScriptキー}を見つけます。また、ParseサーバーURL(通常はhttps://parseapi.back4app.com)も見つけることができます。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/F9teHXd_M8ERn1OPGirbi_image.png?format=webp)
Parse SDKをインストールする あなたのNodeJSプロジェクトに:
Yarnを使用している場合は、次のようにインストールできます:
NodeJSアプリケーションでParseを初期化する:
ファイルを作成します(例:parseConfig.js)、Nodeプロジェクトのルートに配置します:
次に、メインエントリーファイル(例:index.js)でParseをインポートして接続を確立します:
このステップを完了することで、NodeJSバックエンドとBack4appインフラストラクチャの間に安全な接続が確立されました。すべてのリクエストとデータトランザクションは、このSDKを通じて安全にルーティングされ、手動のRESTまたはGraphQL呼び出しの複雑さが軽減されます(必要に応じてそれらを使用することもできます)。
Back4appプロジェクトが設定され、Parse SDKがNodeアプリに統合されたので、データの保存と取得を開始できます。レコードを作成する最も簡単な方法は、Parse.Objectクラスを使用することです:
また、Back4appのREST APIエンドポイントを使用することもできます:
Back4appはGraphQLインターフェースも提供しています:
これらの多様なオプションにより、Parse SDK、REST、またはGraphQLを通じて、開発プロセスに最適な方法でデータ操作を統合できます。
デフォルトでは、Parseは スキーマを動的に作成することを許可します, ただし、より多くの制御のためにBack4appダッシュボードでクラスとデータ型を定義することもできます。
- Back4appダッシュボードの「データベース」セクションに移動します。
- 新しいクラスを作成します(例:「Todo」)を作成し、タイトル(String)やisCompleted(Boolean)などの関連する列を追加します。
![新しいクラスを作成 新しいクラスを作成](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/iaZ_P-7epc_LSMFIPlaZV_image.png?format=webp)
Back4appはさまざまなデータ型もサポートしています: String, Number, Boolean, Object, Date, File, Pointer, Array, Relation, GeoPoint, および Polygon. 各フィールドに適切な型を選択できます。希望する場合は、Nodeアプリからオブジェクトを最初に保存するときにParseが自動的にこれらの列を作成することもできます。
![列を作成 列を作成](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/DEh9vyxdBTZcslXxkVQMA_image.png?format=webp)
Back4appは、データモデルの設計を手助けするAIエージェントを提供しています。
- AIエージェントを アプリダッシュボードまたはメニューから開きます。
- データモデルを 簡単な言葉で説明します(例:「新しいToDoアプリをback4appで完全なクラススキーマで作成してください。」)。
- AIエージェントにスキーマを作成させます.
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/0snNZwHWzxuXlNu30n7IA_image.png?format=webp)
AIエージェントを使用すると、データアーキテクチャの設定にかかる時間を節約し、アプリケーション全体での一貫性を確保できます。
リレーショナルデータがある場合、例えば、複数のCategoryオブジェクトが複数のTodoアイテムを指している場合、ParseでPointersまたはRelationsを使用できます。例えば、Categoryへのポインタを追加します:
クエリを実行する際、ポインタデータも含めることができます。
このinclude('category')呼び出しは、各Todoとともにカテゴリの詳細を取得し、リレーショナルデータをシームレスにアクセス可能にします。
リアルタイムの更新について、Back4appは Live Queries を提供しています。NodeJSアプリでは、特定のクラスの変更にサブスクライブできます:
- Live Queriesを有効にするには、Back4appダッシュボードのアプリの サーバー設定 で行います。「Live Queries」がオンになっていることを確認してください。
- Live Queryサブスクリプションを初期化するには、コード内で次のようにします:
サブスクリプションを行うことで、新しいTodoが作成、更新、または削除されるたびにリアルタイム通知を受け取ります。この機能は、複数のユーザーが最新のデータを手動でサーバーにポーリングすることなく見る必要があるコラボレーティブまたはダイナミックなアプリに特に価値があります。
Back4appは、 アクセス制御リスト (ACL) と クラスレベルの権限 (CLP) を提供することで、セキュリティを真剣に考えています。これらの機能により、オブジェクトまたはクラスごとに誰がデータを読み書きできるかを制限でき、認可されたユーザーのみがデータを変更できるようにします。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/PdAyrw1nqA1QQJFuCc-4t_image.png?format=webp)
ACLは、個々のオブジェクトに適用され、どのユーザー、役割、または一般の人々が読み書き操作を行えるかを決定します。例えば:
オブジェクトを保存すると、指定されたユーザー以外の誰も読み取りまたは変更できないACLがあります。
![ACLを編集 ACLを編集](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/3YNfxEcv7CKdLC6ca8my6_image.png?format=webp)
CLPは、クラス全体のデフォルトの権限を管理します。たとえば、クラスが公開されているか書き込み可能か、または特定の役割のみがアクセスできるかどうかです。
- Back4appダッシュボードに移動, アプリを選択し、データベースセクションを開きます。
- クラスを選択(例:「Todo」)。
- クラスレベルの権限タブを開きます。
- デフォルトを設定します。たとえば、読み取りまたは書き込みの「認証が必要」や、一般公開の「アクセス不可」などです。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/MF1Uf7HSJF03Xg6djap9m_image.png?format=webp)
これらの権限は基本を設定し、ACLは個々のオブジェクトの権限を微調整します。堅牢なセキュリティモデルは通常、CLP(広範な制限)とACL(オブジェクトごとの細かい制限)を組み合わせます。詳細については、アプリセキュリティガイドライン。
クラウドコードは、サーバー側でカスタムJavaScriptコードを実行できるParse Server環境の機能であり、サーバーやインフラストラクチャを管理する必要はありません。クラウドコードを書くことで、Back4appのバックエンドを追加のビジネスロジック、バリデーション、トリガー、およびParse Server上で安全かつ効率的に実行される統合で拡張できます。
Cloud Codeを書くとき、通常はJavaScript関数、トリガー、および必要なNPMモジュールをmain.js(または別のJSファイル)に配置し、それをBack4appプロジェクトにデプロイします。このコードはParse Server環境内で実行されます。これらの関数とトリガーはサーバー上で実行されるため、機密ロジックを処理したり、敏感なデータを処理したり、バックエンド専用のAPI呼び出しを行ったりすることを信頼できます。これらはクライアントに直接公開したくないプロセスです。
Back4appアプリのすべてのCloud Codeは、Back4appによって管理されているParse Server内で実行されるため、サーバーのメンテナンス、スケーリング、またはプロビジョニングについて心配する必要はありません。ファイルを更新してデプロイするたびに、実行中のParse Serverは最新のコードで更新されます。
main.jsファイル構造 典型的なmain.jsには次のような内容が含まれる場合があります:
- 必要なモジュールのRequireステートメント(NPMパッケージ、組み込みNodeモジュール、または他のクラウドコードファイル)。
- Cloud関数の定義を使用してParse.Cloud.define().
- トリガーとしてParse.Cloud.beforeSave(), Parse.Cloud.afterSave(), など。
- インストールしたNPMモジュール(必要な場合)。たとえば、HTTPリクエストを行うためにaxiosのようなパッケージをインストールすることがあります。その後、ファイルの先頭でrequireできます。
NPMモジュールをインストールして使用する能力により、Cloud Codeは非常に柔軟になり、外部APIとの統合、データ変換の実行、または複雑なサーバーサイドロジックの実行が可能になります。
- ビジネスロジック: 例えば、複数のオブジェクトプロパティを集約してゲーム内のユーザーのスコアを計算し、そのデータを自動的に保存することができます。
- データ検証: レコードを保存または削除する前に、特定のフィールドが存在することやユーザーが正しい権限を持っていることを確認します。
- トリガー: データが変更されたときにアクションを実行します(例:ユーザーがプロフィールを更新したときに通知を送信)。
- 統合: サードパーティのAPIやサービスと接続します。例えば、Cloud Codeから直接支払いゲートウェイ、Slack通知、またはメールマーケティングプラットフォームと統合することができます。
- セキュリティ強化: Cloud Code関数内で入力パラメータを検証およびサニタイズすることで、追加のセキュリティ層を追加します。
以下は、クライアントから送信されたテキスト文字列の長さを計算するシンプルなCloud Code関数です。
デプロイするには、Back4app CLI:
1 - CLIをインストールする:
- Linux/MacOSの場合:
2 - アカウントキーを設定する:
3 - クラウドコードをデプロイする:
ダッシュボードを通じてデプロイする:
- アプリのダッシュボードで、クラウドコード > 関数に移動します。
- 関数をmain.jsエディタにコピー/ペーストします。
- 「デプロイ」をクリックします。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/pGxBQFBhk4prMc8Ub-uho_image.png?format=webp)
Parse SDKを使用したNodeJSコードから:
REST経由でも呼び出すことができます:
またはGraphQL経由で:
この柔軟性により、NodeJS環境の任意の部分やRESTまたはGraphQLをサポートする他のクライアントにカスタムロジックを統合することができます。
Back4appは、Parse Userクラスを認証の基盤として活用しています。デフォルトでは、Parseはパスワードのハッシュ化、セッショントークン、セキュアストレージを処理します。これは、複雑なセキュリティフローを手動で設定する必要がないことを意味します。
NodeJS環境では、新しいユーザーを次のように作成できます:
既存のユーザーでログイン:
REST経由でのログインは次のようになります:
ログインに成功すると、Parseはセッショントークンを作成し、ユーザーオブジェクトに保存します。Nodeコード内では、アプリケーションロジックでセッションを維持している場合、現在ログインしているユーザーにアクセスできます:
Parseは自動的にトークンベースのセッションをバックグラウンドで処理しますが、手動で管理または取り消すこともできます。ログアウトするには:
Back4appとParseは、追加のパッケージをインストールするか、既存のアダプターを使用することで、 Google または Facebook, などの人気のあるOAuthプロバイダーと統合できます。たとえば、 Facebook App ID を設定し、 Parse.FacebookUtils.logIn() を使用することでFacebookログインを設定できます。詳細な手順は異なるため、 ソーシャルログインのドキュメント。
メール確認とパスワードリセットを有効にするには:
- Back4appダッシュボードのメール設定に移動します。
- 新しいユーザーがメールアドレスの所有権を確認できるようにするために、メール確認を有効にします。
- 送信元アドレスを設定します, メールテンプレート、および必要に応じてカスタムドメインを設定します。
これらの機能は、ユーザーがメールの所有権を確認し、安全なパスワード回復方法を提供することで、アカウントのセキュリティとユーザーエクスペリエンスを向上させます。
Parseには、Back4appが安全に保存するファイルアップロードを処理するための Parse.File クラスが含まれています。
データベース内のオブジェクトにファイルを添付するには、次のようにします:
ファイルのURLを取得するのは簡単です:
Parse Serverは、ファイルアップロードのセキュリティを管理するための柔軟な設定を提供します。以下の例は、誰がサーバーにファイルをアップロードできるかを制御するための権限を設定する方法を示しています:
{ "fileUpload": { "enableForPublic": true, "enableForAnonymousUser": true, "enableForAuthenticatedUser": true } }
- enableForPublic: trueに設定すると、認証状況に関係なく、誰でもファイルをアップロードできるようになります。
- enableForAnonymousUser: 匿名ユーザー(サインアップしていないユーザー)がファイルをアップロードできるかどうかを制御します。
- enableForAuthenticatedUser: 認証されたユーザーのみがファイルをアップロードできるかどうかを指定します。これは、信頼できるユーザーのみがこの機能にアクセスできるようにするために理想的です。
クラウドジョブはBack4appでバックエンド上のルーチン作業をスケジュールして実行できます - 古いデータのクリーンアップや毎日の要約メールの送信など。典型的なクラウドジョブは次のようになります:
- クラウドコードをデプロイする 新しいジョブと共に(CLIまたはダッシュボード経由で)。
- Back4appダッシュボードに移動する > アプリ設定 > サーバー設定 > バックグラウンドジョブ.
- ジョブをスケジュールする 毎日またはニーズに合った間隔で実行されるように。
![クラウドジョブのスケジューリング クラウドジョブのスケジューリング](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/5wG60YnWIST74erryTb-u_image.png?format=webp)
クラウドジョブは、手動の介入を必要とせずに、バックグラウンドメンテナンスやその他の定期的なプロセスを自動化することを可能にします。
Webhookは、特定のイベントが発生するたびに、Back4appアプリが外部サービスにHTTPリクエストを送信できるようにします。これは、決済ゲートウェイ(例:Stripe)、メールマーケティングツール、または分析プラットフォームなどのサードパーティシステムとの統合に強力です。
- Webhook設定に移動し、Back4appダッシュボード > その他 > WebHooksを選択し、次に「Webhookを追加」をクリックします。
- トリガーを設定して、Back4appのクラスやCloud Code関数内のどのイベントがWebhookを発火させるかを指定します。
![Webhookの追加 Webhookの追加](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/morUMdwsAbVQ1EmBfUfAA_image.png?format=webp)
例えば、新しいTodoが作成されるたびにSlackチャンネルに通知したい場合:
- 受信ウェブフックを受け入れるSlackアプリを作成します。
- SlackのウェブフックURLをコピーします。
- Back4appダッシュボードで、「Todoクラスの新しいレコード」イベントのためにそのSlack URLをエンドポイントとして設定します。
- 必要に応じてカスタムHTTPヘッダーやペイロードを追加することもできます。
Cloud Codeで、beforeSaveやafterSaveのトリガーでカスタムHTTPリクエストを行うことでWebhooksを定義することもできます。
![BeforeSave WebHook BeforeSave WebHook](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/fXvy4eRzabyWmN80OMyqW_image.png?format=webp)
「Back4app管理アプリ」は、非技術的なユーザーがCRUD操作を行い、コードを書くことなく日常的なデータタスクを処理するために設計されたウェブベースの管理インターフェースです。これは、「モデル中心」で、「ユーザーフレンドリー」なインターフェースを提供し、データベース管理、カスタムデータ管理、エンタープライズレベルの操作を効率化します。
「管理アプリ」を有効にするには、「アプリダッシュボード > その他 > 管理アプリ」に移動し、「管理アプリを有効にする」ボタンをクリックします。
![管理アプリを有効にする 管理アプリを有効にする](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/5BTk1ntDh9JLXurObmm_o_image.png?format=webp)
最初の管理ユーザーを作成します(ユーザー名/パスワード)を作成すると、自動的に新しい役割(B4aAdminUser)とクラス(B4aSetting、B4aMenuItem、B4aCustomField)がアプリのスキーマに生成されます。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/u-pU1yBJJxa9KEM2psjXS_image.png?format=webp)
管理インターフェースにアクセスするためのサブドメインを選択し、セットアップを完了します。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/_2b71RLDTlQW468017saY_image.png?format=webp)
ログイン 新しい管理アプリのダッシュボードにアクセスするために作成した管理者資格情報を使用してください。
![Document image Document image](https://images.archbee.com/yD3zCY-NNBBIfd0uqcfR5/jOFU8C0qiFm6wiVZXS9l0_image.png?format=webp)
有効にすると、Back4app管理アプリを使用して、データベースのレコードを簡単に表示、編集、または削除できます - Parseダッシュボードやバックエンドコードを直接使用する必要はありません。設定可能なアクセス制御を使用することで、データを管理するための明確でポイント&クリックの方法が必要なチームメンバーやクライアントとこのインターフェースを安全に共有できます。
この包括的なチュートリアルに従うことで、あなたは:
- 安全なバックエンドを作成しました Back4app上のNodeJSアプリ用。
- データベースを構成しました クラススキーマ、データ型、関係を使用して。
- リアルタイムクエリを統合しました (ライブクエリ)即時データ更新のため。
- セキュリティ対策を適用しました ACLとCLPを使用してデータアクセスを保護および管理。
- クラウドコードを実装しました サーバー側でカスタムビジネスロジックを実行するための関数。
- ユーザー認証を設定しました メール確認とパスワードリセットをサポート。
- ファイルのアップロードを管理しました オプションのファイルセキュリティコントロール付き。
- クラウドジョブをスケジュールしました 自動化されたバックグラウンドタスクのため。
- Webhookを使用しました 外部サービスとの統合のため。
- Back4app管理パネルを探求しました データ管理のため。
堅牢なNodeJS基盤と強力なBack4appバックエンドを持つことで、機能豊富でスケーラブルかつ安全なアプリケーションを開発するための準備が整いました。より高度な機能を探求し、ビジネスロジックを統合し、Back4appの力を活用してサーバーとデータベースの管理にかかる無数の時間を節約してください。コーディングを楽しんでください!
- 本番環境に適したNodeJSアプリを構築する このバックエンドを拡張して、より複雑なデータモデル、キャッシング戦略、パフォーマンス最適化を処理します。
- 高度な機能を統合する 特化した認証フロー、役割ベースのアクセス制御、または外部API(支払いゲートウェイなど)を含みます。
- Back4appの公式ドキュメントをチェックする 高度なセキュリティ、パフォーマンス調整、ログ分析についての詳細な情報を得るために。
- 他のチュートリアルを探る リアルタイムチャットアプリケーション、IoTダッシュボード、または位置情報サービスに関するものです。ここで学んだ技術をサードパーティのAPIと組み合わせて、複雑な実世界のアプリケーションを作成できます。