KTLN-841: add samples for annotated koin modules and definitions

Author: dariusandz

koin-guide/koin-annotations/build.gradle.kts

@@ -1,8 +1,8 @@
 group = "com.baeldung"
 version = "1.0-SNAPSHOT"
 
-val koinVersion = "3.5.6"
-val koinAnnotationsVersion = "1.3.1"
+val koinVersion = "4.0.0-RC1"
+val koinAnnotationsVersion = "1.4.0-RC3"
 
 repositories {
     mavenCentral()
@@ -14,13 +14,13 @@ plugins {
 }
 
 dependencies {
-    implementation("io.insert-koin:koin-core:$koinVersion")
+    implementation("io.insert-koin:koin-core-jvm:$koinVersion")
     implementation("io.insert-koin:koin-annotations:$koinAnnotationsVersion")
     ksp("io.insert-koin:koin-ksp-compiler:$koinAnnotationsVersion")
 }
 
-sourceSets.main {
-    java.srcDirs("build/generated/ksp/main/kotlin")
+ksp {
+    arg("KOIN_CONFIG_CHECK", "true")
 }
 
 tasks.test {

koin-guide/koin-annotations/src/main/kotlin/com/baeldung/kotlin/koin/annotations/KoinAnnotationsApplication.kt

@@ -0,0 +1,109 @@
+package com.baeldung.kotlin.koin.annotations
+
+import org.koin.core.annotation.ComponentScan
+import org.koin.core.annotation.Factory
+import org.koin.core.annotation.KoinInternalApi
+import org.koin.core.annotation.Module
+import org.koin.core.annotation.Single
+import org.koin.core.context.startKoin
+import org.koin.ksp.generated.defaultModule
+import org.koin.ksp.generated.module
+import kotlin.random.Random
+
+@Single
+class NumberService {
+
+    fun generateRandomNumber(): Int = Random.nextInt()
+}
+
+object KoinDefaultModuleApplication {
+
+    @JvmStatic
+    fun main(args: Array<String>) {
+        val koinApp = startKoin {
+            printLogger()
+            modules(defaultModule)
+        }
+
+        require(koinApp.koin.getAll<NumberService>().isNotEmpty())
+    }
+}
+
+interface Database
+class DatabaseImpl : Database
+
+interface Repository
+class RepositoryImpl(database: Database) : Repository
+
+@Module
+class DaoModule {
+
+    @Single
+    fun provideDatabase(): Database {
+        return DatabaseImpl()
+    }
+
+    @Factory
+    fun provideRepository(database: Database): Repository {
+        return RepositoryImpl(database)
+    }
+}
+
+object KoinAnnotationsApplication {
+
+    @JvmStatic
+    fun main(args: Array<String>) {
+        val koinApp = startKoin {
+            printLogger()
+            modules(DaoModule().module)
+        }
+
+        require(koinApp.koin.getAll<Database>().isNotEmpty())
+        require(koinApp.koin.getAll<Repository>().isNotEmpty())
+    }
+}
+
+class ModuleAComponent
+
+@Module
+class ModuleA {
+
+    @Single
+    fun provideModuleAComponent(): ModuleAComponent {
+        return ModuleAComponent()
+    }
+}
+
+@Module(includes = [ModuleA::class])
+class ModuleB
+
+object KoinModulesCompositionApplication {
+
+    @JvmStatic
+    fun main(args: Array<String>) {
+        val koinApp = startKoin {
+            printLogger()
+            modules(ModuleB().module)
+        }
+
+        require(koinApp.koin.getAll<ModuleAComponent>().isNotEmpty())
+    }
+}
+
+@Module
+@ComponentScan("com.baeldung.kotlin.koin.annotations.domain")
+class DomainModule
+
+object KoinScannedComponentsModulesApplication {
+
+    @OptIn(KoinInternalApi::class)
+    @JvmStatic
+    fun main(args: Array<String>) {
+        val koinApp = startKoin {
+            printLogger()
+            modules(DomainModule().module)
+        }
+
+        require(koinApp.koin.instanceRegistry.instances.size == 2)
+    }
+}

koin-guide/koin-annotations/src/main/kotlin/com/baeldung/kotlin/koin/annotations/KoinModulesApplications.kt

@@ -0,0 +1,11 @@
+package com.baeldung.kotlin.koin.annotations.domain
+
+import org.koin.core.annotation.Factory
+import org.koin.core.annotation.Single
+
+@Single
+class ScannedSingletonComponent
+
+@Factory
+class ScannedFactoryComponent
+