Быстрые стартеры
Как построить бэкенд для Elixir?

40min
Введение
В этом учебном пособии вы научитесь создавать бэкенд для Elixir с использованием Back4App. 
Мы пройдем через интеграцию основных функций Back4App — таких как управление базами данных, функции Cloud Code, REST и GraphQL API, аутентификация пользователей и запросы в реальном времени (Live Queries) — чтобы создать безопасный, масштабируемый и надежный бэкенд. 
Elixir, работающий на виртуальной машине Erlang (BEAM) и использующий OTP (Erlang OTP), известен своей отказоустойчивой, конкурентной средой, которая хорошо сочетается с Back4App для формирования современной, высокопроизводительной инфраструктуры.
Вы увидите, как быстрая настройка и интуитивная среда Back4App могут значительно сократить ваше время и усилия по сравнению с ручной настройкой серверов и баз данных. 
Это включает в себя использование сопоставления шаблонов, а также интеграцию с веб-фреймворком Elixir по вашему выбору. 
К концу этого учебного пособия у вас будет прочная основа, которую вы сможете расширить до готового к производству приложения или улучшить с помощью пользовательской логики и сторонних API.
Предварительные требования
Чтобы завершить этот учебник, вам потребуется:
Учетная запись Back4App и новый проект Back4App
 Начало работы с Back4app.
Если у вас нет учетной записи, вы можете создать ее бесплатно. Следуйте приведенному выше руководству, чтобы подготовить ваш проект.
Базовая среда разработки Elixir
 Убедитесь, что у вас установлен Elixir на вашем компьютере. Если вы планируете использовать веб-фреймворк, такой как Phoenix, смотрите руководство по установке Phoenix для справки.
Знание концепций Elixir
 Официальная документация Elixir.
Если вы новичок в Elixir, ознакомьтесь с этими ресурсами или учебником для начинающих перед началом.
Убедитесь, что у вас есть все эти предварительные условия перед началом. Наличие вашего проекта Back4App и готовой локальной среды Elixir поможет вам следовать более плавно.
Шаг 1 – Создание нового проекта на Back4App и подключение
Создать новый проект
Первый шаг в создании бэкенда для Elixir на Back4App – это создание нового проекта. Если вы еще не создали его, выполните следующие шаги:
Войдите в свою учетную запись Back4app.
Нажмите кнопку “Новое приложение” в вашей панели управления Back4App.
Дайте вашему приложению имя (например, “Elixir-Backend-Tutorial”).
﻿
После создания проекта вы увидите его в своем дашборде Back4App. Этот проект станет основой для всех конфигураций бэкенда, обсуждаемых в этом руководстве.
Подключение через REST или GraphQL
Back4App использует платформу Parse в качестве основы. В данный момент для Elixir нет официального SDK Parse. Вместо этого вы можете легко подключиться к Back4App, используя REST или GraphQL API. В вашем проекте Elixir вы:
Получите ваш Application ID и REST или GraphQL ключи в разделе “Настройки приложения” или “Безопасность и ключи” в дашборде Back4App.
Настройте HTTP-запросы, используя библиотеку Elixir, такую как HTTPoison или Tesla.
Например, чтобы сохранить учетные данные в конфигурационном файле (config/dev.exs или аналогичном):
Text
config :my_app, :b4a,
  app_id: "YOUR_APPLICATION_ID",
  rest_key: "YOUR_REST_API_KEY",
  server_url: "https://parseapi.back4app.com"
config :my_app, :b4a,
  app_id: "YOUR_APPLICATION_ID",
  rest_key: "YOUR_REST_API_KEY",
  server_url: "https://parseapi.back4app.com"
