在Spring Boot中如何控制使用特定的实现类

最新推荐文章于 2025-03-27 08:00:00 发布

转载最新推荐文章于 2025-03-27 08:00:00 发布 · 390 阅读

1 ·

CC 4.0 BY-SA版权

原文链接：https://blog.csdn.net/kaka_buka/article/details/142455847

文章标签：

#spring boot #java #spring

在Spring Boot开发中，通常我们会面临接口有多个实现类的情况。例如，假设我们有一个NameQueryService接口，该接口有多个实现类，比如ANameQueryServiceImpl和BNameQueryServiceImpl。在某些情况下，我们只希望使用其中一个实现类，而不使用其他实现类。本文将详细介绍如何在Spring Boot中通过多种方式控制和选择想要的实现类。

1. @Primary注解

当有多个实现类时，最简单的方式是使用@Primary注解。Spring在自动装配时会优先选择带有@Primary注解的实现类。

示例代码：

public interface NameQueryService {
    String queryName();
}
@Service
@Primary
public class ANameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "A Implementation";
    }
}
@Service
public class BNameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "B Implementation";
    }
}

在上述代码中，ANameQueryServiceImpl被标记为@Primary，因此当Spring自动装配NameQueryService接口时，优先使用ANameQueryServiceImpl。

使用示例：

@RestController
public class NameController {
    private final NameQueryService nameQueryService;
    public NameController(NameQueryService nameQueryService) {
        this.nameQueryService = nameQueryService;
    }
    @GetMapping("/name")
    public String getName() {
        return nameQueryService.queryName();
    }
}

当调用/name接口时，返回的是A Implementation，因为ANameQueryServiceImpl被@Primary标记为默认实现。

2. @Qualifier注解

如果需要更加精细地控制具体使用哪个实现类，可以使用@Qualifier注解，明确指定使用的实现类名称。

示例代码：

@Service
public class ANameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "A Implementation";
    }
}
@Service
public class BNameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "B Implementation";
    }
}

在需要使用特定实现类的地方，使用@Qualifier注解指定：

@RestController
public class NameController {
    private final NameQueryService nameQueryService;
    public NameController(@Qualifier("aNameQueryServiceImpl") NameQueryService nameQueryService) {
        this.nameQueryService = nameQueryService;
    }
    @GetMapping("/name")
    public String getName() {
        return nameQueryService.queryName();
    }
}

在这里，通过@Qualifier("aNameQueryServiceImpl")指定了使用ANameQueryServiceImpl实现类，而不是BNameQueryServiceImpl。

3. 自定义注解

除了使用Spring的内置注解@Primary和@Qualifier外，还可以通过自定义注解来标记实现类，从而灵活控制依赖注入。

示例代码：

首先，创建一个自定义注解：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface AService {
}

然后在需要使用的实现类上加上自定义注解：

@Service
@AService
public class ANameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "A Implementation";
    }
}
@Service
public class BNameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "B Implementation";
    }
}

在注入时使用自定义注解：

@RestController
public class NameController {
    private final NameQueryService nameQueryService;
    public NameController(@AService NameQueryService nameQueryService) {
        this.nameQueryService = nameQueryService;
    }
    @GetMapping("/name")
    public String getName() {
        return nameQueryService.queryName();
    }
}

通过这种方式，@AService明确标记了使用ANameQueryServiceImpl，而无需依赖@Primary或@Qualifier。

4. 基于配置文件的控制

如果希望更加动态地控制使用哪个实现类，可以通过Spring的配置文件进行配置，结合@ConditionalOnProperty注解实现不同实现类的选择。

示例代码：

@Service
@ConditionalOnProperty(name = "service.name.type", havingValue = "A")
public class ANameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "A Implementation";
    }
}
@Service
@ConditionalOnProperty(name = "service.name.type", havingValue = "B")
public class BNameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "B Implementation";
    }
}

在application.properties中配置：

service.name.type=A

通过修改配置文件中的service.name.type，可以动态选择ANameQueryServiceImpl或BNameQueryServiceImpl作为NameQueryService的实现。

5. 基于Profiles的实现

Spring的@Profile注解可以根据不同的环境使用不同的实现类。例如，在开发环境中使用ANameQueryServiceImpl，在生产环境中使用BNameQueryServiceImpl。

示例代码：

@Service
@Profile("dev")
public class ANameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
        return "A Implementation";
    }
}
@Service
@Profile("prod")
public class BNameQueryServiceImpl implements NameQueryService {
    @Override
    public String queryName() {
return "B Implementation";
    }
}