Быстрые стартеры

Как создать бэкенд для NodeJS?

52min

Введение

В этом учебном пособии вы научитесь создавать полный бэкенд для приложения NodeJS с использованием Back4app.

Мы пройдем через интеграцию основных функций Back4app - таких как управление базами данных, функции Cloud Code, REST и GraphQL API, аутентификация пользователей и запросы в реальном времени (Live Queries) - чтобы создать безопасный, масштабируемый и надежный бэкенд, который бесшовно взаимодействует с вашим кодом NodeJS.

Вы также увидите, как быстрая настройка и интуитивно понятная среда Back4app могут значительно сократить время и усилия по сравнению с ручной настройкой серверов и баз данных.

В процессе вы получите практический опыт работы с ключевыми функциональными возможностями, включая расширенные функции безопасности, планирование задач с помощью Cloud Jobs и настройку вебхуков для внешних интеграций.

К концу этого учебного пособия вы будете хорошо подготовлены, чтобы улучшить эту базовую настройку до готового к производству приложения или легко интегрировать пользовательскую логику и сторонние API по мере необходимости.

Предварительные требования

Чтобы завершить этот учебник, вам потребуется:

  • Аккаунт Back4app и новый проект Back4app Начало работы с Back4app. Если у вас нет аккаунта, вы можете создать его бесплатно. Следуйте приведенному выше руководству, чтобы подготовить ваш проект.
  • Установленный Node.js (версия 14 или выше) Вам потребуется Node.js для установки npm пакетов и запуска вашего серверного приложения. Установка Node.js
  • Базовая настройка NodeJS Вы можете инициализировать проект Node, запустив npm init (или yarn init). Убедитесь, что у вас есть файл package.json для управления вашими зависимостями.
  • Знание JavaScript и основных концепций NodeJS Официальная документация NodeJS. Если вы новичок в Node, ознакомьтесь с официальной документацией или учебником для начинающих перед началом.

Убедитесь, что у вас есть все эти предварительные требования перед началом. Наличие настроенного проекта Back4app и готовой локальной среды NodeJS поможет вам легче следовать инструкциям.

Шаг 1 – Настройка проекта Back4app

Создание нового проекта

Первый шаг в создании вашего NodeJS бэкенда на Back4app — это создание нового проекта. Если вы еще не создали его, выполните следующие шаги:

  1. Войдите в свою учетную запись Back4app.
  2. Нажмите кнопку “Новое приложение” в вашей панели управления Back4app.
  3. Дайте вашему приложению имя (например, “NodeJS-Backend-Tutorial”).
Document image


После создания проекта вы увидите его в списке на вашей панели управления Back4app. Этот проект станет основой для всех конфигураций бэкенда, обсуждаемых в этом руководстве.

Подключите Parse SDK

Back4app использует платформу Parse для управления вашими данными, предоставления функций в реальном времени, обработки аутентификации пользователей и многого другого. Подключение вашего приложения NodeJS к Back4app включает установку пакета parse npm и его инициализацию с учетными данными из вашей панели управления Back4app.

