根据 code review 对腾讯云短信实现优化
parent
9726560318
commit
91f758c295
|
@ -1,8 +1,19 @@
|
||||||
package cn.iocoder.yudao.framework.common.util.collection;
|
package cn.iocoder.yudao.framework.common.util.collection;
|
||||||
|
|
||||||
|
import cn.hutool.core.collection.CollectionUtil;
|
||||||
import cn.hutool.core.util.ArrayUtil;
|
import cn.hutool.core.util.ArrayUtil;
|
||||||
|
import cn.hutool.core.util.TypeUtil;
|
||||||
|
import org.springframework.cglib.core.TypeUtils;
|
||||||
|
|
||||||
|
import java.lang.reflect.Array;
|
||||||
|
import java.lang.reflect.ParameterizedType;
|
||||||
|
import java.lang.reflect.Type;
|
||||||
|
import java.util.Collection;
|
||||||
|
import java.util.List;
|
||||||
import java.util.function.Consumer;
|
import java.util.function.Consumer;
|
||||||
|
import java.util.function.Function;
|
||||||
|
|
||||||
|
import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertList;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Array 工具类
|
* Array 工具类
|
||||||
|
@ -30,4 +41,16 @@ public class ArrayUtils {
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static <T, V> V[] toArray(Collection<T> from, Function<T, V> mapper) {
|
||||||
|
return toArray(convertList(from, mapper));
|
||||||
|
}
|
||||||
|
|
||||||
|
@SuppressWarnings("unchecked")
|
||||||
|
public static <T> T[] toArray(Collection<T> from) {
|
||||||
|
if (CollectionUtil.isEmpty(from)) {
|
||||||
|
return (T[]) (new Object[0]);
|
||||||
|
}
|
||||||
|
return ArrayUtil.toArray(from, (Class<T>) CollectionUtil.getElementType(from.iterator()));
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,7 +4,6 @@ import cn.hutool.core.collection.CollUtil;
|
||||||
import cn.hutool.core.collection.CollectionUtil;
|
import cn.hutool.core.collection.CollectionUtil;
|
||||||
import com.google.common.collect.ImmutableMap;
|
import com.google.common.collect.ImmutableMap;
|
||||||
|
|
||||||
import java.lang.reflect.Array;
|
|
||||||
import java.util.*;
|
import java.util.*;
|
||||||
import java.util.function.BinaryOperator;
|
import java.util.function.BinaryOperator;
|
||||||
import java.util.function.Function;
|
import java.util.function.Function;
|
||||||
|
@ -171,21 +170,4 @@ public class CollectionUtils {
|
||||||
return deptId == null ? Collections.emptyList() : Collections.singleton(deptId);
|
return deptId == null ? Collections.emptyList() : Collections.singleton(deptId);
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO @FinallySays:建议放在 ArrayUtils 里,和 hutool 对齐
|
|
||||||
public static <T, V> V[] toArray(List<T> from, Function<T, V> mapper) {
|
|
||||||
return toArray(convertList(from, mapper));
|
|
||||||
}
|
|
||||||
|
|
||||||
@SuppressWarnings("unchecked")
|
|
||||||
public static <T> T[] toArray(List<T> from) {
|
|
||||||
if (CollectionUtil.isEmpty(from)) {
|
|
||||||
return (T[]) (new Object[0]);
|
|
||||||
}
|
|
||||||
Class<T> clazz = (Class<T>) from.get(0).getClass();
|
|
||||||
T[] result = (T[]) Array.newInstance(clazz, from.size());
|
|
||||||
for (int i = 0; i < from.size(); i++) {
|
|
||||||
result[i] = from.get(i);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,6 +4,7 @@ import cn.hutool.core.bean.BeanUtil;
|
||||||
import cn.hutool.core.lang.Assert;
|
import cn.hutool.core.lang.Assert;
|
||||||
import cn.hutool.core.util.StrUtil;
|
import cn.hutool.core.util.StrUtil;
|
||||||
import cn.iocoder.yudao.framework.common.core.KeyValue;
|
import cn.iocoder.yudao.framework.common.core.KeyValue;
|
||||||
|
import cn.iocoder.yudao.framework.common.util.collection.ArrayUtils;
|
||||||
import cn.iocoder.yudao.framework.common.util.collection.CollectionUtils;
|
import cn.iocoder.yudao.framework.common.util.collection.CollectionUtils;
|
||||||
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
|
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
|
||||||
import cn.iocoder.yudao.framework.sms.core.client.SmsCommonResult;
|
import cn.iocoder.yudao.framework.sms.core.client.SmsCommonResult;
|
||||||
|
@ -22,10 +23,8 @@ import com.tencentcloudapi.sms.v20210111.SmsClient;
|
||||||
import com.tencentcloudapi.sms.v20210111.models.*;
|
import com.tencentcloudapi.sms.v20210111.models.*;
|
||||||
import lombok.Data;
|
import lombok.Data;
|
||||||
|
|
||||||
import java.util.Collections;
|
|
||||||
import java.util.Date;
|
import java.util.Date;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.function.Function;
|
import java.util.function.Function;
|
||||||
import java.util.function.Supplier;
|
import java.util.function.Supplier;
|
||||||
|
|
||||||
|
@ -37,15 +36,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.TIME_ZONE_DE
|
||||||
* <p>
|
* <p>
|
||||||
* 参见 https://cloud.tencent.com/document/product/382/52077
|
* 参见 https://cloud.tencent.com/document/product/382/52077
|
||||||
*
|
*
|
||||||
* @author : shiwp
|
* @author shiwp
|
||||||
*/
|
*/
|
||||||
// TODO @author 后面,空格即可
|
|
||||||
public class TencentSmsClient extends AbstractSmsClient {
|
public class TencentSmsClient extends AbstractSmsClient {
|
||||||
|
|
||||||
private SmsClient client;
|
private SmsClient client;
|
||||||
|
|
||||||
public TencentSmsClient(SmsChannelProperties properties) {
|
public TencentSmsClient(SmsChannelProperties properties) {
|
||||||
// TODO @FinallySays:注释的时候,中英文之间要空格哈
|
|
||||||
// 腾讯云发放短信的时候需要额外的参数 sdkAppId, 所以和 secretId 组合在一起放到 apiKey 字段中,格式为[secretId sdkAppId],
|
// 腾讯云发放短信的时候需要额外的参数 sdkAppId, 所以和 secretId 组合在一起放到 apiKey 字段中,格式为[secretId sdkAppId],
|
||||||
// 这边需要做拆分重新封装到 properties 内
|
// 这边需要做拆分重新封装到 properties 内
|
||||||
super(TencentSmsChannelProperties.build(properties), new TencentSmsCodeMapping());
|
super(TencentSmsChannelProperties.build(properties), new TencentSmsCodeMapping());
|
||||||
|
@ -55,9 +52,7 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
@Override
|
@Override
|
||||||
protected void doInit() {
|
protected void doInit() {
|
||||||
// init 或者 refresh 时需要重新封装 properties
|
// init 或者 refresh 时需要重新封装 properties
|
||||||
// TODO @FinallySays:是不是不用这个变量呀?p
|
properties = TencentSmsChannelProperties.build(properties);
|
||||||
final SmsChannelProperties p = properties;
|
|
||||||
properties = TencentSmsChannelProperties.build(p);
|
|
||||||
// 实例化一个认证对象,入参需要传入腾讯云账户密钥对 secretId,secretKey。
|
// 实例化一个认证对象,入参需要传入腾讯云账户密钥对 secretId,secretKey。
|
||||||
Credential credential = new Credential(properties.getApiKey(), properties.getApiSecret());
|
Credential credential = new Credential(properties.getApiKey(), properties.getApiSecret());
|
||||||
client = new SmsClient(credential, "ap-nanjing");
|
client = new SmsClient(credential, "ap-nanjing");
|
||||||
|
@ -68,8 +63,7 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
String mobile,
|
String mobile,
|
||||||
String apiTemplateId,
|
String apiTemplateId,
|
||||||
List<KeyValue<String, Object>> templateParams) throws Throwable {
|
List<KeyValue<String, Object>> templateParams) throws Throwable {
|
||||||
|
return invoke(() -> buildSendSmsRequest(sendLogId, mobile, apiTemplateId, templateParams),
|
||||||
return invoke(() -> buildSendSmsRequest(sendLogId, mobile, apiTemplateId, templateParams), // TODO @FinallySays:上面不用空行
|
|
||||||
this::doSendSms0,
|
this::doSendSms0,
|
||||||
response -> {
|
response -> {
|
||||||
SendStatus sendStatus = response.getSendStatusSet()[0];
|
SendStatus sendStatus = response.getSendStatusSet()[0];
|
||||||
|
@ -104,10 +98,10 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
List<KeyValue<String, Object>> templateParams) {
|
List<KeyValue<String, Object>> templateParams) {
|
||||||
SendSmsRequest request = new SendSmsRequest();
|
SendSmsRequest request = new SendSmsRequest();
|
||||||
request.setSmsSdkAppId(((TencentSmsChannelProperties) properties).getSdkAppId());
|
request.setSmsSdkAppId(((TencentSmsChannelProperties) properties).getSdkAppId());
|
||||||
request.setPhoneNumberSet(CollectionUtils.toArray(Collections.singletonList(mobile)));
|
request.setPhoneNumberSet(new String[]{mobile});
|
||||||
request.setSignName(properties.getSignature());
|
request.setSignName(properties.getSignature());
|
||||||
request.setTemplateId(apiTemplateId);
|
request.setTemplateId(apiTemplateId);
|
||||||
request.setTemplateParamSet(CollectionUtils.toArray(templateParams, e -> String.valueOf(e.getValue())));
|
request.setTemplateParamSet(ArrayUtils.toArray(templateParams, e -> String.valueOf(e.getValue())));
|
||||||
request.setSessionContext(JsonUtils.toJsonString(new SessionContext().setLogId(sendLogId)));
|
request.setSessionContext(JsonUtils.toJsonString(new SessionContext().setLogId(sendLogId)));
|
||||||
return request;
|
return request;
|
||||||
}
|
}
|
||||||
|
@ -120,11 +114,11 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
data.setErrorCode(status.getErrCode()).setErrorMsg(status.getDescription());
|
data.setErrorCode(status.getErrCode()).setErrorMsg(status.getDescription());
|
||||||
data.setReceiveTime(status.getReceiveTime()).setSuccess("SUCCESS".equalsIgnoreCase(status.getStatus()));
|
data.setReceiveTime(status.getReceiveTime()).setSuccess("SUCCESS".equalsIgnoreCase(status.getStatus()));
|
||||||
data.setMobile(status.getMobile()).setSerialNo(status.getSerialNo());
|
data.setMobile(status.getMobile()).setSerialNo(status.getSerialNo());
|
||||||
// TODO @FinallySays:建议直接判断是否为空,酱紫更易读一些
|
SessionContext context;
|
||||||
Optional.ofNullable(status.getSessionContext()).map(SessionContext::getLogId)
|
Long logId;
|
||||||
.ifPresentOrElse(data::setLogId, () -> {
|
Assert.notNull(context = status.getSessionContext(), "回执信息中未解析出 context,请联系腾讯云小助手");
|
||||||
throw new IllegalStateException(StrUtil.format("未回传logId,需联系腾讯云解决。"));
|
Assert.notNull(logId = context.getLogId(), "回执信息中未解析出 logId,请联系腾讯云小助手");
|
||||||
});
|
data.setLogId(logId);
|
||||||
return data;
|
return data;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -174,10 +168,9 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
*/
|
*/
|
||||||
private DescribeSmsTemplateListRequest buildSmsTemplateStatusRequest(String apiTemplateId) {
|
private DescribeSmsTemplateListRequest buildSmsTemplateStatusRequest(String apiTemplateId) {
|
||||||
DescribeSmsTemplateListRequest request = new DescribeSmsTemplateListRequest();
|
DescribeSmsTemplateListRequest request = new DescribeSmsTemplateListRequest();
|
||||||
// TODO TODO @FinallySays: new Long[]{Long.parseLong(apiTemplateId)} 就 ok 啦
|
request.setTemplateIdSet(new Long[]{Long.parseLong(apiTemplateId)});
|
||||||
request.setTemplateIdSet(CollectionUtils.toArray(Collections.singletonList(apiTemplateId), Long::parseLong));
|
// 地区 0:表示国内短信。1:表示国际/港澳台短信。
|
||||||
// 地区
|
request.setInternational(0L);
|
||||||
request.setInternational(0L); // TODO @FinallySays:0L 最好说明下哈;
|
|
||||||
return request;
|
return request;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -285,13 +278,12 @@ public class TencentSmsClient extends AbstractSmsClient {
|
||||||
return (TencentSmsChannelProperties) properties;
|
return (TencentSmsChannelProperties) properties;
|
||||||
}
|
}
|
||||||
TencentSmsChannelProperties result = BeanUtil.toBean(properties, TencentSmsChannelProperties.class);
|
TencentSmsChannelProperties result = BeanUtil.toBean(properties, TencentSmsChannelProperties.class);
|
||||||
// TODO @FinallySays:comb=》combine,不缩写好点哈
|
String combineKey = properties.getApiKey();
|
||||||
String combKey = properties.getApiKey();
|
Assert.notEmpty(combineKey, "apiKey 不能为空");
|
||||||
Assert.notEmpty(combKey, "apiKey 不能为空");
|
String[] keys = combineKey.trim().split(" ");
|
||||||
String[] keys = combKey.trim().split(" ");
|
Assert.isTrue(keys.length == 2, "腾讯云短信 apiKey 配置格式错误,请配置为[secretId sdkAppId]");
|
||||||
// TODO @FinallySays:建议写多个断言好点,嘿嘿。然后 Assert 支持占位符
|
Assert.notBlank(keys[0], "腾讯云短信 secretId 不能为空");
|
||||||
Assert.isTrue(keys.length == 2 && StrUtil.isNotBlank(keys[0]) && StrUtil.isNotBlank(keys[1]),
|
Assert.notBlank(keys[1], "腾讯云短信 sdkAppId 不能为空");
|
||||||
"腾讯云短信api配置格式错误,请配置为[secretId sdkAppId]");
|
|
||||||
result.setSdkAppId(keys[1]).setApiKey(keys[0]);
|
result.setSdkAppId(keys[1]).setApiKey(keys[0]);
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,7 +4,7 @@ import cn.hutool.core.util.ReflectUtil;
|
||||||
import cn.hutool.core.util.StrUtil;
|
import cn.hutool.core.util.StrUtil;
|
||||||
import cn.iocoder.yudao.framework.common.core.KeyValue;
|
import cn.iocoder.yudao.framework.common.core.KeyValue;
|
||||||
import cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants;
|
import cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants;
|
||||||
import cn.iocoder.yudao.framework.common.util.collection.CollectionUtils;
|
import cn.iocoder.yudao.framework.common.util.collection.ArrayUtils;
|
||||||
import cn.iocoder.yudao.framework.common.util.collection.MapUtils;
|
import cn.iocoder.yudao.framework.common.util.collection.MapUtils;
|
||||||
import cn.iocoder.yudao.framework.common.util.date.DateUtils;
|
import cn.iocoder.yudao.framework.common.util.date.DateUtils;
|
||||||
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
|
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
|
||||||
|
@ -89,7 +89,7 @@ public class TencentSmsClientTest extends BaseMockitoUnitTest {
|
||||||
assertEquals(mobile, request.getPhoneNumberSet()[0]);
|
assertEquals(mobile, request.getPhoneNumberSet()[0]);
|
||||||
assertEquals(properties.getSignature(), request.getSignName());
|
assertEquals(properties.getSignature(), request.getSignName());
|
||||||
assertEquals(apiTemplateId, request.getTemplateId());
|
assertEquals(apiTemplateId, request.getTemplateId());
|
||||||
assertEquals(toJsonString(CollectionUtils.toArray(new ArrayList<>(MapUtils.convertMap(templateParams).values()), String::valueOf)), toJsonString(request.getTemplateParamSet()));
|
assertEquals(toJsonString(ArrayUtils.toArray(new ArrayList<>(MapUtils.convertMap(templateParams).values()), String::valueOf)), toJsonString(request.getTemplateParamSet()));
|
||||||
assertEquals(sendLogId, ReflectUtil.getFieldValue(JsonUtils.parseObject(request.getSessionContext(), TencentSmsClient.SessionContext.class), "logId"));
|
assertEquals(sendLogId, ReflectUtil.getFieldValue(JsonUtils.parseObject(request.getSessionContext(), TencentSmsClient.SessionContext.class), "logId"));
|
||||||
return true;
|
return true;
|
||||||
}))).thenReturn(response);
|
}))).thenReturn(response);
|
||||||
|
|
Loading…
Reference in New Issue