进入目标:

(1)掌握Spring Boot 框架的搭建方法

(2)能够使用阿里大于发送短信

(3)运用 Spring Boot、阿里大于和ActiveMQ 开发短信微服务

(4)完成品优购用户注册功能(短信验证码认证)

 

目录

1、短信微服务

1.1 需求分析

1.2 搭建工程

2、用户注册

2.1 需求分析

2.2 工程搭建(参考其他服务层工程和WEB层)

2.3 基本注册功能实现

2.4 用户注册-发送短信验证码

2.5 用户注册-校验短信验证码


 

1、短信微服务

 

1.1 需求分析

构建一个通用的短信发送服务(独立于品优购的单独工程),接收activeMQ的消息(MAP类型)  消息包括手机号(mobile)、短信模板号(template_code)、签名(sign_name)、参数字符串(param)

 

1.2 搭建工程

(1)创建spring boot工程,并引入相关依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xushuai</groupId>
    <artifactId>sms-service</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.0.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-activemq</artifactId>
        </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <version>3.2.5</version>
        </dependency>

    </dependencies>

</project>

(2)创建引导类

package com.xushuai.sms;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 短信服务 引导类
 * Author xushuai
 * Description
 */
@SpringBootApplication
public class Application {

    public static void main(String[] args){
        SpringApplication.run(Application.class, args);
    }
}

(3)创建配置文件(application.properties),填入accessKey的相关信息

server.port=9003
spring.activemq.broker-url=tcp://192.168.25.170:61616
accessKeyId=accessKeyId
accessKeySecret=accessKeySecret

(4)复制阿里大于的API Demo工程中的SmsDemo,然后进行修改

package com.xushuai.sms.util;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsResponse;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.dysmsapi.transform.v20170525.SendSmsResponseUnmarshaller;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.UUID;

/**
 * 短信API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
 * 执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
 * 工程依赖了2个jar包(存放在工程的libs目录下)
 * 1:aliyun-java-sdk-core.jar
 * 2:aliyun-java-sdk-dysmsapi.jar
 *
 * 备注:Demo工程编码采用UTF-8
 * 国际短信发送请勿参照此DEMO
 */
@Component
public class SmsUtil {

    //产品名称:云通信短信API产品,开发者无需替换
    static final String product = "Dysmsapi";
    //产品域名,开发者无需替换
    static final String domain = "dysmsapi.aliyuncs.com";

    // TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
    @Autowired
    private Environment env;

    public SendSmsResponse sendSms(String mobile, String templateCode, String signName, String param) throws ClientException {
        // 获取AK
        String accessKeyId = env.getProperty("accessKeyId");
        String accessKeySecret = env.getProperty("accessKeySecret");
        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");

        //初始化acsClient,暂不支持region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);

        //组装请求对象-具体描述见控制台-文档部分内容
        SendSmsRequest request = new SendSmsRequest();
        //必填:待发送手机号
        request.setPhoneNumbers(mobile);
        //必填:短信签名-可在短信控制台中找到
        request.setSignName(signName);
        //必填:短信模板-可在短信控制台中找到
        request.setTemplateCode(templateCode);
        //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
        request.setTemplateParam(param);

        //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
        //request.setSmsUpExtendCode("90997");

        //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
        request.setOutId("yourOutId");

        //hint 此处可能会抛出异常,注意catch
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);

        return sendSmsResponse;
    }


    public QuerySendDetailsResponse querySendDetails(String mobile, String bizId) throws ClientException {
        // 获取AK
        String accessKeyId = env.getProperty("accessKeyId");
        String accessKeySecret = env.getProperty("accessKeySecret");
        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");

        //初始化acsClient,暂不支持region化
        IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
        DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
        IAcsClient acsClient = new DefaultAcsClient(profile);

        //组装请求对象
        QuerySendDetailsRequest request = new QuerySendDetailsRequest();
        //必填-号码
        request.setPhoneNumber(mobile);
        //可选-流水号
        request.setBizId(bizId);
        //必填-发送日期 支持30天内记录查询,格式yyyyMMdd
        SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
        request.setSendDate(ft.format(new Date()));
        //必填-页大小
        request.setPageSize(10L);
        //必填-当前页码从1开始计数
        request.setCurrentPage(1L);

        //hint 此处可能会抛出异常,注意catch
        QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);

        return querySendDetailsResponse;
    }
}

(5)编写 activeMQ监听器类

package com.xushuai.sms.listener;

import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.exceptions.ClientException;
import com.xushuai.sms.util.SmsUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jms.annotation.JmsListener;
import org.springframework.stereotype.Component;

import java.util.Map;

/**
 * 发送短信监听器
 * Author xushuai
 * Description
 */
@Component
public class SmsListener {

    @Autowired
    private SmsUtil smsUtil;

