Quickstarters
Feature Overview
How to Build a Backend for NodeJS?
46 分
イントロダクション このチュートリアルでは、back4appを使用してnodejsアプリケーションの完全なバックエンドを構築する方法を学びます。 データベース管理、cloud code functions、restおよびgraphql api、ユーザー認証、リアルタイムクエリ(ライブクエリ)など、back4appの重要な機能を統合する方法を説明し、nodejsコードとシームレスに通信する安全でスケーラブル、かつ堅牢なバックエンドを作成します。 また、back4appの迅速なセットアップと直感的な環境が、サーバーやデータベースを手動で構成するのに比べて、時間と労力を大幅に削減できることを確認します。 その過程で、高度なセキュリティ機能、cloud jobsを使用したタスクのスケジューリング、外部統合のためのwebhookの設定など、主要な機能に関する実践的な経験を得ることができます。 このチュートリアルの終わりまでには、この基本的なセットアップを本番環境に適したアプリケーションに拡張する準備が整い、必要に応じてカスタムロジックやサードパーティapiを簡単に組み込むことができるようになります。 前提条件 このチュートリアルを完了するには、次のものが必要です back4appアカウントと新しいback4appプロジェクト back4appの始め方。 https //www back4app com/docs/get started/new parse app アカウントをお持ちでない場合は、無料で作成できます。上記のガイドに従ってプロジェクトを準備してください。 node js(バージョン14以上)がインストールされていること npmパッケージをインストールし、バックエンドサーバーを実行するためにnode jsが必要です。 node jsのインストール https //nodejs org/en/download/ 基本的なnodejsのセットアップ npm init (または yarn init )を実行してnodeプロジェクトを初期化できます。依存関係を管理するためにpackage jsonファイルが必要です。 javascriptと基本的なnodejsの概念に精通していること nodejs公式ドキュメント。 https //nodejs org/en/docs/ nodeに不慣れな場合は、開始する前に公式ドキュメントや初心者向けのチュートリアルを確認してください。 始める前に、これらの前提条件がすべて整っていることを確認してください。back4appプロジェクトを設定し、ローカルのnodejs環境を準備しておくことで、より簡単に進めることができます。 ステップ1 – back4appプロジェクトの設定 新しいプロジェクトを作成する back4app上でnodejsバックエンドを構築する最初のステップは、新しいプロジェクトを作成することです。まだ作成していない場合は、次の手順に従ってください back4appアカウントにログインする 「新しいアプリ」ボタンをクリックする あなたのback4appダッシュボードで。 アプリに名前を付ける (例:「nodejs バックエンド チュートリアル」)。 プロジェクトが作成されると、あなたのback4appダッシュボードにリストされます。このプロジェクトは、このチュートリアルで説明するすべてのバックエンド設定の基盤となります。 parse sdkを接続する back4appは、データを管理し、リアルタイム機能を提供し、ユーザー認証を処理するためにparseプラットフォームに依存しています。nodejsアプリケーションをback4appに接続するには、parse npmパッケージをインストールし、back4appダッシュボードの資格情報で初期化する必要があります。 parseキーを取得する back4appダッシュボードで、アプリの「アプリ設定」または「セキュリティとキー」セクションに移動して、あなたの アプリケーションid と javascriptキー を見つけてください。 parseサーバーurl も見つかります(通常は https //parseapi back4app com の形式です)。 parse sdkをインストールする あなたのnodejsプロジェクトに npm install parse yarnを使用している場合は、次のようにインストールできます yarn add parse nodejsアプリケーションでparseを初期化する ファイルを作成します(例: parseconfig js )、nodeプロジェクトのルートに配置します src/parseconfig js const parse = require('parse/node'); // replace the placeholders with your back4app credentials parse initialize('your application id', 'your javascript key'); parse serverurl = 'https //parseapi back4app com'; module exports = parse; 次に、メインエントリーファイル(例: index js )でparseをインポートして接続を確立します const parse = require(' /src/parseconfig'); // your nodejs logic here, now fully connected to back4app このステップを完了することで、nodejsバックエンドとback4appインフラストラクチャの間に安全な接続が確立されました。すべてのリクエストとデータトランザクションは、このsdkを通じて安全にルーティングされ、手動のrestまたはgraphql呼び出しの複雑さが軽減されます(必要に応じてそれらを使用することもできます)。 ステップ2 – データベースの設定 データの保存とクエリ back4appプロジェクトが設定され、parse sdkがnodeアプリに統合されたので、データの保存と取得を開始できます。レコードを作成する最も簡単な方法は、 parse object クラスを使用することです // example create a todo item const parse = require(' /src/parseconfig'); async function createtodoitem(title, iscompleted) { const todo = parse object extend('todo'); const todo = new todo(); todo set('title', title); todo set('iscompleted', iscompleted); try { const savedtodo = await todo save(); console log('todo saved successfully ', savedtodo); return savedtodo; } catch (error) { console error('error saving todo ', error); } } // example query all todo items async function fetchtodos() { const todo = parse object extend('todo'); const query = new parse query(todo); try { const results = await query find(); console log('fetched todo items ', results); return results; } catch (error) { console error('error fetching todos ', error); } } また、back4appのrest apiエンドポイントを使用できます curl x post \\ h "x parse application id your application id" \\ h "x parse rest api key your rest api key" \\ h "content type application/json" \\ d '{"title" "buy groceries", "iscompleted" false}' \\ https //parseapi back4app com/classes/todo back4appはgraphqlインターフェースも提供しています mutation { createtodo(input { fields { title "clean the house" iscompleted false } }) { todo { objectid title iscompleted } } } これらの多様なオプションにより、parse sdk、rest、またはgraphqlを通じて、開発プロセスに最適な方法でデータ操作を統合できます。 スキーマ設計とデータ型 デフォルトでは、parseは スキーマを動的に作成することを許可します , ただし、より多くの制御のためにback4appダッシュボードでクラスとデータ型を定義することもできます。 back4appダッシュボードの「データベース」セクションに移動します 。 新しいクラスを作成します (例:「todo」)を作成し、タイトル(string)やiscompleted(boolean)などの関連する列を追加します。 back4appはさまざまなデータ型もサポートしています string , number , boolean , object , date , file , pointer , array , relation , geopoint , そして polygon 各フィールドに適切な型を選択できます。希望する場合は、nodeアプリからオブジェクトを最初に保存するときにparseが自動的にこれらの列を作成することもできます。 back4appは、データモデルの設計を手助けするaiエージェントを提供しています。 aiエージェントを開く アプリダッシュボードまたはメニューから。 データモデルを説明する 簡単な言葉で(例:「新しいtodoアプリをback4appで完全なクラススキーマで作成してください。」)。 aiエージェントにスキーマを作成させる aiエージェントを使用すると、データアーキテクチャの設定時に時間を節約し、アプリケーション全体で一貫性を確保できます。 リレーショナルデータ リレーショナルデータがある場合、例えば、複数の todo アイテムを指す category オブジェクトがある場合、parseで pointers または relations を使用できます。例えば、 category へのポインタを追加することができます。 リアルタイムの更新のために、back4appは live queries を提供しています。nodejsアプリでは、特定のクラスの変更にサブスクライブできます live queriesを有効にする には、back4appダッシュボードのアプリの サーバー設定 で行います。「live queries」がオンになっていることを確認してください。 live queryサブスクリプションを初期化する には、コード内で src/parseconfig js const parse = require('parse/node'); // replace the placeholders with your back4app credentials parse initialize('your application id', 'your javascript key'); parse serverurl = 'https //parseapi back4app com'; // live query's subdomain parse livequeryserverurl = 'wss\ //your subdomain here b4a io'; module exports = parse;const parse = require(' /parseconfig'); async function subscribetotodos(callback) { const query = new parse query('todo'); const subscription = await query subscribe(); subscription on('create', (newtodo) => { console log('new todo created ', newtodo); callback('create', newtodo); }); subscription on('update', (updatedtodo) => { console log('todo updated ', updatedtodo); callback('update', updatedtodo); }); subscription on('delete', (deletedtodo) => { console log('todo deleted ', deletedtodo); callback('delete', deletedtodo); }); return subscription; } サブスクライブすることで、新しいtodoが作成、更新、または削除されるたびにリアルタイム通知を受け取ります。この機能は、複数のユーザーが最新のデータを手動でサーバーにポーリングすることなく見る必要があるコラボレーティブまたはダイナミックなアプリに特に価値があります。 ステップ3 – aclとclpによるセキュリティの適用 back4appのセキュリティメカニズム back4appは、 アクセス制御リスト(acl) と クラスレベルの権限(clp) を提供することで、セキュリティを真剣に考えています。これらの機能により、オブジェクトまたはクラスごとにデータの読み取りまたは書き込みを行うことができるユーザーを制限し、認可されたユーザーのみがデータを変更できるようにします。 アクセス制御リスト(acl) aclは、個々のオブジェクトに適用され、どのユーザー、役割、または一般の人々が読み取り/書き込み操作を行うことができるかを決定します。例えば async function createprivatetodo(title, owneruser) { const todo = parse object extend('todo'); const todo = new todo(); todo set('title', title); // create an acl granting read/write access only to the owner const acl = new parse acl(owneruser); acl setpublicreadaccess(false); acl setpublicwriteaccess(false); todo setacl(acl); try { return await todo save(); } catch (err) { console error('error saving private todo ', err); } } オブジェクトを保存すると、指定されたユーザー以外の誰も読み取りまたは変更できないaclがあります。 クラスレベルの権限 (clp) clpは クラス全体のデフォルトの権限を管理します。たとえば、クラスが公開されているか書き込み可能か、または特定の役割のみがアクセスできるかどうかです。 back4appダッシュボードに移動 , アプリを選択し、 データベース セクションを開きます。 クラスを選択 (例:「todo」)。 クラスレベルの権限 タブを開きます。 デフォルトを設定します。たとえば、読み取りまたは書き込みの「認証が必要」や、一般公開の「アクセス不可」などです。 これらの権限は基本を設定し、aclは個々のオブジェクトの権限を微調整します。堅牢なセキュリティモデルは通常、clp(広範な制限)とacl(オブジェクトごとの細かい制限)を組み合わせます。詳細については、 アプリセキュリティガイドライン。 ステップ4 – クラウドファンクションの作成とデプロイ cloud codeは、サーバー側でカスタムjavascriptコードを実行できるparse server環境の機能です。サーバーやインフラを管理する必要なく、cloud codeを書くことで、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 できます。 // main js // 1 import necessary modules and other cloud code files const axios = require('axios'); // 2 define a custom cloud function parse cloud define('fetchexternaldata', async (request) => { const url = request params url; if (!url) { throw new error('url parameter is required'); } const response = await axios get(url); return response data; }); // 3 example of a beforesave trigger parse cloud beforesave('todo', (request) => { const todo = request object; if (!todo get('title')) { throw new error('todo must have a title'); } }); npmモジュールをインストールして使用する能力により、cloud codeは非常に柔軟になり、外部apiとの統合、データ変換の実行、または複雑なサーバーサイドロジックの実行が可能になります。 典型的な使用例 ビジネスロジック 例えば、複数のオブジェクトプロパティを集約してゲーム内のユーザーのスコアを計算し、そのデータを自動的に保存することができます。 データ検証 レコードを保存または削除する前に、特定のフィールドが存在することやユーザーが正しい権限を持っていることを確認します。 トリガー データが変更されたときにアクションを実行します(例:ユーザーがプロフィールを更新したときに通知を送信)。 統合 サードパーティのapiやサービスと接続します。例えば、cloud codeから直接支払いゲートウェイ、slack通知、またはメールマーケティングプラットフォームと統合することができます。 セキュリティ強化 cloud code関数内で入力パラメータを検証およびサニタイズすることで、追加のセキュリティ層を追加します。 関数をデプロイする 以下は、クライアントから送信されたテキスト文字列の長さを計算するシンプルなcloud code関数です。 main js // main js parse cloud define('calculatetextlength', async (request) => { const { text } = request params; if (!text) { throw new error('no text provided'); } return { length text length }; }); デプロイするには、 back4app cli 1 cliをインストールする: linux/macosの場合 curl https //raw\ githubusercontent com/back4app/parse cli/back4app/installer sh | sudo /bin/bash windowsの場合 からファイルをダウンロードします。 b4a exe リリースページ https //github com/back4app/parse cli/releases から。 2 アカウントキーを設定する b4a configure accountkey 3 クラウドコードをデプロイする: b4a deploy ダッシュボードを通じてデプロイする アプリのダッシュボードで、 クラウドコード > 関数 に移動します。 関数を main js エディタにコピー/ペーストします。 「 デプロイ 」をクリックします。 関数の呼び出し parse sdkを使用したnodejsコードから const parse = require(' /parseconfig'); async function gettextlength(text) { try { const result = await parse cloud run('calculatetextlength', { text }); console log('text length ', result length); } catch (err) { console error('error calling cloud function ', err); } } rest経由でも呼び出すことができます curl x post \\ h "x parse application id your app id" \\ h "x parse rest api key your rest api key" \\ h "content type application/json" \\ d '{"text" "hello back4app"}' \\ https //parseapi back4app com/functions/calculatetextlength またはgraphql経由で mutation { calculatetextlength(input { text "hello graphql" }) { result } } この柔軟性により、nodejs環境の任意の部分やrestまたはgraphqlをサポートする他のクライアントにカスタムロジックを統合することができます。 ステップ5 – ユーザー認証の設定 back4appにおけるユーザー認証 back4appは、 parse user クラスを認証の基盤として活用しています。デフォルトでは、parseはパスワードのハッシュ化、セッショントークン、セキュアストレージを処理します。これは、複雑なセキュリティフローを手動で設定する必要がないことを意味します。 ユーザー認証の設定 nodejs環境では、新しいユーザーを次のように作成できます const parse = require(' /parseconfig'); async function signupuser(username, password, email) { const user = new parse user(); user set('username', username); user set('password', password); user set('email', email); try { await user signup(); console log('user signed up successfully!'); } catch (error) { console error('error signing up user ', error); } } 既存のユーザーでログイン async function loginuser(username, password) { try { const user = await parse user login(username, password); console log('user logged in ', user); } catch (error) { console error('error logging in user ', error); } } rest経由でのログインは次のようになります curl x get \\ h "x parse application id your app id" \\ h "x parse rest api key your rest api key" \\ g \\ \ data urlencode 'username=alice' \\ \ data urlencode 'password=secret123' \\ https //parseapi back4app com/login セッション管理 ログインに成功すると、parseは セッショントークン を作成し、ユーザーオブジェクトに保存します。nodeコード内では、アプリケーションロジックでセッションを維持している場合、現在ログインしているユーザーにアクセスできます const currentuser = parse user current(); if (currentuser) { console log('currently logged in user ', currentuser getusername()); } else { console log('no user is logged in'); } parseは自動的にトークンベースのセッションをバックグラウンドで処理しますが、手動で管理または取り消すこともできます。ログアウトするには await parse user logout(); ソーシャルログイン統合 back4appとparseは、追加のパッケージをインストールするか、既存のアダプターを使用することで、 google や facebook などの人気のoauthプロバイダーと統合できます。たとえば、 facebook app id を設定し、 parse facebookutils login() を使用することで、facebookログインを設定できます。詳細な手順は異なるため、 ソーシャルログインのドキュメント。 https //www back4app com/docs/platform/sign in with apple const facebooklogin = async () => { try { const user = await parse facebookutils login('email'); console log(user existed() ? 'user logged in' 'user signed up and logged in'); } catch (error) { console error('error logging in with facebook ', error); } }; メール認証とパスワードリセット メール認証とパスワードリセットを有効にするには back4appダッシュボードの メール設定 に移動します。 メール認証を有効にする ことで、新しいユーザーがメールアドレスの所有権を確認できるようにします。 送信元アドレスを設定する , メールテンプレート、および必要に応じてカスタムドメインを設定します。 これらの機能は、ユーザーのメールの所有権を検証し、安全なパスワード回復方法を提供することで、アカウントのセキュリティとユーザーエクスペリエンスを向上させます。 ステップ6 – ファイルストレージの取り扱い ファイルのアップロードと取得 parseには、back4appが安全に保存するファイルアップロードを処理するための parse file クラスが含まれています const parse = require(' /parseconfig'); async function uploadimage(filepath) { // filepath is the path to your file on the server const fs = require('fs'); const filedata = fs readfilesync(filepath); const filename = filepath split('/') pop() || 'upload png'; const parsefile = new parse file(filename, array from(filedata)); try { const savedfile = await parsefile save(); console log('file saved ', savedfile url()); return savedfile url(); } catch (err) { console error('error uploading file ', err); } } データベース内のオブジェクトにファイルを添付するには、次のようにします async function createphotoobject(filepath) { const photo = parse object extend('photo'); const photo = new photo(); const fs = require('fs'); const filedata = fs readfilesync(filepath); const filename = filepath split('/') pop() || 'upload png'; const parsefile = new parse file(filename, array from(filedata)); photo set('imagefile', parsefile); return await photo save(); } ファイルのurlを取得するのは簡単です const imagefile = photo get('imagefile'); const imageurl = imagefile url(); ファイルのセキュリティ parse serverは、ファイルアップロードのセキュリティを管理するための柔軟な設定を提供します。以下の例は、誰がサーバーにファイルをアップロードできるかを制御するための権限を設定する方法を示しています enableforpublic trueに設定すると、認証状況に関係なく、誰でもファイルをアップロードできるようになります。 enableforanonymoususer サインアップしていない匿名ユーザーがファイルをアップロードできるかどうかを制御します。 enableforauthenticateduser 認証されたユーザーのみがファイルをアップロードできるかどうかを指定します。これは、信頼できるユーザーのみがこの機能にアクセスできるようにするために理想的です。 ステップ 7 – クラウドジョブを使用したタスクのスケジューリング クラウドジョブ クラウドジョブ はback4appでバックエンド上のルーチン作業をスケジュールして実行することができます 古いデータのクリーンアップや毎日の要約メールの送信など。典型的なクラウドジョブは次のようになります // main js parse cloud job('cleanupoldtodos', async (request) => { // this runs in the background, not triggered by a direct user request const todo = parse object extend('todo'); const query = new parse query(todo); // for example, remove todos older than 30 days const now = new date(); const thirty days = 30 24 60 60 1000; const cutoff = new date(now thirty days); query lessthan('createdat', cutoff); try { const oldtodos = await query find({ usemasterkey true }); await parse object destroyall(oldtodos, { usemasterkey true }); return `deleted ${oldtodos length} old todos `; } catch (err) { throw new error('error during cleanup ' + err message); } }); クラウドコードをデプロイする 新しいジョブと共に(cliまたはダッシュボード経由で)。 back4appダッシュボードに移動する > アプリ設定 > サーバー設定 > バックグラウンドジョブ ジョブをスケジュールする 毎日またはニーズに合った間隔で実行されるように。 クラウドジョブは、バックグラウンドメンテナンスやその他の定期的なプロセスを自動化することを可能にします 手動の介入を必要とせずに。 ステップ8 – webhookの統合 webhook は、特定のイベントが発生するたびに、back4appアプリが外部サービスにhttpリクエストを送信できるようにします。これは、決済ゲートウェイ(例:stripe)、メールマーケティングツール、または分析プラットフォームなどのサードパーティシステムとの統合に強力です。 webhook設定に移動 し、back4appダッシュボード > その他 > webhooksを選択し、次にwebhookを追加をクリックします。 エンドポイントを設定 (例: https //your external service com/webhook endpoint https //your external service com/webhook endpoint )。 トリガーを設定 して、back4appのクラスやcloud code関数内のどのイベントがwebhookを発火させるかを指定します。 例えば、新しいtodoが作成されるたびにslackチャンネルに通知したい場合: 受信ウェブフックを受け入れるslackアプリを作成します。 slackのウェブフックurlをコピーします。 back4appダッシュボードで、「todoクラスの新しいレコード」イベントのためにそのslack urlをエンドポイントとして設定します。 必要に応じてカスタムhttpヘッダーやペイロードを追加することもできます。 cloud codeで、beforesaveやaftersaveのトリガーでカスタムhttpリクエストを行うことでwebhooksを定義することもできます。 ステップ9 – back4app管理パネルの探索 「 back4app管理アプリ 」は、非技術的なユーザーがcrud操作を行い、コードを書くことなく日常的なデータタスクを処理するために設計されたウェブベースの管理インターフェースです。これは、「 モデル中心 」で、「 ユーザーフレンドリー 」なインターフェースを提供し、データベース管理、カスタムデータ管理、エンタープライズレベルの操作を効率化します。 管理アプリの有効化 「 管理アプリ 」を有効にするには、「 アプリダッシュボード > その他 > 管理アプリ 」に移動し、「管理アプリを有効にする」ボタンをクリックします。 最初の管理ユーザーを作成します (ユーザー名/パスワード)、これにより新しい役割(b4aadminuser)とクラス(b4asetting、b4amenuitem、b4acustomfield)がアプリのスキーマに自動的に生成されます。 管理インターフェースにアクセスするためのサブドメインを選択し、セットアップを完了します。 ログイン 新しい管理アプリのダッシュボードにアクセスするために作成した管理者資格情報を使用してください。 有効にすると、back4app管理アプリを使用して、データベースのレコードを簡単に表示、編集、または削除できます parseダッシュボードやバックエンドコードを直接使用する必要はありません。設定可能なアクセス制御を使用することで、データを管理するための明確でポイントアンドクリックの方法が必要なチームメンバーやクライアントとこのインターフェースを安全に共有できます。 結論 この包括的なチュートリアルに従うことで、あなたは 安全なバックエンドを作成しました back4app上のnodejsアプリ用。 データベースを構成しました クラススキーマ、データ型、関係を使用して。 リアルタイムクエリを統合しました (ライブクエリ)即時データ更新のため。 セキュリティ対策を適用しました aclとclpを使用してデータアクセスを保護および管理。 クラウドコードを実装しました サーバー側でカスタムビジネスロジックを実行するための関数。 ユーザー認証を設定しました メール確認とパスワードリセットをサポート。 ファイルのアップロードを管理しました および取得、オプションのファイルセキュリティコントロール付き。 クラウドジョブをスケジュールしました 自動化されたバックグラウンドタスクのため。 webhookを使用しました 外部サービスとの統合のため。 back4app管理パネルを探索しました データ管理のため。 堅牢なnodejs基盤と強力なback4appバックエンドを持つことで、機能豊富でスケーラブルかつ安全なアプリケーションを開発するための準備が整いました。より高度な機能を探求し、ビジネスロジックを統合し、back4appの力を活用してサーバーとデータベースの管理にかかる無数の時間を節約してください。コーディングを楽しんでください! 次のステップ 本番環境向けのnodejsアプリを構築する このバックエンドを拡張して、より複雑なデータモデル、キャッシング戦略、パフォーマンス最適化を処理します。 高度な機能を統合する 特化した認証フロー、役割ベースのアクセス制御、または外部api(支払いゲートウェイなど)を含みます。 back4appの公式ドキュメントをチェックする 高度なセキュリティ、パフォーマンス調整、ログ分析についての詳細な情報を得るために。 他のチュートリアルを探る リアルタイムチャットアプリケーション、iotダッシュボード、または位置情報サービスに関するものです。ここで学んだ技術をサードパーティのapiと組み合わせて、複雑な実世界のアプリケーションを作成できます。