Ін’єкція залежності Котліна з Kodein

1. Огляд

У цій статті ми представимо Kodein - структуру чистого введення залежностей Котліна (DI) - і порівняємо його з іншими популярними структурами DI.

2. Залежність

Спочатку додамо залежність Kodein до нашого pom.xml :

 com.github.salomonbrys.kodein kodein 4.1.0 

Зверніть увагу, що остання доступна версія доступна на Maven Central або jCenter.

3. Конфігурація

Для ілюстрації конфігурації на основі Kodein ми використаємо модель нижче:

class Controller(private val service : Service) class Service(private val dao: Dao, private val tag: String) interface Dao class JdbcDao : Dao class MongoDao : Dao

4. Типи палітурки

Фреймворк Kodein пропонує різні типи прив'язки. Давайте детальніше розглянемо, як вони працюють і як ними користуватися.

4.1. Сінглтон

За допомогою прив’язки Singleton цільовий компонент ліниво створюється при першому доступі та повторно використовується для всіх подальших запитів:

var created = false; val kodein = Kodein { bind() with singleton { MongoDao() } } assertThat(created).isFalse() val dao1: Dao = kodein.instance() assertThat(created).isFalse() val dao2: Dao = kodein.instance() assertThat(dao1).isSameAs(dao2)

Примітка: ми можемо використовувати Kodein.instance () для отримання цільових керованих компонентів на основі типу статичної змінної.

4.2. Нетерплячий синглтон

Це схоже на прив’язку Singleton . Єдина відмінність полягає в тому, що блок ініціалізації викликається охоче :

var created = false; val kodein = Kodein { bind() with singleton { MongoDao() } } assertThat(created).isTrue() val dao1: Dao = kodein.instance() val dao2: Dao = kodein.instance() assertThat(dao1).isSameAs(dao2)

4.3. Заводський

При заводському прив'язуванні блок ініціалізації отримує аргумент, і кожен раз із нього повертається новий об'єкт :

val kodein = Kodein { bind() with singleton { MongoDao() } bind() with factory { tag: String -> Service(instance(), tag) } } val service1: Service = kodein.with("myTag").instance() val service2: Service = kodein.with("myTag").instance() assertThat(service1).isNotSameAs(service2)

Примітка: ми можемо використовувати Kodein.instance () для налаштування перехідних залежностей.

4.4. Мультитон

Багатотонна прив'язка дуже схожа на фабричну . Єдина відмінність полягає в тому, що той самий об’єкт повертається для того самого аргументу в наступних викликах :

val kodein = Kodein { bind() with singleton { MongoDao() } bind() with multiton { tag: String -> Service(instance(), tag) } } val service1: Service = kodein.with("myTag").instance() val service2: Service = kodein.with("myTag").instance() assertThat(service1).isSameAs(service2)

4.5. Постачальник

Це фабричне прив'язування, яке не заводиться :

val kodein = Kodein { bind() with provider { MongoDao() } } val dao1: Dao = kodein.instance() val dao2: Dao = kodein.instance() assertThat(dao1).isNotSameAs(dao2)

4.6. Екземпляр

Ми можемо зареєструвати попередньо налаштований екземпляр компонента в контейнері:

val dao = MongoDao() val kodein = Kodein { bind() with instance(dao) } val fromContainer: Dao = kodein.instance() assertThat(dao).isSameAs(fromContainer)

4.7. Позначення

Ми також можемо зареєструвати більше одного компонента одного типу під різними тегами:

val kodein = Kodein { bind("dao1") with singleton { MongoDao() } bind("dao2") with singleton { MongoDao() } } val dao1: Dao = kodein.instance("dao1") val dao2: Dao = kodein.instance("dao2") assertThat(dao1).isNotSameAs(dao2)

4.8. Постійний

Це синтаксичний цукор над позначеним прив’язуванням і передбачається, що він використовується для констант констант - простих типів без успадкування:

val kodein = Kodein { constant("magic") with 42 } val fromContainer: Int = kodein.instance("magic") assertThat(fromContainer).isEqualTo(42)

5. Поділ палітур

Kodein дозволяє нам конфігурувати компоненти в окремі блоки та комбінувати їх.

5.1. Модулі

Ми можемо згрупувати компоненти за певними критеріями - наприклад, усі класи, пов’язані зі збереженням даних - і об’єднати блоки для побудови результуючого контейнера :

