基于Spring Boot的短信平台平滑切换设计方案
基于Spring Boot的短信平台平滑切换设计方案
案例背景
在电商系统中,短信服务是用户注册、登录验证、订单通知等环节的关键基础设施。由于业务需求或成本优化,企业可能需要在不同短信平台(如阿里云、腾讯云、云片等)之间进行切换。传统做法需要修改代码并重新部署,这会导致系统停机和服务中断。
本文将介绍如何通过Spring Boot的配置机制和设计模式实现短信平台的平滑切换,无需修改调用处的业务代码。
设计方案
1. 整体架构设计
采用"策略模式+工厂模式"结合Spring的依赖注入机制:
- 定义统一的短信服务接口
- 为每个短信平台实现具体策略
- 通过配置决定激活哪个实现
- 工厂类负责返回正确的短信服务实例
2. 核心实现代码
定义统一接口
public interface SmsService {/*** 发送短信* @param phone 手机号* @param content 短信内容* @return 发送结果*/SendResult send(String phone, String content);/*** 发送模板短信* @param phone 手机号* @param templateId 模板ID* @param params 模板参数* @return 发送结果*/SendResult sendWithTemplate(String phone, String templateId, Map<String, String> params);
}
实现不同平台策略(以阿里云为例)
@Slf4j
@Service
@ConditionalOnProperty(name = "sms.provider", havingValue = "aliyun")
public class AliyunSmsService implements SmsService {@Value("${sms.aliyun.access-key-id}")private String accessKeyId;@Value("${sms.aliyun.access-key-secret}")private String accessKeySecret;@Overridepublic SendResult send(String phone, String content) {// 阿里云短信发送实现log.info("使用阿里云短信平台发送短信至:{}", phone);// 实际调用阿里云SDKreturn new SendResult(true, "阿里云发送成功");}@Overridepublic SendResult sendWithTemplate(String phone, String templateId, Map<String, String> params) {// 实现模板短信发送return new SendResult(true, "阿里云模板发送成功");}
}
腾讯云实现
@Slf4j
@Service
@ConditionalOnProperty(name = "sms.provider", havingValue = "tencent")
public class TencentSmsService implements SmsService {@Value("${sms.tencent.app-id}")private String appId;@Value("${sms.tencent.app-key}")private String appKey;@Overridepublic SendResult send(String phone, String content) {// 腾讯云短信发送实现log.info("使用腾讯云短信平台发送短信至:{}", phone);// 实际调用腾讯云SDKreturn new SendResult(true, "腾讯云发送成功");}@Overridepublic SendResult sendWithTemplate(String phone, String templateId, Map<String, String> params) {// 实现模板短信发送return new SendResult(true, "腾讯云模板发送成功");}
}
短信服务工厂
@Component
public class SmsServiceFactory {private final Map<String, SmsService> smsServiceMap;@Autowiredpublic SmsServiceFactory(List<SmsService> smsServices) {smsServiceMap = new HashMap<>();for (SmsService service : smsServices) {String providerName = resolveProviderName(service.getClass());smsServiceMap.put(providerName, service);}}public SmsService getSmsService(String provider) {return smsServiceMap.get(provider);}private String resolveProviderName(Class<?> clazz) {// 解析类名或注解获取提供商名称if (clazz.getSimpleName().toLowerCase().contains("aliyun")) {return "aliyun";} else if (clazz.getSimpleName().toLowerCase().contains("tencent")) {return "tencent";}return clazz.getSimpleName();}
}
统一门面服务
@Service
public class UnifiedSmsService {@Autowiredprivate SmsServiceFactory smsServiceFactory;@Value("${sms.provider:aliyun}")private String currentProvider;public SendResult sendSms(String phone, String content) {SmsService service = smsServiceFactory.getSmsService(currentProvider);return service.send(phone, content);}public SendResult sendTemplateSms(String phone, String templateId, Map<String, String> params) {SmsService service = smsServiceFactory.getSmsService(currentProvider);return service.sendWithTemplate(phone, templateId, params);}
}
3. 配置示例
application.yml
# 短信服务配置
sms:provider: aliyun # 可切换为 tencent# 阿里云配置aliyun:access-key-id: your-access-key-idaccess-key-secret: your-access-key-secretsign-name: your-sign-name# 腾讯云配置tencent:app-id: your-app-idapp-key: your-app-keysign-name: your-sign-name
4. 业务调用示例
@RestController
@RequestMapping("/sms")
public class SmsController {@Autowiredprivate UnifiedSmsService unifiedSmsService;@PostMapping("/send")public ResponseEntity<SendResult> sendSms(@RequestParam String phone, @RequestParam String content) {// 业务代码无需关心具体实现SendResult result = unifiedSmsService.sendSms(phone, content);return ResponseEntity.ok(result);}
}
方案优势
- 解耦设计:业务代码与具体短信平台实现完全解耦
- 平滑切换:只需修改配置文件中
sms.provider
的值即可切换平台 - 易于扩展:新增短信平台只需添加新实现类,无需修改现有代码
- 集中管理:所有短信平台配置统一管理,便于维护
- 条件装配:使用
@ConditionalOnProperty
确保只有激活的配置才会被加载