﻿
Затем вы можете ссылаться на эти учетные данные в вашем коде для выполнения REST-запросов. На протяжении этого руководства мы покажем, как взаимодействовать с базой данных Back4App, системой пользователей и другими функциями, используя стандартные HTTP или GraphQL запросы.
Шаг 2 – Настройка базы данных
Создание модели данных
В Back4App данные хранятся в классах. Вы можете создать новый класс в панели управления Back4App:
Перейдите в раздел “База данных” в вашей панели управления Back4App.
Создайте новый класс (например, “Todo”) и добавьте соответствующие столбцы, такие как заголовок (String) и isCompleted (Boolean).
Создать новый класс
﻿
Создание модели данных с помощью AI-агента
Back4App также предоставляет AI-агента, который поможет вам описать и создать вашу модель данных:
Откройте AI-агента из панели управления вашим приложением или из меню.
Опишите вашу модель данных простым языком (например, “Пожалуйста, создайте новое приложение Todo с полной схемой класса.”).
Позвольте AI-агенту создать схему автоматически.
﻿
Чтение и запись данных с использованием SDK (если применимо)
Поскольку Elixir не имеет официального SDK Parse, мы пропустим прямое использование SDK. Вместо этого мы продемонстрируем REST, GraphQL, и Live Queries подходы ниже.
Чтение и запись данных с использованием REST API
Установите HTTP-клиент, такой как HTTPoison в вашем mix.exs:
Text
defp deps do
  [
    {:httpoison, "~> 1.8"}
  ]
end
defp deps do
  [
    {:httpoison, "~> 1.8"}
  ]
end
﻿
Затем выполните mix deps.get.
Чтобы создать (сохранить) объект Todo из вашего приложения Elixir:
Text
defmodule MyApp.Todo do
  @moduledoc false
  require Logger
  alias MyApp.Config

  def create_todo(title, is_completed) do
    url      = Config.server_url() <> "/classes/Todo"
    headers  = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body     = Jason.encode!(%{"title" => title, "isCompleted" => is_completed})

    case HTTPoison.post(url, body, headers) do
      {:ok, %HTTPoison.Response{status_code: 201, body: resp_body}} ->
        Logger.info("Todo created: #{resp_body}")
        {:ok, resp_body}

      {:ok, %HTTPoison.Response{status_code: status, body: error_body}} ->
        Logger.error("Error creating todo (#{status}): #{error_body}")
        {:error, error_body}

      {:error, error} ->
        Logger.error("HTTP error: #{inspect(error)}")
        {:error, error}
    end
  end
end
defmodule MyApp.Todo do
  @moduledoc false
  require Logger
  alias MyApp.Config

  def create_todo(title, is_completed) do
    url      = Config.server_url() <> "/classes/Todo"
    headers  = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body     = Jason.encode!(%{"title" => title, "isCompleted" => is_completed})

    case HTTPoison.post(url, body, headers) do
      {:ok, %HTTPoison.Response{status_code: 201, body: resp_body}} ->
        Logger.info("Todo created: #{resp_body}")
        {:ok, resp_body}

      {:ok, %HTTPoison.Response{status_code: status, body: error_body}} ->
        Logger.error("Error creating todo (#{status}): #{error_body}")
        {:error, error_body}

      {:error, error} ->
        Logger.error("HTTP error: #{inspect(error)}")
        {:error, error}
    end
  end
end
﻿
И чтобы запросить ваши объекты Todo:
Text
def fetch_todos() do
  url     = Config.server_url() <> "/classes/Todo"
  headers = [
    {"X-Parse-Application-Id", Config.app_id()},
    {"X-Parse-REST-API-Key", Config.rest_key()}
  ]

  HTTPoison.get(url, headers)
end
def fetch_todos() do
  url     = Config.server_url() <> "/classes/Todo"
  headers = [
    {"X-Parse-Application-Id", Config.app_id()},
    {"X-Parse-REST-API-Key", Config.rest_key()}
  ]

  HTTPoison.get(url, headers)
end
﻿
Чтение и запись данных с использованием GraphQL API
Вы также можете взаимодействовать через GraphQL. Например, создание Todo:
GraphQL
mutation {
  createTodo(input: {
    fields: {
      title: "Clean the house"
      isCompleted: false
    }
  }) {
    todo {
      objectId
      title
      isCompleted
    }
  }
}
mutation {
  createTodo(input: {
    fields: {
      title: "Clean the house"
      isCompleted: false
    }
  }) {
    todo {
      objectId
      title
      isCompleted
    }
  }
}
﻿
В Elixir вы также можете отправить это с помощью HTTP-клиента:
Text
graph_query = """
mutation {
  createTodo(input: {
    fields: {
      title: "New from GraphQL",
      isCompleted: false
    }
  }) {
    todo {
      objectId
      title
    }
  }
}
"""

