spring boot 中的 @qualifier 注解用于解决当您有多个相同类型的 bean 但想要注入特定的 bean 时出现的歧义。当存在多个候选者时,它可以帮助 spring 确定应该自动装配哪个 bean。
以下是 @qualifier 有用的所有常见场景,并附有示例:
场景 1:相同类型的多个 bean
您可能有多个相同类型的 bean,并且您想注入特定的一个。
示例:
import org.springframework.stereotype.component; @component public class dog implements animal { @override public string sound() { return "bark"; } } @component public class cat implements animal { @override public string sound() { return "meow"; } }
这里,dog 和 cat 都实现了 animal 接口。
@qualifier 的用法:
import org.springframework.beans.factory.annotation.autowired; import org.springframework.beans.factory.annotation.qualifier; import org.springframework.stereotype.service; @service public class animalservice { private final animal animal; @autowired public animalservice(@qualifier("cat") animal animal) { this.animal = animal; } public string getanimalsound() { return animal.sound(); } }
在此示例中,@qualifier("cat") 注解指定应将 cat bean 注入到 animalservice 中。如果没有 @qualifier,spring 会因歧义而抛出异常。
场景 2:将 @qualifier 与主要和次要 bean 一起使用
有时,您可能有一个“主要”bean 和其他不常用的 bean,但您仍然希望能够使用 @qualifier 注入特定的 bean。
示例:
@component @primary public class dog implements animal { @override public string sound() { return "bark"; } } @component public class cat implements animal { @override public string sound() { return "meow"; } }
@primary 注解确保默认注入 dog。但你仍然可以使用@qualifier来注入cat。
使用@qualifier来覆盖@primary:
@service public class animalservice { private final animal animal; @autowired public animalservice(@qualifier("cat") animal animal) { this.animal = animal; } public string getanimalsound() { return animal.sound(); } }
在本例中,尽管 dog 被标记为 @primary,但由于 @qualifier 注解,cat bean 仍被注入。
场景 3:带有构造函数注入和字段注入的 @qualifier
@qualifier 可以与基于构造函数和基于字段的注入一起使用。
示例:使用 @qualifier 进行字段注入:
@service public class animalservice { @autowired @qualifier("dog") private animal animal; public string getanimalsound() { return animal.sound(); } }
在这种情况下,@qualifier("dog") 确保将 dog bean 注入到 animalservice 中。
场景 4:带有方法参数注入的 @qualifier
通过方法参数注入依赖时也可以使用@qualifier。
示例:
@service public class animalservice { private animal animal; @autowired public void setanimal(@qualifier("dog") animal animal) { this.animal = animal; } public string getanimalsound() { return animal.sound(); } }
这里,@qualifier("dog") 确保通过 setter 方法注入 dog bean。
场景 5:带有自定义注释的 @qualifier
您可以创建自定义限定符以避免硬编码 bean 名称,从而使代码更干净且更易于维护。
示例:自定义限定符:
创建自定义限定符:
import org.springframework.beans.factory.annotation.qualifier; import java.lang.annotation.retention; import java.lang.annotation.retentionpolicy; @qualifier @retention(retentionpolicy.runtime) public @interface dogqualifier { }
应用自定义限定符:
@component @dogqualifier public class dog implements animal { @override public string sound() { return "bark"; } } @component public class cat implements animal { @override public string sound() { return "meow"; } }
使用自定义限定符注入:
@service public class animalservice { private final animal animal; @autowired public animalservice(@dogqualifier animal animal) { this.animal = animal; } public string getanimalsound() { return animal.sound(); } }
在这个例子中,@dogqualifier用于指定要注入哪个bean,而不是使用@qualifier("dog")。
场景 6:集合中的 @qualifier
在自动装配 bean 集合时可以使用 @qualifier,以确保只注入特定的 bean。
示例:
import org.springframework.beans.factory.annotation.qualifier; import org.springframework.stereotype.component; @component @qualifier("domestic") public class dog implements animal { @override public string sound() { return "bark"; } } @component @qualifier("domestic") public class cat implements animal { @override public string sound() { return "meow"; } } @component public class lion implements animal { @override public string sound() { return "roar"; } }
与集合一起使用:
@Service public class AnimalService { private final List<animal> animals; @Autowired public AnimalService(@Qualifier("domestic") List<animal> animals) { this.animals = animals; } public void printAnimalSounds() { animals.forEach(animal -> System.out.println(animal.sound())); } } </animal></animal>
在此示例中,仅注入 dog 和 cat beans,因为它们被标记为 @qualifier("domestic")。
摘要:
当存在多个相同类型的候选者时,@qualifier 有助于注入特定的 beans。
它用于构造函数注入、字段注入、方法注入、自定义限定符甚至集合等场景。
通过了解这些场景,您可以有效地使用 @qualifier 来解决歧义并管理 spring boot 应用程序中的 bean 注入。
以上就是@Qualifier 注解 Spring Boot 详解的详细内容,更多请关注php中文网其它相关文章!