SpringBoot项目实现短信发送接口开发的实践

195 阅读 0 评论 129 点赞

我是靠谱客的博主俊秀手链，这篇文章主要介绍SpringBoot项目实现短信发送接口开发的实践，现在分享给大家，希望可以做个参考。

一. 短信接口实现

描述:请求第三方短信接口平台(而第三方短信平台的接口请求是webservice方式实现的),此时我们要测试接口是否通,要用的工具SoapUI测试工具, 不能用PostMan,即使用post组装完参数请求该短信平台接口也不会通的(请求之前要ping通IP,只有在同一网段才可请求.或者使用VPN远程连接也可请求),接口通了之后.开始裸代码.代码使用IDEA工具去完成 , 实现逻辑根据需求而定.

首先导入两个依赖

复制代码

1
2
3
4
5
6
7
8
9
10
11
<!--生成短信代码webservice START-->
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>commons-discovery</groupId>
            <artifactId>commons-discovery</artifactId>
            <version>0.2</version>
        </dependency>

webservice方式实现(IDEA)

①创建一个新的包,鼠标点击此包
②找到generate点击

③会出现以下界面,这里要注意 WSDL URL 地址要改为(短信平台请求接口地址,后边要加问号和wsdl ) 并也要更改Apache Axis 为 Glassfish /JAX-WS

④更改后出现此界面,点击OK后 , 会在新创建的包下出现idea自动创建的文件 .

⑤此时把.class文件删除就好了,留下此三个文件(注意:SMSNewAllService类可以理解为打通webservice接口的实现类)

⑥业务实现及调用

复制代码

package com.enn.claim.config.sms;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * 获取配置文件中: 发送短信平台地址/账号/密码/短信类型/费用部门等 参数
 */
@Component
@ConfigurationProperties(prefix = "send-messages")
public class SmsProperties {

private String address;
    private String userName;
    private String passWord;
    private String smsType;
    private String feeDept;

public String getAddress() {
        return address;
    }

public void setAddress(String address) {
        this.address = address;
    }

public String getUserName() {
        return userName;
    }

public void setUserName(String userName) {
        this.userName = userName;
    }

public String getPassword() {
        return passWord;
    }

public void setPassword(String password) {
        this.passWord = password;
    }

public String getSmsType() {
        return smsType;
    }

public void setSmsType(String smsType) {
        this.smsType = smsType;
    }

public String getFeeDept() {
        return feeDept;
    }

public void setFeeDept(String feeDept) {
        this.feeDept = feeDept;
    }

@Override
    public String toString() {
        return "SmsProperties{" +
                "address='" + address + ''' +
                ", userName='" + userName + ''' +
                ", passWord='" + passWord + ''' +
                ", smsType='" + smsType + ''' +
                ", feeDept='" + feeDept + ''' +
                '}';
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package com.enn.claim.config.sms;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * 获取配置文件中: 发送短信平台地址/账号/密码/短信类型/费用部门等 参数
 */
@Component
@ConfigurationProperties(prefix = "send-messages")
public class SmsProperties {

    private String address;
    private String userName;
    private String passWord;
    private String smsType;
    private String feeDept;


    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return passWord;
    }

    public void setPassword(String password) {
        this.passWord = password;
    }

    public String getSmsType() {
        return smsType;
    }

    public void setSmsType(String smsType) {
        this.smsType = smsType;
    }

    public String getFeeDept() {
        return feeDept;
    }

    public void setFeeDept(String feeDept) {
        this.feeDept = feeDept;
    }

    @Override
    public String toString() {
        return "SmsProperties{" +
                "address='" + address + ''' +
                ", userName='" + userName + ''' +
                ", passWord='" + passWord + ''' +
                ", smsType='" + smsType + ''' +
                ", feeDept='" + feeDept + ''' +
                '}';
    }
}

复制代码