Получите ваши ключи Parse: В вашей панели управления Back4app перейдите в раздел “Настройки приложения” или “Безопасность и ключи”, чтобы найти ваш ID приложения и JavaScript ключ. Вы также найдете URL сервера Parse (часто в формате https://parseapi.back4app.com).

Document image


Установите Parse SDK в вашем проекте NodeJS:

Bash


Если вы используете Yarn, вы можете установить его с помощью:

Bash


Инициализируйте Parse в вашем приложении NodeJS:

Создайте файл (например, parseConfig.js) в корне вашего проекта Node:

src/parseConfig.js


Затем в вашем основном файле (например, index.js) импортируйте Parse для установления соединения:

JS


Завершив этот шаг, вы установили безопасное соединение между вашим бэкендом NodeJS и инфраструктурой Back4app. Все запросы и транзакции данных безопасно маршрутизируются через этот SDK, что снижает сложность ручных вызовов REST или GraphQL (хотя вы все равно можете использовать их при необходимости).

Шаг 2 – Настройка базы данных

Сохранение и запрос данных

С вашим проектом Back4app настроенным и SDK Parse интегрированным в ваше приложение Node, вы теперь можете начать сохранять и извлекать данные. Самый простой способ создать запись – использовать класс Parse.Object :

JS


Завершив этот шаг, вы установили безопасное соединение между вашим бэкендом NodeJS и инфраструктурой Back4app. Все запросы и транзакции данных безопасно маршрутизируются через этот SDK, что снижает сложность ручных вызовов REST или GraphQL (хотя вы все равно можете использовать их при необходимости).

В качестве альтернативы вы можете использовать REST API-эндпоинты Back4app:

Curl


Back4app также предоставляет интерфейс GraphQL:

GraphQL


Эти разнообразные варианты позволяют вам интегрировать операции с данными так, как это лучше всего подходит вашему процессу разработки - будь то через Parse SDK, REST или GraphQL.

Проектирование схемы и типы данных

По умолчанию Parse позволяет создавать схемы на лету, но вы также можете определить свои классы и типы данных в панели управления Back4app для большего контроля.

  1. Перейдите в раздел “База данных” в вашей панели управления Back4app.
  2. Создайте новый класс (например, “Todo”) и добавьте соответствующие столбцы, такие как title (String) и isCompleted (Boolean).
Создать новый класс
Создать новый класс


Back4app также поддерживает различные типы данных: String, Number, Boolean, Object, Date, File, Pointer, Array, Relation, GeoPoint, и Polygon. Вы можете выбрать подходящий тип для каждого поля. Если вы предпочитаете, вы также можете позволить Parse автоматически создать эти столбцы, когда вы впервые сохраняете объект из вашего Node-приложения.

Создать столбец
Создать столбец


Back4app предлагает AI-агента, который может помочь вам разработать вашу модель данных:

  1. Откройте AI-агента из вашей панели управления приложением или в меню.
  2. Опишите вашу модель данных простым языком (например, “Пожалуйста, создайте новое приложение ToDo на back4app с полной схемой класса.”).
  3. Позвольте AI-агенту создать схему для вас.
Document image


Использование AI-агента может сэкономить ваше время при настройке вашей архитектуры данных и обеспечить согласованность в вашем приложении.

Реляционные данные

Если у вас есть реляционные данные - скажем, объект Категория который указывает на несколько Задач - вы можете использовать Указатели или Связи в Parse. Например, добавление указателя на Категорию:

JS


Когда вы выполняете запрос, вы также можете включить данные указателя:

JS


Этот include('category') вызов извлекает детали категории вместе с каждой задачей, делая ваши реляционные данные легко доступными.

Живые запросы

Для получения обновлений в реальном времени Back4app предоставляет Live Queries. В вашем приложении NodeJS вы можете подписаться на изменения в конкретном классе:

  1. Включите Live Queries в вашей панели управления Back4app в разделе Настройки сервера. Убедитесь, что «Live Queries» включены.
  2. Инициализируйте подписку на Live Query в вашем коде:
src/parseConfig.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 – Написание и развертывание облачных функций

Облачный код – это функция среды Parse Server, которая позволяет вам запускать пользовательский JavaScript код на стороне сервера - без необходимости управлять вашими серверами или инфраструктурой. Написав облачный код, вы можете расширить ваш бэкенд Back4app дополнительной бизнес-логикой, валидациями, триггерами и интеграциями, которые работают безопасно и эффективно на Parse Server.

Как это работает

Когда вы пишете Cloud Code, вы обычно размещаете свои функции JavaScript, триггеры и любые необходимые модули NPM в main.js (или в другой JS файл) и развертываете его в своем проекте Back4app. Этот код затем выполняется в среде Parse Server. Поскольку эти функции и триггеры работают на сервере, вы можете доверять им обработку конфиденциальной логики, обработку чувствительных данных или выполнение API-вызовов только для бэкенда - процессов, которые вы, возможно, не хотите открывать напрямую клиенту.

Весь Cloud Code для вашего приложения Back4app работает внутри Parse Server, который управляется Back4app, поэтому вам не нужно беспокоиться о техническом обслуживании сервера, масштабировании или предоставлении ресурсов. Каждый раз, когда вы обновляете и развертываете свой файл, работающий Parse Server обновляется с вашим последним кодом.

Структура файла main.js Типичный main.js может содержать:

  1. Заявления о Require для любых необходимых модулей (пакеты NPM, встроенные модули Node или другие файлы облачного кода).
  2. Определения облачных функций с использованием Parse.Cloud.define().
  3. Триггеры такие как Parse.Cloud.beforeSave(), Parse.Cloud.afterSave(), и т.д.
  4. Модули NPM которые вы установили (если необходимо). Например, вы можете установить пакет, такой как axios для выполнения HTTP-запросов. Затем вы можете require его в верхней части вашего файла.
JS


С возможностью установки и использования модулей NPM, Cloud Code становится невероятно гибким, позволяя вам интегрироваться с внешними API, выполнять преобразования данных или выполнять сложную серверную логику.

Типичные случаи использования

  • Бизнес-логика: Например, вы можете рассчитать балл пользователя в игре, агрегируя несколько свойств объектов, а затем автоматически сохранять эти данные.
  • Проверка данных: Убедитесь, что определенные поля присутствуют или что у пользователя есть правильные разрешения перед сохранением или удалением записи.
  • Триггеры: Выполняйте действия, когда данные изменяются (например, отправляйте уведомление, когда пользователь обновляет свой профиль).
  • Интеграции: Подключайтесь к сторонним API или сервисам. Например, вы можете интегрироваться с платежными шлюзами, уведомлениями Slack или платформами email-маркетинга напрямую из Cloud Code.
  • Обеспечение безопасности: Добавьте дополнительный уровень безопасности, проверяя и очищая входные параметры в ваших функциях Cloud Code.

Разверните вашу функцию

Ниже приведена простая функция Cloud Code, которая вычисляет длину текстовой строки, отправленной с клиента:

main.js


Развертывание через Back4app CLI:

1 - Установите CLI:

  • Для Linux/MacOS:
Bash

Bash


3 - Разверните ваш облачный код:

Bash


Развертывание через Панель управления:

  1. В панели управления вашего приложения перейдите в Облачный код > Функции.
  2. Скопируйте/вставьте функцию в редактор main.js.
  3. Нажмите Развернуть.
Document image


Вызов вашей функции

Из вашего кода NodeJS с использованием Parse SDK:

JS


Вы также можете вызвать его через REST:

Curl


Или через GraphQL:

GraphQL


Эта гибкость позволяет вам интегрировать вашу пользовательскую логику в любую часть вашей среды NodeJS или других клиентов, которые поддерживают REST или GraphQL.

Шаг 5 – Настройка аутентификации пользователей

Аутентификация пользователей в Back4app

Back4app использует класс Parse User в качестве основы для аутентификации. По умолчанию Parse обрабатывает хеширование паролей, токены сессий и безопасное хранение. Это означает, что вам не нужно вручную настраивать сложные потоки безопасности.

Настройка аутентификации пользователей

В среде NodeJS вы можете создать нового пользователя с помощью:

JS


Войдите в систему как существующий пользователь:

JS


Через REST вход может выглядеть так:

Bash


Управление сессиями

После успешного входа в систему Parse создает токен сессии который хранится в объекте пользователя. В вашем коде Node вы можете получить доступ к текущему вошедшему пользователю, если вы поддерживаете сессии в логике вашего приложения:

JS


Parse автоматически обрабатывает сессии на основе токенов в фоновом режиме, но вы также можете вручную управлять ими или аннулировать. Для выхода из системы:

JS


Интеграция социального входа

Back4app и Parse могут интегрироваться с популярными провайдерами OAuth, такими как Google или Facebook, установив дополнительные пакеты или используя существующие адаптеры. Например, вы можете настроить вход через Facebook, настроив свой Facebook App ID и используя Parse.FacebookUtils.logIn(). Подробные инструкции могут различаться, поэтому обратитесь к Документации по социальному входу.

JS


Подтверждение электронной почты и сброс пароля

Чтобы включить подтверждение электронной почты и сброс пароля:

  1. Перейдите в настройки электронной почты в вашей панели управления Back4app.
  2. Включите подтверждение электронной почты для обеспечения проверки новых пользователей на владение их адресами электронной почты.
  3. Настройте адрес отправителя, шаблоны электронной почты и ваш собственный домен, если это необходимо.

Эти функции улучшают безопасность учетной записи и пользовательский опыт, проверяя право собственности пользователей на электронные адреса и предоставляя безопасный метод восстановления пароля.

Шаг 6 – Управление хранилищем файлов

Загрузка и получение файлов

Парс включает класс Parse.File для обработки загрузки файлов, которые Back4app хранит безопасно:

JS


Чтобы прикрепить файл к объекту в базе данных, вы можете сделать:

JS


Получение URL файла очень просто:

JS


Безопасность файлов

Parse Server предоставляет гибкие настройки для управления безопасностью загрузки файлов. Следующий пример показывает, как вы можете установить разрешения для контроля того, кто может загружать файлы на сервер:

{ "fileUpload": { "enableForPublic": true, "enableForAnonymousUser": true, "enableForAuthenticatedUser": true } }

  • enableForPublic: Если установлено в true, позволяет любому, независимо от статуса аутентификации, загружать файлы.
  • enableForAnonymousUser: Контролирует, могут ли анонимные пользователи (не зарегистрированные) загружать файлы.
  • enableForAuthenticatedUser: Указывает, могут ли загружать файлы только аутентифицированные пользователи. Это идеально подходит для обеспечения того, чтобы только доверенные пользователи имели доступ к этой функции.

Шаг 7 – Планирование задач с помощью облачных заданий

Облачные задания

Облачные задания в Back4app позволяют вам планировать и выполнять рутинные задачи на вашем сервере - такие как очистка старых данных или отправка ежедневного сводного отчета по электронной почте. Типичное облачное задание может выглядеть так:

JS

  1. Разверните ваш облачный код с новым заданием (через CLI или панель управления).
  2. Перейдите в панель управления Back4app > Настройки приложения > Настройки сервера > Фоновые задания.
  3. Запланируйте выполнение задания ежедневно или с любым другим интервалом, который вам подходит.
Планирование облачного задания
Планирование облачного задания


Облачные задания позволяют вам автоматизировать фоновое обслуживание или другие периодические процессы - без необходимости ручного вмешательства.

Шаг 8 – Интеграция вебхуков

Вебхуки позволяют вашему приложению Back4app отправлять HTTP-запросы на внешний сервис, когда происходят определенные события. Это мощный инструмент для интеграции с системами третьих сторон, такими как платежные шлюзы (например, Stripe), инструменты email-маркетинга или аналитические платформы.

  1. Перейдите к настройкам вебхуков в вашей панели управления Back4app > Дополнительно > Вебхуки, а затем нажмите на Добавить вебхук.
  2. Настройте конечную точку (например, https://your-external-service.com/webhook-endpoint).
  3. Настройте триггеры для указания, какие события в ваших классах Back4app или функциях Cloud Code будут вызывать вебхук.
Добавление вебхука
Добавление вебхука


Например, если вы хотите уведомлять канал Slack каждый раз, когда создается новая задача:

  • Создайте приложение Slack, которое принимает входящие вебхуки.
  • Скопируйте URL вебхука Slack.
  • В вашей панели управления Back4app установите конечную точку на этот URL Slack для события “Новая запись в классе Todo.”
  • Вы также можете добавить пользовательские HTTP-заголовки или полезные нагрузки, если это необходимо.

Вы также можете определить вебхуки в Cloud Code, делая пользовательские HTTP-запросы в триггерах, таких как beforeSave, afterSave:

BeforeSave WebHook
BeforeSave WebHook


Шаг 9 – Изучение панели администратора Back4app

Приложение Back4app Admin App – это веб-интерфейс управления, предназначенный для нетехнических пользователей, чтобы выполнять операции CRUD и обрабатывать рутинные задачи с данными без написания кода. Он предоставляет ориентированный на модель, удобный для пользователя интерфейс, который упрощает администрирование базы данных, управление пользовательскими данными и операции на уровне предприятия.

Включение приложения администратора

Включите его, перейдя в App Dashboard > More > Admin App и нажав кнопку “Включить приложение администратора”.

Включить приложение администратора
Включить приложение администратора


Создайте первого администратора (имя пользователя/пароль), что автоматически создаст новую роль (B4aAdminUser) и классы (B4aSetting, B4aMenuItem и B4aCustomField) в схеме вашего приложения.

Document image


Выберите поддомен для доступа к интерфейсу администратора и завершите настройку.

Document image


Войти с использованием учетных данных администратора, которые вы создали для доступа к новой панели управления Admin App.

Document image


После активации приложение Back4app Admin App упрощает просмотр, редактирование или удаление записей из вашей базы данных - без необходимости прямого использования панели управления Parse или бэкенд-кода. С настраиваемыми контролями доступа вы можете безопасно делиться этим интерфейсом с членами команды или клиентами, которым нужен ясный, интуитивно понятный способ управления данными.

Заключение

Следуя этому подробному руководству, вы:

  • Создана безопасная серверная часть для приложения NodeJS на Back4app.
  • Настроена база данных с классами схем, типами данных и отношениями.
  • Интегрированы запросы в реальном времени (Live Queries) для немедленных обновлений данных.
  • Применены меры безопасности с использованием ACL и CLP для защиты и управления доступом к данным.
  • Реализованы функции Cloud Code для выполнения пользовательской бизнес-логики на стороне сервера.
  • Настроена аутентификация пользователей с поддержкой проверки электронной почты и сброса паролей.
  • Управление загрузкой файлов и их извлечением с опциональными мерами безопасности.
  • Запланированы Cloud Jobs для автоматизированных фоновых задач.
  • Использованы Webhooks для интеграции с внешними сервисами.
  • Изучен панель администратора Back4app для управления данными.

С прочной основой NodeJS и надежной серверной частью Back4app вы теперь хорошо подготовлены для разработки функционально насыщенных, масштабируемых и безопасных приложений. Продолжайте исследовать более продвинутые функции, интегрируйте свою бизнес-логику и используйте возможности Back4app, чтобы сэкономить вам бесчисленные часы на администрировании серверов и баз данных. Удачного кодирования!

Следующие шаги

  • Создайте приложение NodeJS, готовое к производству , расширив этот бэкенд для обработки более сложных моделей данных, стратегий кэширования и оптимизации производительности.
  • Интегрируйте расширенные функции , такие как специализированные потоки аутентификации, контроль доступа на основе ролей или внешние API (например, платежные шлюзы).
  • Посмотрите официальную документацию Back4app для более глубокого изучения вопросов безопасности, настройки производительности и анализа журналов.
  • Изучите другие учебники по приложениям для чата в реальном времени, IoT панелям управления или услугам на основе местоположения. Вы можете комбинировать техники, изученные здесь, с API третьих сторон для создания сложных, реальных приложений.