@Qualifier for ambiguous beans in Spring Boot

Introduction

Sometimes Spring finds more than one bean of the same type and doesn't know which one to use. @Qualifier helps tell Spring exactly which bean to pick.

You have two or more beans of the same type and want to choose one for injection.

You want to avoid errors caused by Spring not knowing which bean to use.

You want to clearly name beans and inject them by those names.

You want to inject different implementations of the same interface in different places.

You want to make your code easier to understand by explicitly specifying beans.

Syntax

Spring Boot

@Autowired
@Qualifier("beanName")
private BeanType bean;

@Qualifier uses the bean's name to pick the right one.

You put @Qualifier right where you inject the bean.

Examples

Here, two beans implement Service. @Qualifier("fastService") tells Spring to use the FastService bean.

Spring Boot

@Component("fastService")
public class FastService implements Service {}

@Component("slowService")
public class SlowService implements Service {}

@Autowired
@Qualifier("fastService")
private Service service;

Using @Qualifier with @Bean methods to pick the right greeting bean.

Spring Boot

@Bean(name = "englishGreeting")
public Greeting englishGreeting() {
    return new EnglishGreeting();
}

@Bean(name = "spanishGreeting")
public Greeting spanishGreeting() {
    return new SpanishGreeting();
}

@Autowired
@Qualifier("spanishGreeting")
private Greeting greeting;

Sample Program

This Spring Boot app has two Printer beans. Using @Qualifier("consolePrinter") tells Spring to use the ConsolePrinter bean. When run, it prints a message from the chosen bean.

Spring Boot

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

interface Printer {
    void print();
}

@Component("consolePrinter")
class ConsolePrinter implements Printer {
    public void print() {
        System.out.println("Printing to console");
    }
}

@Component("filePrinter")
class FilePrinter implements Printer {
    public void print() {
        System.out.println("Printing to file");
    }
}

@SpringBootApplication
public class QualifierExample implements CommandLineRunner {

    @Autowired
    @Qualifier("consolePrinter")
    private Printer printer;

    public static void main(String[] args) {
        SpringApplication.run(QualifierExample.class, args);
    }

    @Override
    public void run(String... args) {
        printer.print();
    }
}

Important Notes

If you forget @Qualifier when multiple beans exist, Spring throws an error about ambiguity.

You can use @Qualifier on constructor parameters, fields, or setter methods.

Bean names are case-sensitive when used with @Qualifier.

Summary

@Qualifier helps Spring pick the right bean when there are many of the same type.

Use @Qualifier("beanName") where you inject the bean.

This avoids errors and makes your code clearer.

Practice

1. What is the main purpose of using @Qualifier in Spring Boot?

easy

A. To create a new bean instance automatically

B. To specify which bean to inject when multiple beans of the same type exist

C. To mark a class as a Spring component

D. To configure database connection properties

Solution

1. Step 1: Understand bean ambiguity in Spring

   When multiple beans of the same type exist, Spring cannot decide which one to inject automatically.

2. Step 2: Role of @Qualifier

   @Qualifier explicitly tells Spring which bean to use by specifying its name.

3. Final Answer:

   To specify which bean to inject when multiple beans of the same type exist -> Option B

4. Quick Check:

   @Qualifier = Select specific bean [OK]

Hint: Use @Qualifier to pick one bean among many [OK]

Common Mistakes:

• Thinking @Qualifier creates beans
• Confusing @Qualifier with @Component
• Using @Qualifier for unrelated tasks

2. Which of the following is the correct way to use @Qualifier to inject a bean named "serviceA"?

easy

A. @Autowired @Qualifier(serviceA) private Service service;

B. @Autowired @Qualifier(serviceA) Service service;

C. @Autowired @Qualifier('serviceA') private Service service;

D. @Autowired @Qualifier("serviceA") private Service service;

Solution

1. Step 1: Check syntax for @Qualifier

   @Qualifier requires the bean name as a string literal, so it must be in double quotes.

2. Step 2: Identify correct option

   @Autowired @Qualifier("serviceA") private Service service; uses @Qualifier("serviceA") which is the correct syntax in Java annotations.