url = Config.server_url() <> "/graphql"
headers = [
  {"X-Parse-Application-Id", Config.app_id()},
  {"X-Parse-REST-API-Key", Config.rest_key()},
  {"Content-Type", "application/json"}
]

HTTPoison.post(url, Jason.encode!(%{"query" => graph_query}), headers)
graph_query = """
mutation {
  createTodo(input: {
    fields: {
      title: "New from GraphQL",
      isCompleted: false
    }
  }) {
    todo {
      objectId
      title
    }
  }
}
"""

url = Config.server_url() <> "/graphql"
headers = [
  {"X-Parse-Application-Id", Config.app_id()},
  {"X-Parse-REST-API-Key", Config.rest_key()},
  {"Content-Type", "application/json"}
]

HTTPoison.post(url, Jason.encode!(%{"query" => graph_query}), headers)
﻿
Работа с живыми запросами (по желанию)
Для обновлений в реальном времени Back4App предлагает Живые запросы. Вы можете включить Живые запросы в настройках вашего приложения Настройки сервера. Поскольку в данный момент нет нативной библиотеки клиента Elixir Parse, вы обычно подключаетесь через канал Phoenix или любой пользовательский клиент WebSocket к предоставленному wss://YOUR_SUBDOMAIN_HERE.b4a.io конечному пункту. Это может быть более сложным, требуя пользовательского кода для обработки подписок, сообщений и т. д.
Шаг 3 – Применение безопасности с помощью ACL и CLP
Краткий обзор
Back4App предлагает Списки контроля доступа (ACL) и Разрешения на уровне класса (CLP) для защиты и управления доступом к данным. ACL применяются к отдельным объектам, в то время как CLP применяются ко всему классу.
﻿
Пошагово
Разрешения на уровне класса (CLPs): В вашей панели управления Back4App, в разделе База данных, выберите класс (например, “Todo”) и откройте вкладку Разрешения на уровне класса. Настройте параметры (например, “Требуется аутентификация” или “Нет доступа” для публичных пользователей).
Настройка ACL: При создании или обновлении объекта вы можете отправить данные ACL в вашем REST или GraphQL запросе. Например, укажите поле _ACL в JSON, если вам нужен детальный контроль на уровне объекта.
Редактировать ACL
﻿
Для получения дополнительной информации посетите Руководство по безопасности приложений.
Шаг 4 – Написание функций облачного кода
Почему облачный код
Облачный код позволяет вам выполнять серверную логику без управления собственными серверами. С Elixir вы обычно полагаетесь на OTP для параллелизма, но здесь вы можете просто создать JavaScript облачный код в Back4App для обработки валидации, триггеров или пользовательской бизнес-логики. Этот код выполняется на Parse Server, так что вы можете сосредоточить свой код Elixir на задачах клиента или микросервиса, в то время как основная работа выполняется в облачном коде.
Пример функции
В вашем main.js на панели управления Back4App или с помощью CLI:
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 };
});
// 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 или вставив в панель управления под Cloud Code > Functions и нажав Deploy.
﻿
Вызов Cloud Code
Из Elixir вы можете использовать:
Text
defmodule MyApp.CloudFunctions do
  alias MyApp.Config

  def calculate_text_length(text) do
    url = Config.server_url() <> "/functions/calculateTextLength"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{text: text})

    HTTPoison.post(url, body, headers)
  end
end
defmodule MyApp.CloudFunctions do
  alias MyApp.Config

  def calculate_text_length(text) do
    url = Config.server_url() <> "/functions/calculateTextLength"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{text: text})

    HTTPoison.post(url, body, headers)
  end
end
﻿
Шаг 5 – Настройка аутентификации
Включение или настройка аутентификации
Back4App использует класс User для аутентификации. Вы можете легко управлять регистрацией, входом и сбросом пароля. Обычно из Elixir вы будете использовать REST вызовы:
Text
defmodule MyApp.Auth do
  alias MyApp.Config

  def sign_up_user(username, password, email) do
    url = Config.server_url() <> "/users"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{
      username: username,
      password: password,
      email: email
    })

    HTTPoison.post(url, body, headers)
  end

  def log_in_user(username, password) do
    url = Config.server_url() <> "/login?username=#{username}&password=#{password}"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()}
    ]

    HTTPoison.get(url, headers)
  end
