| 提交 | 用户 | 时间 | ||
| e7c126 | 1 | package com.iailab.module.system.framework.sms.core.client.impl; |
| H | 2 | |
| 3 | import cn.hutool.core.lang.Assert; | |
| 4 | import cn.hutool.core.util.StrUtil; | |
| 5 | import com.iailab.framework.common.core.KeyValue; | |
| 6 | import com.iailab.framework.common.util.collection.ArrayUtils; | |
| 7 | import com.iailab.framework.common.util.json.JsonUtils; | |
| 8 | import com.iailab.module.system.framework.sms.core.client.dto.SmsReceiveRespDTO; | |
| 9 | import com.iailab.module.system.framework.sms.core.client.dto.SmsSendRespDTO; | |
| 10 | import com.iailab.module.system.framework.sms.core.client.dto.SmsTemplateRespDTO; | |
| 11 | import com.iailab.module.system.framework.sms.core.client.impl.AbstractSmsClient; | |
| 12 | import com.iailab.module.system.framework.sms.core.enums.SmsTemplateAuditStatusEnum; | |
| 13 | import com.iailab.module.system.framework.sms.core.property.SmsChannelProperties; | |
| 14 | import com.fasterxml.jackson.annotation.JsonFormat; | |
| 15 | import com.fasterxml.jackson.annotation.JsonProperty; | |
| 16 | import com.google.common.annotations.VisibleForTesting; | |
| 17 | import com.tencentcloudapi.common.Credential; | |
| 18 | import com.tencentcloudapi.sms.v20210111.SmsClient; | |
| 19 | import com.tencentcloudapi.sms.v20210111.models.*; | |
| 20 | import lombok.Data; | |
| 21 | ||
| 22 | import java.time.LocalDateTime; | |
| 23 | import java.util.List; | |
| 24 | import java.util.Objects; | |
| 25 | ||
| 26 | import static com.iailab.framework.common.util.collection.CollectionUtils.convertList; | |
| 27 | import static com.iailab.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; | |
| 28 | import static com.iailab.framework.common.util.date.DateUtils.TIME_ZONE_DEFAULT; | |
| 29 | ||
| 30 | /** | |
| 31 | * 腾讯云短信功能实现 | |
| 32 | * | |
| 33 | * 参见 <a href="https://cloud.tencent.com/document/product/382/52077">文档</a> | |
| 34 | * | |
| 35 | * @author shiwp | |
| 36 | */ | |
| 37 | public class TencentSmsClient extends AbstractSmsClient { | |
| 38 | ||
| 39 | /** | |
| 40 | * 调用成功 code | |
| 41 | */ | |
| 42 | public static final String API_CODE_SUCCESS = "Ok"; | |
| 43 | ||
| 44 | /** | |
| 45 | * REGION，使用南京 | |
| 46 | */ | |
| 47 | private static final String ENDPOINT = "ap-nanjing"; | |
| 48 | ||
| 49 | /** | |
| 50 | * 是否国际/港澳台短信： | |
| 51 | * | |
| 52 | * 0：表示国内短信。 | |
| 53 | * 1：表示国际/港澳台短信。 | |
| 54 | */ | |
| 55 | private static final long INTERNATIONAL_CHINA = 0L; | |
| 56 | ||
| 57 | private SmsClient client; | |
| 58 | ||
| 59 | public TencentSmsClient(SmsChannelProperties properties) { | |
| 60 | super(properties); | |
| 61 | Assert.notEmpty(properties.getApiSecret(), "apiSecret 不能为空"); | |
| 62 | validateSdkAppId(properties); | |
| 63 | } | |
| 64 | ||
| 65 | @Override | |
| 66 | protected void doInit() { | |
| 67 | // 实例化一个认证对象，入参需要传入腾讯云账户密钥对 secretId，secretKey | |
| 68 | Credential credential = new Credential(getApiKey(), properties.getApiSecret()); | |
| 69 | client = new SmsClient(credential, ENDPOINT); | |
| 70 | } | |
| 71 | ||
| 72 | /** | |
| 73 | * 参数校验腾讯云的 SDK AppId | |
| 74 | * | |
| 75 | * 原因是：腾讯云发放短信的时候，需要额外的参数 sdkAppId | |
| 76 | * | |
| 77 | * 解决方案：考虑到不破坏原有的 apiKey + apiSecret 的结构，所以将 secretId 拼接到 apiKey 字段中，格式为 "secretId sdkAppId"。 | |
| 78 | * | |
| 79 | * @param properties 配置 | |
| 80 | */ | |
| 81 | private static void validateSdkAppId(SmsChannelProperties properties) { | |
| 82 | String combineKey = properties.getApiKey(); | |
| 83 | Assert.notEmpty(combineKey, "apiKey 不能为空"); | |
| 84 | String[] keys = combineKey.trim().split(" "); | |
| 85 | Assert.isTrue(keys.length == 2, "腾讯云短信 apiKey 配置格式错误，请配置 为[secretId sdkAppId]"); | |
| 86 | } | |
| 87 | ||
| 88 | private String getSdkAppId() { | |
| 89 | return StrUtil.subAfter(properties.getApiKey(), " ", true); | |
| 90 | } | |
| 91 | ||
| 92 | private String getApiKey() { | |
| 93 | return StrUtil.subBefore(properties.getApiKey(), " ", true); | |
| 94 | } | |
| 95 | ||
| 96 | @Override | |
| 97 | public SmsSendRespDTO sendSms(Long sendLogId, String mobile, | |
| 98 | String apiTemplateId, List<KeyValue<String, Object>> templateParams) throws Throwable { | |
| 99 | // 构建请求 | |
| 100 | SendSmsRequest request = new SendSmsRequest(); | |
| 101 | request.setSmsSdkAppId(getSdkAppId()); | |
| 102 | request.setPhoneNumberSet(new String[]{mobile}); | |
| 103 | request.setSignName(properties.getSignature()); | |
| 104 | request.setTemplateId(apiTemplateId); | |
| 105 | request.setTemplateParamSet(ArrayUtils.toArray(templateParams, e -> String.valueOf(e.getValue()))); | |
| 106 | request.setSessionContext(JsonUtils.toJsonString(new SessionContext().setLogId(sendLogId))); | |
| 107 | // 执行请求 | |
| 108 | SendSmsResponse response = client.SendSms(request); | |
| 109 | SendStatus status = response.getSendStatusSet()[0]; | |
| 110 | return new SmsSendRespDTO().setSuccess(Objects.equals(status.getCode(), API_CODE_SUCCESS)).setSerialNo(status.getSerialNo()) | |
| 111 | .setApiRequestId(response.getRequestId()).setApiCode(status.getCode()).setApiMsg(status.getMessage()); | |
| 112 | } | |
| 113 | ||
| 114 | @Override | |
| 115 | public List<SmsReceiveRespDTO> parseSmsReceiveStatus(String text) { | |
| 116 | List<SmsReceiveStatus> callback = JsonUtils.parseArray(text, SmsReceiveStatus.class); | |
| 117 | return convertList(callback, status -> new SmsReceiveRespDTO() | |
| 118 | .setSuccess(SmsReceiveStatus.SUCCESS_CODE.equalsIgnoreCase(status.getStatus())) | |
| 119 | .setErrorCode(status.getErrCode()).setErrorMsg(status.getDescription()) | |
| 120 | .setMobile(status.getMobile()).setReceiveTime(status.getReceiveTime()) | |
| 121 | .setSerialNo(status.getSerialNo()).setLogId(status.getSessionContext().getLogId())); | |
| 122 | } | |
| 123 | ||
| 124 | @Override | |
| 125 | public SmsTemplateRespDTO getSmsTemplate(String apiTemplateId) throws Throwable { | |
| 126 | // 构建请求 | |
| 127 | DescribeSmsTemplateListRequest request = new DescribeSmsTemplateListRequest(); | |
| 128 | request.setTemplateIdSet(new Long[]{Long.parseLong(apiTemplateId)}); | |
| 129 | request.setInternational(INTERNATIONAL_CHINA); | |
| 130 | // 执行请求 | |
| 131 | DescribeSmsTemplateListResponse response = client.DescribeSmsTemplateList(request); | |
| 132 | DescribeTemplateListStatus status = response.getDescribeTemplateStatusSet()[0]; | |
| 133 | if (status == null || status.getStatusCode() == null) { | |
| 134 | return null; | |
| 135 | } | |
| 136 | return new SmsTemplateRespDTO().setId(status.getTemplateId().toString()).setContent(status.getTemplateContent()) | |
| 137 | .setAuditStatus(convertSmsTemplateAuditStatus(status.getStatusCode().intValue())).setAuditReason(status.getReviewReply()); | |
| 138 | } | |
| 139 | ||
| 140 | @VisibleForTesting | |
| 141 | Integer convertSmsTemplateAuditStatus(int templateStatus) { | |
| 142 | switch (templateStatus) { | |
| 143 | case 1: return SmsTemplateAuditStatusEnum.CHECKING.getStatus(); | |
| 144 | case 0: return SmsTemplateAuditStatusEnum.SUCCESS.getStatus(); | |
| 145 | case -1: return SmsTemplateAuditStatusEnum.FAIL.getStatus(); | |
| 146 | default: throw new IllegalArgumentException(String.format("未知审核状态(%d)", templateStatus)); | |
| 147 | } | |
| 148 | } | |
| 149 | ||
| 150 | @Data | |
| 151 | private static class SmsReceiveStatus { | |
| 152 | ||
| 153 | /** | |
| 154 | * 短信接受成功 code | |
| 155 | */ | |
| 156 | public static final String SUCCESS_CODE = "SUCCESS"; | |
| 157 | ||
| 158 | /** | |
| 159 | * 用户实际接收到短信的时间 | |
| 160 | */ | |
| 161 | @JsonProperty("user_receive_time") | |
| 162 | @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) | |
| 163 | private LocalDateTime receiveTime; | |
| 164 | ||
| 165 | /** | |
| 166 | * 国家（或地区）码 | |
| 167 | */ | |
| 168 | @JsonProperty("nationcode") | |
| 169 | private String nationCode; | |
| 170 | ||
| 171 | /** | |
| 172 | * 手机号码 | |
| 173 | */ | |
| 174 | private String mobile; | |
| 175 | ||
| 176 | /** | |
| 177 | * 实际是否收到短信接收状态，SUCCESS（成功）、FAIL（失败） | |
| 178 | */ | |
| 179 | @JsonProperty("report_status") | |
| 180 | private String status; | |
| 181 | ||
| 182 | /** | |
| 183 | * 用户接收短信状态码错误信息 | |
| 184 | */ | |
| 185 | @JsonProperty("errmsg") | |
| 186 | private String errCode; | |
| 187 | ||
| 188 | /** | |
| 189 | * 用户接收短信状态描述 | |
| 190 | */ | |
| 191 | @JsonProperty("description") | |
| 192 | private String description; | |
| 193 | ||
| 194 | /** | |
| 195 | * 本次发送标识 ID（与发送接口返回的SerialNo对应） | |
| 196 | */ | |
| 197 | @JsonProperty("sid") | |
| 198 | private String serialNo; | |
| 199 | ||
| 200 | /** | |
| 201 | * 用户的 session 内容（与发送接口的请求参数 SessionContext 一致） | |
| 202 | */ | |
| 203 | @JsonProperty("ext") | |
| 204 | private SessionContext sessionContext; | |
| 205 | ||
| 206 | } | |
| 207 | ||
| 208 | @VisibleForTesting | |
| 209 | @Data | |
| 210 | static class SessionContext { | |
| 211 | ||
| 212 | /** | |
| 213 | * 发送短信记录id | |
| 214 | */ | |
| 215 | private Long logId; | |
| 216 | ||
| 217 | } | |
| 218 | ||
| 219 | } | |