    @JmsListener(destination = "sms")
    public void sendSms(Map<String, String> map) {
        try {
            SendSmsResponse response = smsUtil.sendSms(map.get("mobile"),
                    map.get("templateCode"),
                    map.get("SignName"),
                    map.get("param"));
            System.out.println(response.getCode());
            System.out.println(response.getMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

 

 

 

 

 

2、用户注册

 

2.1 需求分析

完成用户注册功能

 

 

2.2 工程搭建(参考其他服务层工程和WEB层)

(1)分别为:pinyougou-user-interface、pinyougou-user-service和pinyougou-user-web

 

 

 

2.3 基本注册功能实现

(1)后端:服务层实现,修改UserServicceImpl中的add方法的逻辑

	/**
	 * 增加
	 */
	@Override
	public void add(TbUser user) {
		// 补全数据
		// 创建和更新时间
		user.setCreated(new Date());
		user.setUpdated(new Date());
		// 注册来源
		user.setSourceType(TbUser.SOURCE_TYPE_PC);
		// 对密码进行加密
		String md5Hex = DigestUtils.md5Hex(user.getPassword());
		user.setPassword(md5Hex);

		userMapper.insert(user);		
	}

(2)前端:引入JS文件和基础指令

(3)前端:在userController.js中新增方法

    // 注册方法
    $scope.reg = function () {
        if ($scope.entity == null || $scope.entity.username == null || $scope.entity.username.trim() == '' ||
            $scope.entity.password == null || $scope.entity.password.trim() == '' || $scope.entity.phone == null ||
            $scope.entity.phone.trim() == '') {
            alert("请完成填写您的资料");
            return ;
        }

        if ($scope.entity.password != $scope.password) {
            alert("两次输入的密码不一致!");
            return ;
        }
        // alert(JSON.stringify($scope.entity));
        userService.add($scope.entity).success(
            function (rtn) {
                alert(rtn.message);
            }
        );
    }

 

(4)前端:页面绑定变量和单击事件

 

 

 

2.4 用户注册-发送短信验证码

(1)实现思路

点击页面上的”获取短信验证码”连接,向后端传递手机号。后端随机生成6位数字作为短信验证码,将其保存在redis中(手机号作为KEY),并发送到短信网关。

用户注册时,后端根据手机号查询redis中的验证码与用户填写的验证码是否相同,如果不同则提示用户不能注册。

 

(2)后端:服务层接口,在UserService中新增方法

	/**
	 * 发送短信验证码
	 * 
	 * @param phone 接收验证码的手机号
	 */
	void sendSmsCode(String phone);

(3)后端:服务层实现,在UserServiceImpl中实现

    @Override
    public void sendSmsCode(final String phone) {
        // 生成6位数字验证码
        final String code = String.valueOf((long) (Math.random() * 1000000));
        // 将验证码放入redis缓存,以手机号为key
        redisTemplate.boundHashOps("smsCode").put(phone, code);
        // 发送短信消息
        System.out.println("验证码:" + code);
        jmsTemplate.send(smsDestination, new MessageCreator() {
            @Override
            public Message createMessage(Session session) throws JMSException {
                MapMessage message = session.createMapMessage();
                message.setString("mobile", phone);
                message.setString("templateCode", templateCode);
                message.setString("signName",signName);
                // 设置替换参数
                Map<String, String> map = new HashMap<>();
                map.put("code", code);
                message.setString("param", JSON.toJSONString(map));

                return message;
            }
        });
    }

注意:需要配置常量到properties配置文件

(4)后端:控制层,在UserController中新增方法

    /**
     * 发送短信验证码
     */
    @RequestMapping("/sendCode")
    public Result sendCode(String phone) {
        try {
            // 校验phone是否合法
            if (!PhoneFormatCheckUtils.isPhoneLegal(phone)) {
                return Result.error("手机号格式不正确");
            }
            userService.sendSmsCode(phone);
            return Result.success("发送成功");
        }catch (Exception e){
            e.printStackTrace();
            return Result.error("验证码发送异常");
        }
    }

(5)前端:userService.js中新增方法

	// 发送短信验证码
	this.sendCode = function (phone) {
		return $http.get('../user/sendCode.do?phone=' + phone);
    }

(6)前端:userController.js新增方法

    // 发送短信验证码
    $scope.sendCode = function () {
        if ($scope.entity.phone == null || $scope.entity.phone.trim() == "") {
            alert("请正确填写手机号!");
            return ;
        }
        userService.sendCode($scope.entity.phone).success(
            function (rtn) {
                alert(rtn.message);
            }
        );
    }

(7)页面绑定单击事件

 

 

2.5 用户注册-校验短信验证码

(1)后端:服务层接口,UserService中新增方法

    /**
     * 判断用户输入的验证码是否正确
     *
     * @param phone 接收短信的手机号
     * @param code  用户输入的验证码
     * @return boolean
     */
    boolean checkSmsCode(String phone, String code);

(2)后端:服务层实现,UserServiceImpl实现

    @Override
    public boolean checkSmsCode(String phone, String code) {
	    // 通过手机号,从redis中获取验证码
        String smsCode = (String) redisTemplate.boundHashOps("smsCode").get(phone);
        if (smsCode == null || smsCode.trim().equals("")) {
            return false;
        }
        // 判断验证码是否正确
        return code.equals(smsCode);
    }

(3)后端:控制层,修改UserController中的add方法

    /**
     * 增加
     *
     * @param user    用户资料
     * @param smsCode 验证码
     * @return
     */
    @RequestMapping("/add")
    public Result add(@RequestBody TbUser user, String smsCode) {
        try {
            // 校验短信验证码
            if (!userService.checkSmsCode(user.getPhone(), smsCode)) {
                return Result.error("验证码错误!");
            }
            userService.add(user);
            return new Result(true, "注册成功");
        } catch (Exception e) {
            e.printStackTrace();
            return new Result(false, "注册失败");
        }
    }

(4)前端:修改userService.js中的add方法

	//增加
	this.add=function(entity,smsCode){
		return  $http.post('../user/add.do?smsCode=' + smsCode,entity );
	}

(5)前端:修改userController.js中的reg方法

(6)前端:页面绑定变量

 

 

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