end
defmodule MyApp.Auth do
  alias MyApp.Config

  def sign_up_user(username, password, email) do
    url = Config.server_url() <> "/users"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{
      username: username,
      password: password,
      email: email
    })

    HTTPoison.post(url, body, headers)
  end

  def log_in_user(username, password) do
    url = Config.server_url() <> "/login?username=#{username}&password=#{password}"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()}
    ]

    HTTPoison.get(url, headers)
  end
end
﻿
Социальный вход
Back4App поддерживает интеграцию с Google, Apple, Facebook и другими. В большинстве случаев вы будете направлять пользователей в поток OAuth, а затем использовать токены, возвращаемые этими провайдерами, для завершения входа в Parse. См. Документация по социальному входу для получения подробной информации.
Шаг 6 – Обработка хранения файлов
Настройка хранения файлов
Back4App безопасно хранит файлы. Из Elixir вы можете загружать файлы через REST:
Text
defmodule MyApp.FileStorage do
  alias MyApp.Config
  require Logger

  def upload_file(file_path) do
    file_name = Path.basename(file_path)
    url = Config.server_url() <> "/files/#{file_name}"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/octet-stream"}
    ]
    body = File.read!(file_path)

    case HTTPoison.post(url, body, headers) do
      {:ok, %HTTPoison.Response{status_code: 201, body: resp_body}} ->
        Logger.info("File uploaded: #{resp_body}")
        {:ok, resp_body}
      error ->
        Logger.error("Error uploading file: #{inspect(error)}")
        error
    end
  end
end
defmodule MyApp.FileStorage do
  alias MyApp.Config
  require Logger

  def upload_file(file_path) do
    file_name = Path.basename(file_path)
    url = Config.server_url() <> "/files/#{file_name}"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/octet-stream"}
    ]
    body = File.read!(file_path)

    case HTTPoison.post(url, body, headers) do
      {:ok, %HTTPoison.Response{status_code: 201, body: resp_body}} ->
        Logger.info("File uploaded: #{resp_body}")
        {:ok, resp_body}
      error ->
        Logger.error("Error uploading file: #{inspect(error)}")
        error
    end
  end
end
﻿
Вы получите ответ в формате JSON с URL файла, который вы можете сохранить в классе (например, Фото) для справки.
Соображения безопасности
Вы можете настроить, кто может загружать файлы в fileUpload настройках вашего проекта Back4App, ограничив загрузку только для аутентифицированных пользователей, если это необходимо.
Шаг 7 – Подтверждение электронной почты и сброс пароля
Обзор
Подтверждение электронной почты гарантирует, что пользователи владеют адресом электронной почты, использованным при регистрации. Сброс пароля позволяет им безопасно восстанавливать учетные записи. Оба этих функционала встроены в Back4App.
Конфигурация панели управления Back4App
Включите подтверждение электронной почты в «Настройках приложения» или «Аутентификации» вашего приложения.
Настройте адрес отправителя и шаблоны электронной почты.
Включите сброс пароля чтобы пользователи могли сбрасывать его по ссылке, отправленной им по электронной почте.
Код/Реализация
После включения в панели управления вы можете инициировать сброс пароля:
Text
defmodule MyApp.Auth do
  def request_password_reset(email) do
    url = Config.server_url() <> "/requestPasswordReset"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{email: email})

    HTTPoison.post(url, body, headers)
  end
end
defmodule MyApp.Auth do
  def request_password_reset(email) do
    url = Config.server_url() <> "/requestPasswordReset"
    headers = [
      {"X-Parse-Application-Id", Config.app_id()},
      {"X-Parse-REST-API-Key", Config.rest_key()},
      {"Content-Type", "application/json"}
    ]
    body = Jason.encode!(%{email: email})

    HTTPoison.post(url, body, headers)
  end
