Как создать Backend для Elm?

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

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

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

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

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

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

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

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

Back4app использует платформу Parse для управления вашими данными, предоставления функций в реальном времени, обработки аутентификации пользователей и многого другого. Поскольку нет официального SDK Parse для Elm, мы будем использовать REST или GraphQL вызовы из нашего Elm приложения для связи с бэкендом Back4app.

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

Из Elm вы можете сохранить эти учетные данные в конфигурационном файле или модуле. Например:

Вы будете использовать эти значения всякий раз, когда будете делать HTTP-запросы к Back4app из Elm. Завершив этот шаг, вы установили безопасное соединение между вашим фронтендом на Elm и бэкендом Back4app.

С вашим проектом Back4app настроенным, вы теперь можете начинать сохранять и извлекать данные через REST или GraphQL из Elm. Для простого примера мы продемонстрируем, как создать и получить Todo элемент.

Мы будем использовать elm/http для выполнения REST-запросов. Вот упрощенный пример, как создать элемент Todo:

Затем вы можете вызвать createTodo или fetchTodos в вашей функции обновления Elm, обработать Http ответы и интегрировать данные в модель вашего приложения.

Если вы предпочитаете тестировать или хотите делать быстрые вызовы вне Elm, вы можете использовать cURL:

Back4app также предоставляет интерфейс GraphQL. Ниже приведен пример мутации GraphQL для создания Todo:

В Elm вы можете использовать библиотеку GraphQL или вручную составлять ваши HTTP-запросы для отправки этих мутаций и запросов, очень похоже на то, как мы использовали elm/http выше.

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

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

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

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

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

Например, чтобы добавить указатель через REST:

Когда вы выполняете запрос, вы также можете включить данные указателя, используя параметр ?include=category в REST или используя include в запросах GraphQL.

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

Если вы хотите интегрировать живые запросы с Elm, вы можете использовать elm-websocket (или другой индивидуальный подход), чтобы подписаться на изменения. Однако это требует более сложной настройки, так как в данный момент не существует официального клиента Elm для живых запросов.

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

ACL применяется к отдельным объектам, чтобы определить, какие пользователи, роли или общественность могут выполнять операции чтения/записи. Вы можете настроить ACL из Elm, включив _ACL свойство в ваш JSON при создании или обновлении объектов через REST или GraphQL.

Например, чтобы создать приватную задачу, вы можете установить:

Это предотвращает чтение или изменение объекта кем-либо, кроме этого пользователя.

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

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

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

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

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

Вы можете вызывать эти функции Cloud Code из Elm, сделав REST-запрос к:

https://parseapi.back4app.com/functions/fetchExternalData

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

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

Из Elm вы можете вызвать облачную функцию, сделав POST-запрос:

Вы также можете вызывать облачные функции через GraphQL:

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

Back4app и Parse могут интегрироваться с популярными провайдерами OAuth, такими как Google, Facebook, или Apple. Обычно вы настраиваете этих провайдеров в панели управления Back4app, а затем делаете необходимые запросы из Elm. Обратитесь к Документация по социальному входу для подробных шагов настройки.

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

После загрузки вы получите URL файла в ответе. Вы можете сохранить этот URL в поле класса Parse или отобразить его в вашем приложении Elm по мере необходимости.

Parse Server предоставляет конфигурации для управления безопасностью загрузки файлов. Например:

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

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

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

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

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

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

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

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

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

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

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