Springboot实现手机短信服务

心已赠人 2023-10-02 19:02 18阅读 0赞

#### 一、首先进入云之讯注册账户 ####

> 链接：[https://office.ucpaas.com/][https_office.ucpaas.com].

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_12_color_FFFFFF_t_70_g_se_x_16]

> 进入开发者控制台，获取对应的请求地址、应用ID、用户ID和鉴权token

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16]

> 进行认证

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 1]

> 创建模板

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 2]

#### 二、Springboot集成短信发送 ####

###### 1、Maven依赖 ######

> 阿里的开源框架FastJson，用于JSON格式字符串与JSON对象及javaBean之间的转换

<dependencies>
    	<dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-web</artifactId>
              <version>2.5.1</version>
        </dependency>
        
        <dependency>
             <groupId>com.alibaba</groupId>
             <artifactId>fastjson</artifactId>
             <version>1.2.56</version>
    	</dependency>
    </dependencies>

2、application.properties

# 短信服务
    # 应用ID
    message.appId= xxxxxxxxxxxxxxxxxxxx
    # 用户sid
    message.account.sid= xxxxxxxxxxxxxxxxxxxx
    # 鉴权token
    message.auth.token= xxxxxxxxxxxxxxxxxxxx
    # 请求地址
    message.rest.url= https://open.ucpaas.com/ol/sms/{function}
    # 默认手机号
    message.default.phone = xxxxxxxxxxx
    # 默认模板
    message.defaule.templateId = xxxxxx

<table> 
 <thead> 
  <tr> 
   <th>功能</th> 
   <th>接口</th> 
   <th>请求地址</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>发送短信</td> 
   <td>指定模板单发</td> 
   <td>https://open.ucpaas.com/ol/sms/sendsms</td> 
   <td>指定变量/固定模板单发</td> 
  </tr> 
  <tr> 
   <td>~</td> 
   <td>指定模板群发</td> 
   <td>https://open.ucpaas.com/ol/sms/sendsms_batch</td> 
   <td>指定变量/固定模板群发</td> 
  </tr> 
  <tr> 
   <td>状态报告</td> 
   <td>推送状态报告</td> 
   <td>/</td> 
   <td>实时推送短信发送状态报告。</td> 
  </tr> 
  <tr> 
   <td>模板接口</td> 
   <td>增加模板</td> 
   <td>https://open.ucpaas.com/ol/sms/addsmstemplate</td> 
   <td>通过接口增加模板</td> 
  </tr> 
  <tr> 
   <td>~</td> 
   <td>查询模板</td> 
   <td>https://open.ucpaas.com/ol/sms/getsmstemplate</td> 
   <td>获取账户内的全部模板</td> 
  </tr> 
  <tr> 
   <td>~</td> 
   <td>编辑模板</td> 
   <td>https://open.ucpaas.com/ol/sms/editsmstemplate</td> 
   <td>编辑指定模板</td> 
  </tr> 
  <tr> 
   <td>~</td> 
   <td>删除模板</td> 
   <td>https://open.ucpaas.com/ol/sms/deletesmstemplate</td> 
   <td>删除指定模板</td> 
  </tr> 
 </tbody> 
</table>

###### 3、配置类 ######

public class MessageConfig implements Serializable {
        
        /**
         *  应用ID
         */
        @Value("${message.appId}")
        private String appId;
    
        /**
         * 用户sid
         */
        @Value("${message.account.sid}")
        private String accountSid;
    
        /**
         *  鉴权密钥
         */
        @Value("${message.auth.token}")
        private String authToken;
    
        /**
         *  请求地址
         */
        @Value("${message.rest.url}")
        private String restUrl;
    
        /**
         *  短信模板ID
         */
        @Value("${message.default.templateId}")
        private String templateId;
    
        /**
         *  手机号
         */
        @Value("${message.default.phone}")
        private String phone;
    
        public String getAppId() {
        
            return appId;
        }
    
        public void setAppId(String appId) {
        
            this.appId = appId;
        }
    
        public String getAccountSid() {
        
            return accountSid;
        }
    
        public void setAccountSid(String accountSid) {
        
            this.accountSid = accountSid;
        }
    
        public String getAuthToken() {
        
            return authToken;
        }
    
        public void setAuthToken(String authToken) {
        
            this.authToken = authToken;
        }
    
        public String getRestUrl() {
        
            return restUrl;
        }
    
        public void setRestUrl(String restUrl) {
        
            this.restUrl = restUrl;
        }
    
        public String getTemplateId() {
        
            return templateId;
        }
    