end
﻿
Шаг 8 – Планирование задач с помощью облачных заданий
Какие работы в облаке
Работы в облаке позволяют вам автоматизировать рутинные задачи, такие как очистка старых данных или отправка периодических электронных писем. Вы пишете их в Cloud Code.
Пример
JS
// main.js
Parse.Cloud.job('cleanupOldTodos', async (request) => {
  const Todo = Parse.Object.extend('Todo');
  const query = new Parse.Query(Todo);

  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);
  }
});
// main.js
Parse.Cloud.job('cleanupOldTodos', async (request) => {
  const Todo = Parse.Object.extend('Todo');
  const query = new Parse.Query(Todo);

  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);
  }
});
﻿
Разверните код.
Перейдите в панель управления Back4app > Настройки приложения > Настройки сервера > Фоновые задачи.
Запланируйте выполнение задачи ежедневно или с частотой по вашему выбору.
Запланировать облачную задачу
﻿
Шаг 9 – Интеграция вебхуков
Определение
Вебхуки позволяют вашему приложению Back4App отправлять HTTP-запросы на внешний сервис (например, канал Slack или Stripe), когда происходят определенные события.
Конфигурация
Перейдите к конфигурации вебхуков в вашей панели управления Back4App > Дополнительно > Вебхуки.
Установите конечную точку (например, https://your-service.com/webhook-endpoint).
Настройте триггеры такие как “Новая запись в классе Todo.”
Добавление вебхука
﻿
Пример
Если вы хотите отправлять данные в Slack каждый раз, когда создается задача Todo, вы можете добавить новый вебхук, указывающий на ваш URL для входящего вебхука Slack. Вы также можете определить вебхуки в облачном коде, отправляя пользовательские HTTP-запросы в триггерах, таких как afterSave.
WebHook перед сохранением
﻿
Шаг 10 – Изучение панели администратора Back4App
Где это найти
Приложение Back4app Admin App – это удобный интерфейс для управления вашими данными. Вы можете включить его из App Dashboard > More > Admin App.
Включить приложение администратора
﻿
Функции
Создать первого администратора, который настраивает роль B4aAdminUser и дополнительные классы.
Назначить поддомен для доступа к интерфейсу администратора.
Войти для просмотра и управления данными в простом интерфейсе.
﻿
Заключение
Следуя этому руководству о том, как создать бэкенд для Elixir с помощью Back4App, вы:
Создали безопасный бэкенд на платформе Back4App, используя Elixir для интеграции.
Настроили базу данных с классами, типами данных и отношениями.
Использовали REST/GraphQL для взаимодействия с вашими данными из Elixir.
Применили безопасность с использованием ACL и CLP.
Добавили пользовательскую логику с помощью функций Cloud Code.
Настроили аутентификацию пользователей с проверкой электронной почты и сбросом паролей.
Обработали хранение файлов и их извлечение.
Запланировали фоновые задачи для автоматизации.
Интегрировали внешние сервисы с помощью вебхуков.
Изучили панель администратора Back4App для удобного управления данными.
С моделью параллелизма Elixir (работающей на Erlang VM) и OTP, в сочетании с масштабируемыми и гибкими услугами Back4App, вы можете создавать высоконадежные бэкенды.
Продолжайте изучать более продвинутые функции, интегрируйте свою бизнес-логику и позвольте Back4App помочь вам справиться с тяжелой работой.
Следующие шаги
Создайте приложение Elixir, готовое к производству, наложив этот бэкенд на ваш предпочтительный веб-фреймворк Elixir/Phoenix.
Интегрируйте расширенные функции такие как контроль доступа на основе ролей или сторонние API (платежные шлюзы, сервисы обмена сообщениями).
Изучите официальную документацию Back4app для расширенной безопасности, журналов, настройки производительности и многого другого.
Посмотрите другие учебники для приложений в реальном времени, IoT панелей управления или сервисов на основе местоположения. С сопоставлением шаблонов и параллелизмом OTP у вас есть все необходимое для решения широкого спектра задач!
﻿
Обновлено 23 Jan 2025
Помогла ли вам эта страница?
Как создать бэкенд для Ruby?
Как создать бэкэнд для Play Framework?