接口的多实现需求

在准备实现一个AI服务时,需要对接不同TTS实现,比如微软的TTS、百度TTS、讯飞TTS等,这时候就涉及到了接口的多实现

我们先定义一个接口,然后定义不同的实现类

public interface TtsService {
    /** 语音合成并返回语音文件的url地址 */
    String speak(String text);
}

@Service
public interface MsTtsServiceImpl implements TtsService {
    /** 语音合成并返回语音文件的url地址 */
    String speak(String text){
        return "https://www.microsoft.com";
    }
}

@Service
public interface BdTtsServiceImpl implements TtsService {
    /** 语音合成并返回语音文件的url地址 */
    String speak(String text){
        return "https://www.baidu.com";
    }
}

当我们在Controller中调用的时候,我们就可以根据不同的需求选择不同的实现类

public class TtsController{
    
    private TtsService ttsService;

    @Autowired
    public TtsController(TtsService ttsService) {
        this.ttsService = ttsService;
    }
    @RequestMapping("/test")
    public String test(){
        return ttsService.speak("你好");
    }
}

以上的代码实际上SpringBoot无法知道应该注入哪个实现类,需要我们进行干预,比较简单的一种方式是指定默认的实现类

@Service
@Primary
public interface MsTtsServiceImpl implements TtsService {
    /** 语音合成并返回语音文件的url地址 */
    String speak(String text){
        return "https://www.microsoft.com";
    }
}

通过添加@Primary注解,SpringBoot就会默认注入这个实现类,这样就可以正常调用,但这种方式是硬编码,如果需要切换实现类,就需要修改代码 除了使用@Primary注解指定默认的实现类外,使用@Resource注解可以使用name属性指定要注入的类名,Spring框架在使用@Component、@Service等注解时,会默认将类名首字母小写作为bean的名称

//方式1
@Resource(name = "msTtsServiceImpl")
private TtsService ttsService;  
//方式2(但更推荐上面方式1)
@Resource
private TtsService msTtsServiceImpl;

还可以使用@Qualifier注解指定要注入的bean名称

@Autowired
@Qualifier("msTtsServiceImpl")
private TtsService ttsService;

以上三种方式都可以实现接口的多实现,可以根据自己的喜好进行选择,但是都是硬编码,如果需要切换实现类,就需要修改代码,结合yml配置文件进行切换,可以参考下面的方式

# yml配置文件
tts:
    type: ms

@Service
@ConditionalOnProperty(value="tts.type",havingValue = "ms")
public interface MsTtsServiceImpl implements TtsService {
    /** 语音合成并返回语音文件的url地址 */
    String speak(String text){
        return "https://www.microsoft.com";
    }
}

以上,我们添加了@ConditionalOnProperty(value="tts.type",havingValue = "ms")当tts.type=ms时,才会注入这个实现类,这样就可以实现通过修改yml配置动态切换实现类了

使用数据库配置实现接口服务的多实现

使用以上方式终究需要通过硬编码来实现动态切换,使用数据库配置来实现接口服务的动态切换可以避免硬编码

// 定义策略接口
public interface ServiceStrategy {
    void process();
}

// 实现类1
@Service
public class PrimaryServiceStrategy implements ServiceStrategy {
    @Override
    public void process() {
        // 实现逻辑
    }
}

// 实现类2
@Service
public class SecondaryServiceStrategy implements ServiceStrategy {
    @Override
    public void process() {
        // 实现逻辑
    }
}

// 策略工厂
@Service
public class ServiceStrategyFactory {
    private final Map<String, ServiceStrategy> strategies = new HashMap<>();

    // 构造函数注入所有ServiceStrategy实现
    // Spring框架会自动注入所有被@Service或@Component注解标记的实现ServiceStrategy接口的Bean
    @Autowired
    public ServiceStrategyFactory(List<ServiceStrategy> strategyList) {
        for (ServiceStrategy strategy : strategyList) {
            // 假设类名以"Strategy"结尾，移除后作为key
            strategies.put(strategy.getClass().getSimpleName().replace("Strategy", ""), strategy);
        }
    }

    // 根据类型获取策略
    public ServiceStrategy getStrategy(String type) {
        return strategies.getOrDefault(type, strategies.get("primary"));
    }
}


// 使用示例
@Service
public class SomeBusinessService {
    @Autowired
    private ServiceStrategyFactory strategyFactory;

    @Autowired
    private UserOptionsRepository userOptionsRepository;

    public void performBusinessAction(Long userId) {
        Optional<UserOptions> userOptions = userOptionsRepository.findByUserId(userId);
        String serviceType = userOptions.map(UserOptions::getServiceType).orElse("primary");
        ServiceStrategy strategy = strategyFactory.getStrategy(serviceType);
        strategy.performAction();
    }
}

参考链接

1. spring接口多实现类，选择性注入的4种解决方案