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

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

51min

Введение

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

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

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

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

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

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

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

  • Аккаунт Back4app и новый проект Back4app Начало работы с Back4app. Если у вас нет аккаунта, вы можете создать его бесплатно. Следуйте приведенному выше руководству, чтобы подготовить ваш проект.
  • Базовая среда разработки TypeScript Убедитесь, что у вас установлена Node.js (версия 14 или выше). Вы можете создать новый проект TypeScript, используя такие инструменты, как npm init -y затем npm install -D typescript @types/node.
  • Базовые знания концепций TypeScript или JavaScript Официальная документация TypeScript. Если вы новичок в TypeScript, ознакомьтесь с официальной документацией или учебным пособием для начинающих перед началом.

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

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

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

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

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


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

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

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

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

Document image


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

Bash


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

Bash


Вы также можете установить определения типов, если это необходимо:

Bash


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

Обычно вы создаете файл (например, parseConfig.ts) в вашем src каталоге:

src/parseConfig.ts


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

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

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

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

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

TypeScript


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

Curl


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

GraphQL


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

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

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

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


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

Создать колонку
Создать колонку


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

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


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

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

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

TypeScript


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

TypeScript


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

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

Для обновлений в реальном времени Back4app предоставляет Живые запросы. В вашем коде TypeScript вы можете подписаться на изменения в конкретном классе:

  1. Включите Живые запросы в вашей панели управления Back4app в разделе Настройки сервера. Убедитесь, что «Живые запросы» включены.
  2. Инициализируйте подписку на Живой запрос в вашем коде:
src/parseConfig.ts

TypeScript


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

Шаг 3 – Применение безопасности с помощью ACL и CLP

Механизм безопасности Back4app

Back4app серьезно относится к безопасности, предоставляя Списки контроля доступа (ACL) и Разрешения на уровне класса (CLP). Эти функции позволяют ограничить, кто может читать или записывать данные на уровне объекта или класса, обеспечивая, чтобы только авторизованные пользователи могли изменять ваши данные.

Document image


Списки контроля доступа (ACL)

ACL является применяемым к отдельным объектам для определения того, какие пользователи, роли или общественность могут выполнять операции чтения/записи. Например:

TypeScript


Когда вы сохраняете объект, у него есть ACL, который предотвращает чтение или изменение его кем-либо, кроме указанного пользователя.

Редактировать ACL
Редактировать ACL


Разрешения на уровне класса (CLP)

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

  1. Перейдите в свою панель управления Back4app, выберите свое приложение и откройте раздел База данных.
  2. Выберите класс (например, “Todo”).
  3. Откройте вкладку Уровень разрешений класса.
  4. Настройте свои параметры по умолчанию, такие как “Требуется аутентификация” для чтения или записи, или “Нет доступа” для публичного.
Document image


Эти разрешения устанавливают базовый уровень, в то время как ACL уточняют разрешения для отдельных объектов. Надежная модель безопасности обычно сочетает в себе как CLP (широкие ограничения), так и ACL (точные ограничения для каждого объекта). Для получения дополнительной информации перейдите по ссылке Руководство по безопасности приложений.

Шаг 4 – Написание и развертывание облачных функций

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

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

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

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

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


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

Из среды TypeScript с использованием Parse SDK:

TypeScript


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

Curl


Или через GraphQL:

GraphQL


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

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

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

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

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

В TypeScript вы можете создать нового пользователя с:

TypeScript


Войти в существующий аккаунт:

TypeScript


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

Bash


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

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

TypeScript


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

TypeScript


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

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

TypeScript


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

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

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

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

Шаг 6 – Обработка хранения файлов

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

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

TypeScript


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

TypeScript


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

TypeScript


Затем вы можете использовать этот imageUrl в любом месте, где вам нужно отобразить или обработать сохраненный файл.

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

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

Text

  • 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 и обрабатывать рутинные задачи с данными без написания кода. Оно предоставляет ориентированный на модель, удобный для пользователя интерфейс, который упрощает администрирование базы данных, управление пользовательскими данными и операции на уровне предприятия.

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

Включите его, перейдя в Панель приложений > Дополнительно > Приложение администратора и нажав кнопку "Включить приложение администратора".

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


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

Document image


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

Document image


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

Document image


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

Заключение

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

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

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

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

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