3. Final Answer:

   @Autowired @Qualifier("serviceA") private Service service; -> Option D

4. Quick Check:

   String bean name in quotes = correct syntax [OK]

Hint: Always put bean name in double quotes inside @Qualifier [OK]

Common Mistakes:

• Omitting quotes around bean name
• Using single quotes instead of double quotes
• Missing access modifier on field

3. Given the code below, what will be printed when useService() is called?

@Component("serviceA")
class ServiceA implements Service { public String getName() { return "A"; } }
@Component("serviceB")
class ServiceB implements Service { public String getName() { return "B"; } }

@Autowired
@Qualifier("serviceB")
private Service service;

public void useService() {
  System.out.println(service.getName());
}

medium

A. B

B. A

C. serviceB

D. Compilation error

Solution

1. Step 1: Identify injected bean by @Qualifier

   @Qualifier("serviceB") tells Spring to inject the bean named "serviceB", which is ServiceB.

2. Step 2: Check method output

   ServiceB's getName() returns "B", so printing service.getName() outputs "B".

3. Final Answer:

   B -> Option A

4. Quick Check:

   @Qualifier("serviceB") injects ServiceB = prints B [OK]

Hint: Qualifier name matches bean name to pick correct implementation [OK]

Common Mistakes:

• Assuming default bean is injected without @Qualifier
• Confusing bean name with class name
• Expecting compilation error due to multiple beans

4. What is the error in the following code snippet?

@Component("serviceA")
class ServiceA implements Service {}

@Autowired
@Qualifier("serviceB")
private Service service;

medium

A. No bean named 'serviceB' found for injection

B. Missing @Component annotation on Service interface

C. Incorrect use of @Autowired without @Qualifier

D. Service interface cannot be injected

Solution

1. Step 1: Check available beans

   Only a bean named "serviceA" is defined; no bean named "serviceB" exists.

2. Step 2: Effect of @Qualifier("serviceB")

   @Qualifier("serviceB") asks Spring to inject a bean named "serviceB", which is missing, causing an error.

3. Final Answer:

   No bean named 'serviceB' found for injection -> Option A

4. Quick Check:

   @Qualifier name must match existing bean [OK]

Hint: Bean name in @Qualifier must exist in context [OK]

Common Mistakes:

• Assuming interface needs @Component
• Ignoring missing bean name mismatch
• Thinking @Autowired alone resolves ambiguity

5. You have two beans of type PaymentService: @Component("paypalService") and @Component("stripeService"). You want to inject stripeService but only want to use constructor injection. Which is the correct way to do this?

hard

A. public class OrderProcessor {
private PaymentService paymentService;
public OrderProcessor() {}
@Autowired
public void setPaymentService(@Qualifier("stripeService") PaymentService paymentService) {
this.paymentService = paymentService;
}
}

B. public class OrderProcessor {
@Autowired
@Qualifier("stripeService")
private PaymentService paymentService;
}

C. public class OrderProcessor {
private final PaymentService paymentService;
public OrderProcessor(@Qualifier("stripeService") PaymentService paymentService) {
this.paymentService = paymentService;
}
}

D. public class OrderProcessor {
@Autowired
public OrderProcessor(PaymentService paymentService) {
this.paymentService = paymentService;
}
}

Solution

1. Step 1: Understand constructor injection with @Qualifier

   To inject a specific bean via constructor, place @Qualifier on the constructor parameter.

2. Step 2: Identify correct code

   public class OrderProcessor { private final PaymentService paymentService; public OrderProcessor(@Qualifier("stripeService") PaymentService paymentService) { this.paymentService = paymentService; } } correctly uses @Qualifier("stripeService") on the constructor parameter, ensuring the right bean is injected.

3. Final Answer:

   Constructor with @Qualifier on parameter -> Option C

4. Quick Check:

   Constructor param @Qualifier picks bean [OK]

Hint: Put @Qualifier on constructor parameter for constructor injection [OK]

Common Mistakes:

• Using field injection when constructor injection is required
• Missing @Qualifier on constructor parameter
• Confusing setter injection with constructor injection