/**
     * 发送短信
     * @param sendMessageVo
     * @return
     */
    @Override
    public SendSmsResult sendMessage(SendSmsVo sendMessageVo) {
        // 0.参数校验
        sendMessageVo = this.validParams(sendMessageVo);
        // 1.创建返回结果集
        SendSmsResult smsResult = new SendSmsResult();
        try {
            //2.拼装发送手机号码
            String mobiles = "";
            for (int i = 0; i < sendMessageVo.getMobile().size(); i++) {
                if (i == 0) {
                    mobiles = sendMessageVo.getMobile().get(i);
                } else {
                    mobiles = mobiles + "," + sendMessageVo.getMobile().get(i);
                }
            }
            //3.发送短信
            log.info("开始请求发送短信>>>>>>>>>>>>>>>>>>"+"开始发送短信");
            SMSNewAllService service = new SMSNewAllService();
            ISMSNewAll ismsNewAll = service.getISMSNewAllPort();
            String resultSend = ismsNewAll.sendSMSWithExt(smsProperties.getUserName(), smsProperties.getPassword(), mobiles, sendMessageVo.getSmsBody(), smsProperties.getSmsType(), sendMessageVo.getReplyFlag(), smsProperties.getFeeDept(), sendMessageVo.getAllowStartTime(), sendMessageVo.getAllowEndTime(), sendMessageVo.getDeadLineTime(), sendMessageVo.getAppointTime(), sendMessageVo.getArea(), sendMessageVo.getExtCode());
            log.info("请求发送短信返回值>>>>>>>>>>>>>>>>>>{}: "+resultSend);

//4.判断返回结果
            if (ObjectUtils.isEmpty(resultSend)) {
                return SmsResultUtil.error("请求发送短信失败，短信服务商无响应!");
            }
            //5.处理返回信息
            JSONObject jsonObject = JSONObject.parseObject(resultSend);
            String errorCode = jsonObject.get("errorCode").toString();
            String status = jsonObject.get("status").toString();
            if ("0".equals(errorCode) && "ok".equals(status)) {
                String msgInfo = jsonObject.getString("msgInfo");
                smsResult = SmsResultUtil.returnMessage(SmsConstants.SystemCode.OK, SmsConstants.MessageCode.SUCCESS_CODE, SmsConstants.MessageMsg.SUCCESS_MSG, msgInfo);
                return smsResult;
            } else {
                String errorMsg = jsonObject.getString("errorMsg");
                smsResult = SmsResultUtil.returnMessage(SmsConstants.SystemCode.ERROR, SmsConstants.MessageCode.FAIL_CODE, "请求发送短信失败，服务商返回错误信息为：" + errorMsg, "");
                return smsResult;
            }

}catch (Exception e){
            log.info("请求发送短信失败，系统异常{}", e);
            e.printStackTrace();
            return SmsResultUtil.error("请求发送短信失败，系统异常!");
        }finally {
            log.info("发送短信结果{}", JSONObject.toJSONString(smsResult));
        }
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/**
     * 发送短信
     * @param sendMessageVo
     * @return
     */
    @Override
    public SendSmsResult sendMessage(SendSmsVo sendMessageVo) {
        // 0.参数校验
        sendMessageVo = this.validParams(sendMessageVo);
        // 1.创建返回结果集
        SendSmsResult smsResult = new SendSmsResult();
        try {
            //2.拼装发送手机号码
            String mobiles = "";
            for (int i = 0; i < sendMessageVo.getMobile().size(); i++) {
                if (i == 0) {
                    mobiles = sendMessageVo.getMobile().get(i);
                } else {
                    mobiles = mobiles + "," + sendMessageVo.getMobile().get(i);
                }
            }
            //3.发送短信
            log.info("开始请求发送短信>>>>>>>>>>>>>>>>>>"+"开始发送短信");
            SMSNewAllService service = new SMSNewAllService();
            ISMSNewAll ismsNewAll = service.getISMSNewAllPort();
            String resultSend = ismsNewAll.sendSMSWithExt(smsProperties.getUserName(), smsProperties.getPassword(), mobiles, sendMessageVo.getSmsBody(), smsProperties.getSmsType(), sendMessageVo.getReplyFlag(), smsProperties.getFeeDept(), sendMessageVo.getAllowStartTime(), sendMessageVo.getAllowEndTime(), sendMessageVo.getDeadLineTime(), sendMessageVo.getAppointTime(), sendMessageVo.getArea(), sendMessageVo.getExtCode());
            log.info("请求发送短信返回值>>>>>>>>>>>>>>>>>>{}: "+resultSend);

            //4.判断返回结果
            if (ObjectUtils.isEmpty(resultSend)) {
                return SmsResultUtil.error("请求发送短信失败，短信服务商无响应!");
            }
            //5.处理返回信息
            JSONObject jsonObject = JSONObject.parseObject(resultSend);
            String errorCode = jsonObject.get("errorCode").toString();
            String status = jsonObject.get("status").toString();
            if ("0".equals(errorCode) && "ok".equals(status)) {
                String msgInfo = jsonObject.getString("msgInfo");
                smsResult = SmsResultUtil.returnMessage(SmsConstants.SystemCode.OK, SmsConstants.MessageCode.SUCCESS_CODE, SmsConstants.MessageMsg.SUCCESS_MSG, msgInfo);
                return smsResult;
            } else {
                String errorMsg = jsonObject.getString("errorMsg");
                smsResult = SmsResultUtil.returnMessage(SmsConstants.SystemCode.ERROR, SmsConstants.MessageCode.FAIL_CODE, "请求发送短信失败，服务商返回错误信息为：" + errorMsg, "");
                return smsResult;
            }

        }catch (Exception e){
            log.info("请求发送短信失败，系统异常{}", e);
            e.printStackTrace();
            return SmsResultUtil.error("请求发送短信失败，系统异常!");
        }finally {
            log.info("发送短信结果{}", JSONObject.toJSONString(smsResult));
        }
    }