华为云发送短信

嗯嗯0813

已于 2024-05-15 15:02:32 修改

阅读量356

点赞数 4

文章标签：华为云

于 2024-04-28 09:53:34 首次发布

本文链接：https://blog.csdn.net/m0_57519941/article/details/138266573

版权

文章描述了如何在SpringBoot应用中配置华为云短信服务，包括创建HwySmsConfig类存储API密钥和模板ID，以及使用HwySmsService工具类发送短信，展示了如何构造请求参数和处理鉴权过程。

摘要由CSDN通过智能技术生成

在华为云查看模板id和下面需要的东西相关的依赖和接口去华为api看一下

准备一个配置类

package com.itts.common.domain;

import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

/**

 * @description 华为云短信服务配置类
 */
@Data
@NoArgsConstructor
@Configuration
public class HwySmsConfig {
    /**
     * 开发者自己的AK(在华为云访问控制台寻找)
     */
    @Value("${hwysms.url}")
    private String url;
    @Value("${hwysms.appKey}")
    private String appKey;
    @Value("${hwysms.appSecret}")
    private String appSecret;
    @Value("${hwysms.sender}")
    private String sender;
    @Value("${hwysms.senderCode}")
    private String senderCode;
    @Value("${hwysms.signature}")
    private String signature;
    @Value("${hwysms.statusCallBack}")
    private String statusCallBack;
    @Value("${hwysms.senderThird}")
    private String senderThird;

    /**
     * 华为云模板编号
     */
    @Value("${hwysms.hwyAnyPhotoTemplateCode}")
    private String hwyAnyPhotoTemplateCode;
    @Value("${hwysms.hwyEnvTemplateCode}")
    private String hwyEnvTemplateCode;
    @Value("${hwysms.hwyResetPwdCode}")
    private String hwyResetPwdCode;
    @Value("${hwysms.hwyVisitorAcceptCode}")
    private String hwyVisitorAcceptCode;
    @Value("${hwysms.hwyVisitorRejectCode}")
    private String hwyVisitorRejectCode;
    @Value("${hwysms.hwyRelaySmsCode}")
    private String hwyRelaySmsCode;
    @Value("${hwysms.hwyProcessApproveCode}")
    private String hwyProcessApproveCode;
    @Value("${hwysms.hwyProcessOverdue}")
    private String hwyProcessOverdue;
    @Value("${hwysms.hwyDayPlan:\"\"}")
    private String hwyDayPlan;
    @Value("${hwysms.hwyProcessOverExpired:\"\"}")
    private String hwyProcessOverExpired;
    /**
     * 告知预警模板编号
     */
    @Value("${hwysms.hwyProjectRoleSms:\"\"}")
    private String hwyProjectRoleSms;
}

准备一个和自己模板相同的类用于赋值

package com.itts.common.domain;

import lombok.Data;

/**
 * ai告警短信通知模板
 */
@Data
public class SmsProjectRolePhone {
    /**
     * 工地名称
     */
    private String projectName;

    /**
     * 问题所在区域
     */
    private String areaName;
}

准备一个调取服务的工具类

package com.itts.modules.scsmanagement.service.hwysms;

import com.alibaba.fastjson.JSON;
import com.itts.common.domain.HwySmsConfig;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.client.utils.URLEncodedUtils;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.ssl.SSLContextBuilder;
import org.apache.http.util.EntityUtils;

import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.stream.Collectors;

/**

 * @description 仅包含基本短信发送方法
 */
@Slf4j
public abstract class HwySms<T> {
    //无需修改,用于格式化鉴权头域,给"X-WSSE"参数赋值
    private static final String WSSE_HEADER_FORMAT = "UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"";
    //无需修改,用于格式化鉴权头域,给"Authorization"参数赋值
    private static final String AUTH_HEADER_VALUE = "WSSE realm=\"SDP\",profile=\"UsernameToken\",type=\"Appkey\"";

    /**
     * @param mobiles 手机号列表
     * @return 拼接好的手机号字符串
     */
    public String connectMobiles(List<String> mobiles) {
        return mobiles.stream().map(s -> "+86" + s).collect(Collectors.joining(","));
    }

    /**
     * @param obj 实体类
     * @return 拼接好的参数
     */
    public abstract String connectParams(T obj);

    /**
     * @param mobiles 手机号集合
     * @param content 发送的内容
     * @return
     */
    public abstract String sendSmsMessage(List<String> mobiles, T content) throws Exception;

