feat: allow creating custom qualifier annotations

InsertKoinIO · Oct 21, 2024 · ee968b6 · ee968b6
1 parent 688929c
commit ee968b6
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 10 deletions.
diff --git a/docs/reference/koin-annotations/definitions.md b/docs/reference/koin-annotations/definitions.md
@@ -90,6 +90,28 @@ When resolving a dependency, just use the qualifier with `named` function:
 val logger: LoggerDataSource by inject(named("InMemoryLogger"))
 ```
 
+It is also possible to create custom qualifier annotations. Using the previous example:
+
+```kotlin
+@Named
+annotation class InMemoryLogger
+
+@Named
+annotation class DatabaseLogger
+
+@Single
+@InMemoryLogger
+class LoggerInMemoryDataSource : LoggerDataSource
+
+@Single
+@DatabaseLogger
+class LoggerLocalDataSource(private val logDao: LogDao) : LoggerDataSource
+```
+
+```kotlin
+val logger: LoggerDataSource by inject(named<InMemoryLogger>())
+```
+
 ## Injected Parameters with @InjectedParam
 
 You can tag a constructor member as "injected parameter", which means that the dependency will be passed in the graph when calling for resolution.

diff --git a/examples/other-ksp/src/main/kotlin/org/koin/example/animal/Animal.kt b/examples/other-ksp/src/main/kotlin/org/koin/example/animal/Animal.kt
@@ -1,9 +1,6 @@
 package org.koin.example.animal
 
-import org.koin.core.annotation.ComponentScan
-import org.koin.core.annotation.Factory
-import org.koin.core.annotation.Module
-import org.koin.core.annotation.Single
+import org.koin.core.annotation.*
 import kotlin.random.Random
 
 public interface Animal
@@ -14,12 +11,28 @@ public class Dog : Animal
 @Single(binds = [])
 public class Cat : Animal
 
+public class Bunny(public val color: String) : Animal
+
+@Named
+public annotation class WhiteBunny
+
+@Qualifier
+public annotation class BlackBunny
+
 @Module
 @ComponentScan
 public class AnimalModule {
 
     @Factory
     public fun animal(cat: Cat, dog: Dog): Animal = if (randomBoolean()) cat else dog
 
+    @Single
+    @WhiteBunny
+    public fun whiteBunny(): Bunny = Bunny("White")
+
+    @Single
+    @BlackBunny
+    public fun blackBunny(): Bunny = Bunny("Black")
+
     private fun randomBoolean(): Boolean = Random.nextBoolean()
 }
diff --git a/examples/other-ksp/src/test/kotlin/org.koin.example/TestModule.kt b/examples/other-ksp/src/test/kotlin/org.koin.example/TestModule.kt
@@ -2,13 +2,12 @@ package org.koin.example
 
 import org.junit.Test
 import org.koin.core.Koin
+import org.koin.core.error.NoDefinitionFoundException
 import org.koin.core.logger.Level
 import org.koin.core.qualifier.named
+import org.koin.core.qualifier.qualifier
 import org.koin.dsl.koinApplication
-import org.koin.example.animal.Animal
-import org.koin.example.animal.AnimalModule
-import org.koin.example.animal.Cat
-import org.koin.example.animal.Dog
+import org.koin.example.animal.*
 import org.koin.example.`interface`.MyInterfaceExt
 import org.koin.example.newmodule.*
 import org.koin.example.newmodule.ComponentWithProps.Companion.DEFAULT_ID
@@ -19,6 +18,8 @@ import org.koin.example.scope.MyScopedInstance
 import org.koin.example.scope.ScopeModule
 import org.koin.ksp.generated.defaultModule
 import org.koin.ksp.generated.module
+import kotlin.test.assertEquals
+import kotlin.test.assertFailsWith
 import kotlin.test.assertTrue
 
 class TestModule {
@@ -65,6 +66,12 @@ class TestModule {
         assertTrue {
             koin.get<MyScopeFactory>().msi == koin.get<MyScopeFactory>().msi
         }
+
+        assertFailsWith(NoDefinitionFoundException::class) {
+            koin.get<Bunny>()
+        }
+
+        assertEquals("White", koin.get<Bunny>(qualifier<WhiteBunny>()).color)
     }
 
     private fun randomGetAnimal(koin: Koin): Animal {

diff --git a/projects/koin-ksp-compiler/src/jvmMain/kotlin/org/koin/compiler/scanner/ext/KspExt.kt b/projects/koin-ksp-compiler/src/jvmMain/kotlin/org/koin/compiler/scanner/ext/KspExt.kt
@@ -73,16 +73,20 @@ fun List<KSValueArgument>.getQualifier(): KoinMetaData.Qualifier {
             ?: error("Qualifier annotation needs parameters: either type value or name")
 }
 
+private val qualifierAnnotations = listOf("Named", "Qualifier")
 fun KSAnnotated.getQualifier(): String? {
     val qualifierAnnotation = annotations.firstOrNull { a ->
         val annotationName = a.shortName.asString()
-        (annotationName == "Named" || annotationName == "Qualifier")
+        if (annotationName in qualifierAnnotations) true
+        else (a.annotationType.resolve().declaration as KSClassDeclaration).annotations.any { a2 ->
+            a2.shortName.asString() in qualifierAnnotations
+        }
     }
     return qualifierAnnotation?.let {
         when(it.shortName.asString()){
             "${Named::class.simpleName}" -> it.arguments.getNamed().getValue()
             "${Qualifier::class.simpleName}" -> it.arguments.getQualifier().getValue()
-            else -> null
+            else -> it.annotationType.resolve().declaration.qualifiedName?.asString()
         }
     }
 }