Скачать compost - Скачать исходный код compost

compost

Сторонние компоненты

1.0.0

Скачать

Компост

Библиотека, которая управляет жизненным циклом государственных компонентов. Это вариант https://github.com/stuartsierra/component Project. На данный момент эта библиотека не поддерживает Clojurescript.

Использование

Добавьте эту зависимость в свой проект

  [net.readmarks/compost "0.2.0"]

См. Тесты для примеров. Объявление компонентов имеет форму

   { :requires #{ :required-component-id-1 :required-component-id-2 }}
    :this initial-state
    :get ( fn [this] ...) ; ; Returns value of this component that other components will get as dependency. 
    :start ( fn [this dependency-components-map] ...) ; ; Acquire resources (open connections, start threads ...)
    :stop ( fn [this] ...)} ; ; Release resources.

Все поля необязательны, по умолчанию:

   { :requires #{}
    :this nil
    :get identity 
    :start ( fn [this dependency-components-map] this)
    :stop identity}

:start and :stop Функции должны вернуть новое значение компонентов :this . Если компонент приобретает ресурсы в :start он должен выпустить их в :stop . Системное объявление - это простая карта

  { :component-1-id component-1-declaration
   :component-2-id component-2-declaration
   ...
  }

Пример использования жизненного цикла

 ( require '[net.readmarks.compost :as compost])
 ( let [s ( compost/start system-map #{ :web-component :some-worker-component })]
   ( Thread/sleep 5000 )
   ( compost/stop s))

Вы можете спасти современное состояние системы после исключения следующим образом:

 ( try
   ( compost/start system-map)
   ( catch ExceptionInfo ex
     ( if-let [sys ( compost/ex-system ex)]
       ( compost/stop sys) ; ;; Handle this system as desired here.
       ( throw ex))))

Обработка ошибок

Эта функция реализована net.readmarks.compost.keeper. Пространство имен. Это пространство имен считается экспериментальным, оно может измениться в любой версии.

Агент («хранитель») имеет текущее состояние системы наряду со исключениями жизненного цикла. Пример использования:

 ( require '[net.readmarks.compost :as compost])
 ( require '[net.readmarks.compost.keeper :as keeper])

 ( def sys ( keeper/keeper system-map))

 ( keeper/update-keeper! sys compost/start)
 ; ; Now sys holds current system value and errors if there are any.
 ; ; (:system @sys) is current system map value.
 ; ; (:errors @sys) is list of of system lifecycle errors. It is empty if system changes were successful.

 ; ; You can send these errors into a log, for example:
 ( keeper/flush-errors! sys println) ; ; The function gets errors one by one.

Использование компонентов com.stuartsierra.component

Вы можете адаптировать существующие компоненты следующим образом:

( defn component-using [init using]
  { :requires ( set using)
   :this init
   :start ( fn [this deps]
            ( -> ( merge this deps)
                component/start)
   :stop component/stop})
 
( def system 
  { :conn-source ( component-using
                   ( ->MyConnPool )
                   [])
   :dao ( component-using
          ( map->MyDbComponent {})
          [ :conn-source ])}

Обратите внимание, что в отличие от com.stuartsierra.component последовательность nrcompost/stop может отличаться от обратного запуска. Только явно объявленные зависимости уважаются. Если вам нужно учесть неявные зависимости, вы должны добавить дополнительные элементы в компоненты :require коллекций.

Мотивация

Мне нравится, что обеспечивает компонент, но я также хочу

Используйте любое значение в качестве компонента. Например, часто я хочу, чтобы закрытие функции было компонентом. Или, в качестве альтернативы, компонент будет виден как функция. Кроме того, мне не нравится идея всегда сохранять ссылку на зависимость, даже если она может понадобиться только в начальной функции.
Не требуйте нового типа для каждого компонента. Реализация Lifecycle мешает вам, когда вам нужен только специальный компонент. Также требование, чтобы компонент была картой и реализовать жизненный цикл, эффективно ограничивает компонент, быть записью. Это также означает, что иногда люди прибегают к работе, чтобы избежать создания новых типов.
Используйте простые структуры данных Clojure для настройки системы. Я думаю, что введение конфигурации в метаданные было ошибкой. Вместо того, чтобы оптимизировать его, на самом деле усложняет код. Конфигурация системы - это также данные, которые можно захотеть проверить или изменить. Дайте ему равные права :)
Будьте совместимы с com.stuartsierra.component/Lifecycle Components. Уже есть много таких компонентов, и это хорошая вещь. Эта часть должна требовать только небольшого количества клея.