    /**
     * 最后的发送短信方法
     *
     * @param templateId    模板编号
     * @param receiver      短信接收人号码
     * @param templateParas 模板变量，此处以单变量验证码短信为例，请客户自行生成6位验证码，并定义为字符串类型，以杜绝首位0丢失的问题（例如：002569变成了2569）。
     */
    protected String send(String templateId, String sender, String receiver, String templateParas, HwySmsConfig hwySmsConfig) throws Exception {

        //必填,请参考"开发准备"获取如下数据,替换为实际值
        //APP接入地址+接口访问URI
        String url = hwySmsConfig.getUrl();
        //APP_Key
        String appKey = hwySmsConfig.getAppKey();
        //APP_Secret
        String appSecret = hwySmsConfig.getAppSecret();
        //国内短信签名通道号或国际/港澳台短信通道号
//        String sender = hwySmsConfig.getSender();
//        String templateId = "90ed6c7d965f4d8da873fb08b61ff5df"; //模板ID

        //条件必填,国内短信关注,当templateId指定的模板类型为通用模板时生效且必填,必须是已审核通过的,与模板类型一致的签名名称
        //国际/港澳台短信不用关注该参数
        //签名名称
        String signature = hwySmsConfig.getSignature();

        //必填,全局号码格式(包含国家码),示例:+8615123456789,多个号码之间用英文逗号分隔
//        String receiver = "+8617364451639"; //短信接收人号码

        //选填,短信状态报告接收地址,推荐使用域名,为空或者不填表示不接收状态报告
        String statusCallBack = hwySmsConfig.getStatusCallBack();

        /**
         * 选填,使用无变量模板时请赋空值 String templateParas = "";
         * 单变量模板示例:模板内容为"您的验证码是${1}"时,templateParas可填写为"[\"369751\"]"
         * 双变量模板示例:模板内容为"您有${1}件快递请到${2}领取"时,templateParas可填写为"[\"3\",\"人民公园正门\"]"
         * 模板中的每个变量都必须赋值，且取值不能为空
         * 查看更多模板和变量规范:产品介绍>模板和变量规范
         */
//        String templateParas = "[\"369751\"]"; //模板变量，此处以单变量验证码短信为例，请客户自行生成6位验证码，并定义为字符串类型，以杜绝首位0丢失的问题（例如：002569变成了2569）。

        //请求Body,不携带签名名称时,signature请填null
        String body = buildRequestBody(sender, receiver, templateId, templateParas, statusCallBack, signature);
        if (null == body || body.isEmpty()) {
            System.out.println("body is null.");
            return "body is null.";
        }

        //请求Headers中的X-WSSE参数值
        String wsseHeader = buildWsseHeader(appKey, appSecret);
        if (null == wsseHeader || wsseHeader.isEmpty()) {
            System.out.println("wsse header is null.");
            return "wsse header is null.";
        }

        //如果JDK版本低于1.8,可使用如下代码
        //为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
        //CloseableHttpClient client = HttpClients.custom()
        //        .setSSLContext(new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() {
        //            @Override
        //            public boolean isTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException {
        //                return true;
        //            }
        //        }).build()).setSSLHostnameVerifier(NoopHostnameVerifier.INSTANCE).build();

        //如果JDK版本是1.8,可使用如下代码
        //为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
        CloseableHttpClient client = HttpClients.custom()
                .setSSLContext(new SSLContextBuilder().loadTrustMaterial(null,
                        (x509CertChain, authType) -> true).build())
                .setSSLHostnameVerifier(NoopHostnameVerifier.INSTANCE)
                .build();

        HttpResponse response = client.execute(RequestBuilder.create("POST")//请求方法POST
                .setUri(url)
                .addHeader(HttpHeaders.CONTENT_TYPE, "application/x-www-form-urlencoded")
                .addHeader(HttpHeaders.AUTHORIZATION, AUTH_HEADER_VALUE)
                .addHeader("X-WSSE", wsseHeader)
                .setEntity(new StringEntity(body)).build());

//        System.out.println(response.toString()); //打印响应头域信息
        log.info("sms响应头域信息:{}",response.toString());
        String entity = EntityUtils.toString(response.getEntity());
        log.info("sms响应消息实体:{}",entity);
//        System.out.println(entity); //打印响应消息实体
        Map mapType = JSON.parseObject(entity, Map.class);

        if (mapType.get("code").equals("000000")) {
            return "OK";
        } else {

            return mapType.get("description").toString();
        }
    }