        public void setTemplateId(String templateId) {
        
            this.templateId = templateId;
        }
    
        public String getPhone() {
        
            return phone;
        }
    
        public void setPhone(String phone) {
        
            this.phone = phone;
        }
    }

###### 4、RestTemplate配置类 ######

/**
     *  RestTemplate配置类
     */
    @Configuration
    public class RestTemplateConfig {
        
        @Bean
        public RestTemplate restTemplate() {
        
            return new RestTemplate();
        }
    }

###### 5、SendMessageService ######

public interface SendMessageService {
        
            /**
             *  单发短信
             *
             * @param messageConfig 短信配置
             * @return
             */
            String sendMessage(MessageConfig messageConfig);
    
            /**
             * 群发短信
             *
             * @param messageConfig 短信配置
             * @return
             */
            String sendBatchMessage(MessageConfig messageConfig);
    }

###### 6、SendMessageServiceImpl ######

@Service
    public class SendMessageServiceImpl implements SendMessageService {
        
    
        private static final Logger logger = LoggerFactory.getLogger(SendMessageServiceImpl.class);
    
        @Autowired
        private RestTemplate restTemplate;
    
        @Override
        public String sendMessage(MessageConfig messageConfig) {
        
            logger.info("sendMessage start,{}", JavaBeanUtil.jacksonToString(messageConfig));
            Assert.notNull(messageConfig,"发送短信配置不能为空");
            //单发邮件API
            String url = messageConfig.getRestUrl()+"sendsms";
            //使用restTemplate进行访问远程服务
            HttpHeaders headers = new HttpHeaders();
            headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
            HttpEntity<String> httpEntity = new HttpEntity<String>(getParameter(messageConfig),headers);
            return restTemplate.patchForObject(url,httpEntity,String.class);
        }
    
        @Override
        public String sendBatchMessage(MessageConfig messageConfig) {
        
            logger.info("sendBatchMessage start,{}", JavaBeanUtil.jacksonToString(messageConfig));
            Assert.notNull(messageConfig,"发送短信配置不能为空");
            //群发邮件API
            String url = messageConfig.getRestUrl()+"sendsms_batch";
            HttpHeaders headers = new HttpHeaders();
            headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
            HttpEntity<String> httpEntity = new HttpEntity<String>(getParameter(messageConfig),headers);
            return restTemplate.patchForObject(url,httpEntity,String.class);
        }
    
        /**
         * 配置发送参数
         *
         * @param messageConfig
         * @return
         */
        public String getParameter(MessageConfig messageConfig) {
        
            JSONObject jsonObject = new JSONObject();
            //基础配置
            jsonObject.put("sid",messageConfig.getAccountSid());
            jsonObject.put("token",messageConfig.getAuthToken());
            jsonObject.put("appid",messageConfig.getAppId());
            //模板ID 参数之间用逗号作为间隔符
            jsonObject.put("template",messageConfig.getTemplateId());
            //要发送的手机号,多个手机号用逗号分隔
            jsonObject.put("mobile",messageConfig.getPhone());
            //用户ID，随状态报告返回,可以不填写
            jsonObject.put("uid","");
            return JSONObject.toJSONString(jsonObject);
        }
    }

###### 7、SendMessageController ######

@RestController
    @ResponseResult//用于对接口响应体进行包装的注解
    @RequestMapping("/send-message")
    @Api(value = "发送短信接口",tags = {
        "发送短信接口"})
    public class SendMessageController {
        
        @Autowired
        private SendMessageService sendMessageService;
    
        @PostMapping("/simple")
        @ApiOperation(value = "单发消息",notes = "单发手机短信消息")
        public String sendMessage(MessageConfig messageConfig) {
        
            return sendMessageService.sendMessage(messageConfig);
        }
    
        @PostMapping("/batch")
        @ApiOperation(value = "群发消息",notes = "群发手机短信消息")
        public String sendBatchMessage(MessageConfig messageConfig) {
        
            return sendMessageService.sendBatchMessage(messageConfig);
        }
    }

[https_office.ucpaas.com]: https://office.ucpaas.com/
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_12_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/1a33e90f9af24beca1c40e859a9f3285.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_12,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/0672adda132f42c3b20cfc3ab0ad9194.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/3a84ec419f594c8faa070150f9229586.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA54ix5omT576955CD55qE56CB54y_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/b68ad917980e4f649d9ec09c3870227c.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA54ix5omT576955CD55qE56CB54y_,size_20,color_FFFFFF,t_70,g_se,x_16