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

Приложения — это стандартный способ упаковки программного обеспечения в Erlang/OTP. По сути, они аналогичны концепции «библиотеки», распространённой в других языках программирования, но с некоторыми дополнительными характеристиками.

Приложение — это компонент, реализующий определённую функциональность, со стандартной структурой каталогов, конфигурацией и жизненным циклом. Приложения загружаются, запускаются и останавливаются.

Файл ресурсов приложения

Приложения описываются в своём файле ресурсов, который называется APP.app, где APP — имя приложения. Например, файл ресурсов приложения ex_unit называется ex_unit.app.

Файл ресурсов приложения вы найдёте в его каталоге ebin, он генерируется автоматически инструментом Mix. Некоторые его ключи берутся из списков ключевых слов, возвращаемых функциями project/0 и application/0, определёнными в mix.exs, а другие — генерируются самим Mix.

Подробнее о генерации файлов ресурсов приложений можно узнать в документации Mix.Tasks.Compile.App, а также выполнив mix help compile.app.

Среда приложения

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

По умолчанию среда приложения — это пустой список. В проектах Mix вы можете установить этот ключ в application/0:

def application do
  [env: [redis_host: "localhost"]]
end

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

Среда доступна после загрузки приложения, процесс которого описан ниже:

Application.load(:APP_NAME)
#=> :ok

Application.get_env(:APP_NAME, :redis_host)
#=> "localhost"

В проектах Mix среду приложения и его зависимостей можно переопределить через файл config/config.exs. Если вы запускаете приложение с помощью Mix, эта конфигурация доступна во время компиляции и во время выполнения, но учтите, что она не включена в сгенерированный файл ресурсов приложения и не доступна, если вы запускаете приложение без Mix.

Например, кто-то, использующий ваше приложение, может переопределить его переменную среды :redis_host следующим образом:

config :APP_NAME, redis_host: "redis.local"

Функция put_env/3 позволяет динамически настраивать среду приложения, но, как правило, каждое приложение отвечает за свою собственную среду. Не используйте функции в этом модуле для прямого доступа или изменения среды других приложений.

Среду приложения можно переопределить с помощью опции -config в erl, а также с помощью командной строки, как мы увидим ниже.

Модуль обратного вызова приложения

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

def application do
  [mod: {MyApp, []}]
end

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

Модуль MyApp предоставленный :mod должен реализовывать поведение Application. Это можно сделать, поместив use Application в этот модуль и реализовав обратный вызов start/2, например:

defmodule MyApp do
  use Application

  def start(_type, _args) do
    children = []
    Supervisor.start_link(children, strategy: :one_for_one)
  end
end

Обратный вызов start/2 должен создать и связать наблюдателя и вернуть {:ok, pid} или {:ok, pid, state}, где pid — PID наблюдателя, а state — необязательное состояние приложения. args — второй элемент кортежа, переданного в опцию :mod.

Аргумент type, переданный в start/2, обычно :normal, за исключением распределённой настройки, где конфигурируются перехваты и отказы приложений. Распределённые приложения выходят за рамки этой документации.

При завершении работы приложения вызывается его обратный вызов stop/1 после остановки дерева наблюдения временем выполнения. Этот обратный вызов позволяет приложению выполнить любые заключительные действия по очистке. Аргументом является состояние, возвращённое start/2, если таковое было, или [] в противном случае. Значение возврата stop/1 игнорируется.

Используя Application, модули получают реализацию по умолчанию для stop/1, которая игнорирует свой аргумент и возвращает :ok, но она может быть переопределена.

Модули обратного вызова приложений также могут реализовывать необязательный обратный вызов prep_stop/1. Если он присутствует, prep_stop/1 вызывается перед завершением дерева наблюдения. Его аргументом является состояние, возвращённое start/2, если таковое было, или [] в противном случае, а его возвращаемое значение передаётся в stop/1.

Жизненный цикл приложения

Загрузка приложений

Приложения загружаются, что означает, что время выполнения находит и обрабатывает их файлы ресурсов:

Application.load(:ex_unit)
#=> :ok

Если приложение включает другие приложения, они также загружаются. И процедура рекурсивно повторяется, если они в свою очередь включают приложения. Включенные приложения не связаны с приложениями в проектах Mix, это концепция Erlang/OTP, связанная с согласованным запуском.

При загрузке приложения среда, указанная в его файле ресурсов, объединяется с любыми переопределениями из файлов конфигурации, переданных в erl с помощью опции -config. Стоит отметить, что релизы передаются таким образом. Полученную среду можно переопределить ещё раз с помощью определённых опций -Application , переданных в erl.

Загрузка приложения не загружает его модули.

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

Запуск приложений

Приложения также запускаются:

Application.start(:ex_unit)
#=> :ok

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

При запуске приложения время выполнения загружает его, если оно ещё не было загружено (в техническом смысле, описанном выше). Затем оно проверяет, уже ли запущены зависимости, указанные в ключе applications файла ресурсов. Наличие хотя бы одной не запущенной зависимости — это ошибка, но когда вы запускаете приложение с помощью mix run, Mix позаботится о запуске всех зависимостей за вас, поэтому на практике вам не нужно об этом беспокоиться, если вы не запускаете приложения вручную с помощью API, предоставляемого этим модулем.

Если у приложения не настроен модуль обратного вызова, запуск выполняется на этом этапе. В противном случае вызывается его обратный вызов start/2. PID наблюдателя верхнего уровня, возвращённый этой функцией, сохраняется временем выполнения для последующего использования, а возвращённое состояние приложения также сохраняется, если таковое имеется.

Остановка приложений

Запущенные приложения, наконец, останавливаются:

Application.stop(:ex_unit)
#=> :ok

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

Остановка приложения с модулем обратного вызова состоит из трёх этапов:

1. Если присутствует, вызов необязательного обратного вызова prep_stop/1.
2. Завершение наблюдателя верхнего уровня.
3. Вызов обязательного обратного вызова stop/1.

Аргументы, передаваемые в обратные вызовы, связаны с состоянием, возвращаемым опционально start/2, и документированы в разделе о модуле обратного вызова выше.

Важно подчеркнуть, что этап 2 является блокирующим. Завершение наблюдателя запускает рекурсивную цепочку завершений дочерних элементов, поэтому упорядоченное завершение всех дочерних процессов. Обратный вызов stop/1 вызывается только после завершения всего дерева наблюдения.

Чистое завершение активной системы можно выполнить, вызвав System.stop/1. Он завершит каждое приложение в обратном порядке их запуска.

По умолчанию SIGTERM от операционной системы автоматически переведётся в System.stop/0. Вы также можете получить больший контроль над сигналами операционной системы через функцию :os.set_signal/2.

Инструменты

Инструмент сборки Mix также может использоваться для запуска ваших приложений. Например, mix test автоматически запускает ваши зависимости приложений и само приложение перед запуском тестов. mix run --no-halt запускает ваш текущий проект и может использоваться для запуска долгоживущей системы. См. mix help run.

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

Наконец, Elixir предоставляет инструменты, такие как скрипты и архивы, которые представляют собой разные механизмы упаковки вашего приложения. Обычно они используются, когда инструменты должны быть общими для разработчиков, а не в качестве вариантов развертывания. См. mix help archive.build и mix help escript.build для получения более подробной информации.

Дополнительная информация

Для получения более подробной информации об приложениях, пожалуйста, обратитесь к документации модуля application Erlang и разделу Приложения в Руководстве пользователя по принципам проектирования OTP.