    /**
     * 构造请求Body体
     *
     * @param sender
     * @param receiver
     * @param templateId
     * @param templateParas
     * @param statusCallbackUrl
     * @param signature         | 签名名称,使用国内短信通用模板时填写
     * @return
     */
    protected String buildRequestBody(String sender, String receiver, String templateId, String templateParas,
                                      String statusCallbackUrl, String signature) {
        if (null == sender || null == receiver || null == templateId || sender.isEmpty() || receiver.isEmpty()
                || templateId.isEmpty()) {
            System.out.println("buildRequestBody(): sender, receiver or templateId is null.");
            return null;
        }
        List<NameValuePair> keyValues = new ArrayList<NameValuePair>();

        keyValues.add(new BasicNameValuePair("from", sender));
        keyValues.add(new BasicNameValuePair("to", receiver));
        keyValues.add(new BasicNameValuePair("templateId", templateId));
        if (null != templateParas && !templateParas.isEmpty()) {
            keyValues.add(new BasicNameValuePair("templateParas", templateParas));
        }
        if (null != statusCallbackUrl && !statusCallbackUrl.isEmpty()) {
            keyValues.add(new BasicNameValuePair("statusCallback", statusCallbackUrl));
        }
        if (null != signature && !signature.isEmpty()) {
            keyValues.add(new BasicNameValuePair("signature", signature));
        }

        return URLEncodedUtils.format(keyValues, Charset.forName("UTF-8"));
    }

    /**
     * 构造X-WSSE参数值
     *
     * @param appKey
     * @param appSecret
     * @return
     */
    protected String buildWsseHeader(String appKey, String appSecret) {
        if (null == appKey || null == appSecret || appKey.isEmpty() || appSecret.isEmpty()) {
            System.out.println("buildWsseHeader(): appKey or appSecret is null.");
            return null;
        }
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
        String time = sdf.format(new Date()); //Created
        String nonce = UUID.randomUUID().toString().replace("-", ""); //Nonce

        byte[] passwordDigest = DigestUtils.sha256(nonce + time + appSecret);
        String hexDigest = Hex.encodeHexString(passwordDigest);

        //如果JDK版本是1.8,请加载原生Base64类,并使用如下代码
        String passwordDigestBase64Str = Base64.getEncoder().encodeToString(hexDigest.getBytes()); //PasswordDigest
        //如果JDK版本低于1.8,请加载三方库提供Base64类,并使用如下代码
        //String passwordDigestBase64Str = Base64.encodeBase64String(hexDigest.getBytes(Charset.forName("utf-8"))); //PasswordDigest
        //若passwordDigestBase64Str中包含换行符,请执行如下代码进行修正
        //passwordDigestBase64Str = passwordDigestBase64Str.replaceAll("[\\s*\t\n\r]", "");

        return String.format(WSSE_HEADER_FORMAT, appKey, passwordDigestBase64Str, nonce, time);
    }
}

调用工具类中的抽象方法和一些工具

package com.itts.modules.scsmanagement.service.hwysms;

import com.itts.common.domain.HwySmsConfig;
import com.itts.common.domain.SmsProjectRolePhone;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.List;

/**

 * @description 华为云发送短信服务
 */
@Component
public class HwySmsAnyPhotoService extends HwySms<SmsProjectRolePhone> {
    @Autowired
    private HwySmsConfig hwySmsConfig;

    @Override
    public String connectParams(SmsProjectRolePhone bean) {
//        return "[\"" + bean.getProjectName() + "\",\"" + bean.getAreaName() + "\",\"" + bean.getTitle() + "\"]";
        return "[\"" + bean.getProjectName() + "\",\"" + bean.getAreaName() + "\"]";
    }

    @Override
    public String sendSmsMessage(List<String> mobiles, SmsProjectRolePhone content) throws Exception {
        return send(hwySmsConfig.getHwyProjectRoleSms(), hwySmsConfig.getSenderThird(), connectMobiles(mobiles), connectParams(content), hwySmsConfig);
    }
}

在业务层去调用方法结合自己的逻辑黏贴


    /**
     * 短信发送
     */
    void sendSmsKk(String phoneList,String projectName,String warTime);

实现方法加入逻辑

 /**
     * 查询项目人员信息然后发送短信
     * @return
     */
    @Override
    public void sendSmsKk(String phones,String projectName,String warTime) {
        List<String> list = new ArrayList<>();
        list.add(phones);
        SmsProjectRolePhone smsProjectAnyPhoto = new SmsProjectRolePhone();
        smsProjectAnyPhoto.setProjectName(projectName);
        smsProjectAnyPhoto.setAreaName(warTime);
        try {
            String s = hwySmsAnyPhotoService.sendSmsMessage(list, smsProjectAnyPhoto);
        } catch (Exception e){
            logger.info("短信发送失败");
        }
    }

然后就是controller测试了