val jdbcModule = Kodein.Module { bind() with singleton { JdbcDao() } } val kodein = Kodein { import(jdbcModule) bind() with singleton { Controller(instance()) } bind() with singleton { Service(instance(), "myService") } } val dao: Dao = kodein.instance() assertThat(dao).isInstanceOf(JdbcDao::class.java)

Note: as modules contain binding rules, target beans are re-created when the same module is used in multiple Kodein instances.

5.2. Composition

We can extend one Kodein instance from another — this allows us to re-use beans:

val persistenceContainer = Kodein { bind() with singleton { MongoDao() } } val serviceContainer = Kodein { extend(persistenceContainer) bind() with singleton { Service(instance(), "myService") } } val fromPersistence: Dao = persistenceContainer.instance() val fromService: Dao = serviceContainer.instance() assertThat(fromPersistence).isSameAs(fromService)

5.3. Overriding

We can override bindings — this can be useful for testing:

class InMemoryDao : Dao val commonModule = Kodein.Module { bind() with singleton { MongoDao() } bind() with singleton { Service(instance(), "myService") } } val testContainer = Kodein { import(commonModule) bind(overrides = true) with singleton { InMemoryDao() } } val dao: Dao = testContainer.instance() assertThat(dao).isInstanceOf(InMemoryDao::class.java)

6. Multi-Bindings

We can configure more than one bean with the same common (super-)type in the container:

val kodein = Kodein { bind() from setBinding() bind().inSet() with singleton { MongoDao() } bind().inSet() with singleton { JdbcDao() } } val daos: Set = kodein.instance() assertThat(daos.map {it.javaClass as Class}) .containsOnly(MongoDao::class.java, JdbcDao::class.java)

7. Injector

Our application code was unaware of Kodein in all the examples we used before — it used regular constructor arguments that were provided during the container's initialization.

However, the framework allows an alternative way to configure dependencies through delegated properties and Injectors:

class Controller2 { private val injector = KodeinInjector() val service: Service by injector.instance() fun injectDependencies(kodein: Kodein) = injector.inject(kodein) } val kodein = Kodein { bind() with singleton { MongoDao() } bind() with singleton { Service(instance(), "myService") } } val controller = Controller2() controller.injectDependencies(kodein) assertThat(controller.service).isNotNull

In other words, a domain class defines dependencies through an injector and retrieves them from a given container. Such an approach is useful in specific environments like Android.

8. Using Kodein With Android

In Android, the Kodein container is configured in a custom Application class, and later on, it is bound to the Context instance. All components (activities, fragments, services, broadcast receivers) are assumed to be extended from the utility classes like KodeinActivity and KodeinFragment:

class MyActivity : Activity(), KodeinInjected { override val injector = KodeinInjector() val random: Random by instance() override fun onCreate(savedInstanceState: Bundle?) { inject(appKodein()) } }

9. Analysis

In this section, we'll see how Kodein compares with popular DI frameworks.

9.1. Spring Framework

The Spring Framework is much more feature-rich than Kodein. For example, Spring has a very convenient component-scanning facility. When we mark our classes with particular annotations like @Component, @Service, and @Named, the component scan picks up those classes automatically during container initialization.

Spring also has powerful meta-programming extension points, BeanPostProcessor and BeanFactoryPostProcessor, which might be crucial when adapting a configured application to a particular environment.

Finally, Spring provides some convenient technologies built on top of it, including AOP, Transactions, Test Framework, and many others. If we want to use these, it's worth sticking with the Spring IoC container.

9.2. Dagger 2

The Dagger 2 framework is not as feature-rich as Spring Framework, but it's popular in Android development due to its speed (it generates Java code which performs the injection and just executes it in runtime) and size.

Let's compare the libraries' method counts and sizes:

Kodein:Note that the kotlin-stdlib dependency accounts for the bulk of these numbers. When we exclude it, we get 1282 methods and 244 KB DEX size.

Dagger 2:

We can see that the Dagger 2 framework adds far fewer methods and its JAR file is smaller.

Regarding the usage — it's very similar in that the user code configures dependencies (through Injector in Kodein and JSR-330 annotations in Dagger 2) and later on injects them through a single method call.

However, a key feature of Dagger 2 is that it validates the dependency graph at compile time, so it won't allow the application to compile if there is a configuration error.

10. Conclusion

We now know how to use Kodein for dependency injection, what configuration options it provides, and how it compares with a couple of other popular DI frameworks. However, it's up to you to decide whether to use it in real projects.

Як завжди, вихідний код для наведених вище зразків можна знайти на GitHub.