Toothpick

Недавно перевёл проект на Toothpick. Решил частично перевести документацию и сделать основные заметки что к чему.

toothpick/wiki

Scopes

Scope - это одна из основных концепций в Toothpick. На самом деле это важно для всего DI в целом, но Toothpick явно выделяет его для разработчиков.

Scopes, создание инстенсов и инъекции

В Toothpick инъекции и создание инстенсов всегда выполняется в рамках скоупа.

Ниъекции в рамках скоупа

Рассмотрим следующий пример

//a class using field and method injections
class Foo {
  @Inject Bar bar;
  @Inject void setQurtz(Qurtz qurtz) {...}
}

//injecting an object in a scope
Toothpick.inject(new Foo(), scope);

======================

Получить текущий скоуп

Можно заинжектить в класс сам скоуп. Это удобно когда например Presenter хочет сам закрыть скоуп в onDestroy() но не знает где взять его имя (объект скоупа)

class MyPresenter @Inject constructor( private val foo : Foo) {
  @Inject scope: Scope;
   
  override fun onDestroy() {
        super.onDestroy()
        Toothpick.closeScope(scope.name)
  }
}

instancesInScope() vs singletonInScope()

Официальная дока https://github.com/stephanenicolas/toothpick/wiki/Scoped-&-Unscoped-Bindings

bind(IFoo.class).to(Foo.class).instancesInScope()

Смысл instancesInScope() и singletonInScope() в том, что экземпляр Foo создастся только в одном скоупе (там где его биндили), даже если инжектили дочерним скоупом. (Toothpick.inject(new A(), S2))

Если у нас есть два скоупа, S1 и S2 (S1 родитель для S2) и в скоупе S1 есть биндинг Foo помеченный как instancesInScope() или singletonInScope(), то Toothpick.inject(new A(), S2) приведёт к тому, что a.foo будет создан в скоупе S1. Если instancesInScope() не указать, то экземпляр Foo создасться в S2.

Отличие instancesInScope() ok singletonInScope() только в том, что при singletonInScope() экземпляр создаётся один раз и хранится в скоцпе и раздаётся при каждом инжекте один и тот же. А при instancesInScope() экземпляр создаётся новый при каждом инжекте.