引言
在上一节《淘东电商项目(13) -项目整合WxJava》,主要讲解如何把WxJava框架整合到我们的电商项目,并完成了“鹦鹉学舌”的功能。
代码已提交至Github(版本号:
ce86c77b326b8f0a7cc9504b989346aa5a293496
),有兴趣的同学可以下载来看看:https://github.com/ylw-github/taodong-shop
本文主要实现「注册码功能」。在公众号里输入手机号码获取注册码的功能,验证注册码的功能。
本文目录结构:
l____引言
l____ 1. 开发前准备
l________ 1.1 注册码功能开发思路
l________ 1.2 Redis服务器搭建
l________ 1.3 开发前项目结构整理
l____ 2.注册功能开发
l________ 2.1 注册码功能开发
l____________ 2.1.1 Redis封装
l____________ 2.1.2 正则表达式工具类
l____________ 2.1.3 MsgHandler注册码处理
l________ 2.2 验证注册码
l____ 3.测试
l________ 3.1 获取注册码
l________ 3.2 校验注册码
l____总结
1.开发前准备
1.1 注册码功能开发思路
本文的开发流程主要如下:
1.2 Redis服务器搭建
之前在《分布式系列教程》里讲过Redis的安装教程,本文不再具体详述,大家可以参考:
本文不复杂化,使用单个Redis服务器。
- redis服务器地址:192.168.162.136
命令:
## 启动命令
/usr/local/redis/bin/redis-server /usr/local/redis/etc/redis.conf
## 停止命令
/usr/local/redis/bin/redis-cli -h 127.0.0.1 -p 6379 -a "123" shutdown
## 连接Redis客户端
/usr/local/redis/bin/redis-cli -h 127.0.0.1 -p 6379 -a "123"
使用Medis连接,下面是连接成功的界面(如果不知道如何使用Medis可以参考我的博客《Mac下安装与使用Medis》):
1.3 开发前项目结构整理
目前项目结构是这样的:
其实项目结构还可以优化的,有两点:
- 将服务接口层的
实体类
抽出到一个模块,专门用来管理实体类。 - 统一规定微服务接口状态码
整理后的结构如下:
BaseResponse代码如下:
import lombok.Data;
/**
* description: 微服务接口封装,T为返回接口data的数据类型
* create by: YangLinWei
* create time: 2020/2/20 11:49 上午
*/
@Data
public class BaseResponse<T> {
private Integer rtnCode;
private String msg;
private T data;
public BaseResponse() {
}
public BaseResponse(Integer rtnCode, String msg, T data) {
super();
this.rtnCode = rtnCode;
this.msg = msg;
this.data = data;
}
}
BaseApiService代码如下:
/**
* description: 统一返回code信息
* create by: YangLinWei
* create time: 2020/2/20 11:48 上午
*/
@Data
@Component
public class BaseApiService<T> {
public BaseResponse<T> setResultError(Integer code, String msg) {
return setResult(code, msg, null);
}
// 返回错误,可以传msg
public BaseResponse<T> setResultError(String msg) {
return setResult(Constants.HTTP_RES_CODE_500, msg, null);
}
// 返回成功,可以传data值
public BaseResponse<T> setResultSuccess(Object data) {
return setResult(Constants.HTTP_RES_CODE_200, Constants.HTTP_RES_CODE_200_VALUE, data);
}
// 返回成功,沒有data值
public BaseResponse<T> setResultSuccess() {
return setResult(Constants.HTTP_RES_CODE_200, Constants.HTTP_RES_CODE_200_VALUE, null);
}
// 返回成功,沒有data值
public BaseResponse<T> setResultSuccess(String msg) {
return setResult(Constants.HTTP_RES_CODE_200, msg, null);
}
// 通用封装
public BaseResponse<T> setResult(Integer code, String msg, Object data) {
return new BaseResponse(code, msg, data);
}
}
2.注册功能开发
在上一节《淘东电商项目(13) -项目整合WxJava》,已经WxJava框架整合到我们的电商项目,并在MsgHandler
类里面处理收到的信息,完成了“鹦鹉学舌”的功能,下面开始讲解如何实现注册码功能。
2.1 注册码功能开发
2.1.1 Redis封装
1.添加maven依赖(taodong-shop-common-core
模块里添加):
<!-- 集成redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
2.在业务模块(taodong-shop-service-weixin
)配置redis(也可以配置到Apollo配置中心):
###服务名称(服务注册到eureka名称)
spring:
application:
name: taodong-shop-service-weixin
redis:
host: 192.168.162.136
port: 6379
jedis:
pool:
max-idle: 100
min-idle: 1
max-active: 1000
max-wait: -1
### 公众号默认回复消息
taodong:
weixin:
registration:
code:
###微信注册码消息
message: 您的注册码为:%s
###默认提示消息
default:
registration:
code:
message: 我们已经收到您的消息,将有客服会及时回复您的!
3.定义RedisUtil
工具类(taodong-shop-common-core
模块里添加):
/**
* description: Redis工具类
* create by: YangLinWei
* create time: 2020/2/20 1:57 下午
*/
@Component
public class RedisUtil {
@Autowired
private StringRedisTemplate stringRedisTemplate;
/**
* 存放string类型
*
* @param key
* key
* @param data
* 数据
* @param timeout
* 超时间
*/
public void setString(String key, String data, Long timeout) {
stringRedisTemplate.opsForValue().set(key, data);
if (timeout != null) {
stringRedisTemplate.expire(key, timeout, TimeUnit.SECONDS);
}
}
/**
* 存放string类型
*
* @param key
* key
* @param data
* 数据
*/
public void setString(String key, String data) {
setString(key, data, null);
}
/**
* 根据key查询string类型
*
* @param key
* @return
*/
public String getString(String key) {
String value = stringRedisTemplate.opsForValue().get(key);
return value;
}
/**
* 根据对应的key删除key
*
* @param key
*/
public void delKey(String key) {
stringRedisTemplate.delete(key);
}
}
2.1.2 正则表达式工具类
定义RegexUtil
工具类(taodong-shop-common-core
模块里添加):
/**
* description: 正则表达式工具类
* create by: YangLinWei
* create time: 2020/2/20 1:56 下午
*/
public class RegexUtils {
/**
* 验证Email
*
* @param email email地址,格式:[email protected],[email protected],
* xxx代表邮件服务商
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkEmail(String email) {
String regex = "\\w+@\\w+\\.[a-z]+(\\.[a-z]+)?";
return Pattern.matches(regex, email);
}
/**
* 验证身份证号码
*
* @param idCard 居民身份证号码15位或18位,最后一位可能是数字或字母
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkIdCard(String idCard) {
String regex = "[1-9]\\d{13,16}[a-zA-Z0-9]{1}";
return Pattern.matches(regex, idCard);
}
/**
* 验证手机号码(支持国际格式,+86135xxxx...(中国内地),+00852137xxxx...(中国香港))
*
* @param mobile 移动、联通、电信运营商的号码段
* <p>
* 移动的号段:134(0-8)、135、136、137、138、139、147(预计用于TD上网卡)
* 、150、151、152、157(TD专用)、158、159、187(未启用)、188(TD专用) 177 170 166
* 开头
* </p>
* <p>
* 联通的号段:130、131、132、155、156(世界风专用)、185(未启用)、186(3g)
* </p>
* <p>
* 电信的号段:133、153、180(未启用)、189
* </p>
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkMobile(String mobile) {
String regex = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$";
return Pattern.matches(regex, mobile);
}
/**
* 验证固定电话号码
*
* @param phone 电话号码,格式:国家(地区)电话代码 + 区号(城市代码) + 电话号码,如:+8602085588447
* <p>
* <b>国家(地区) 代码 :</b>标识电话号码的国家(地区)的标准国家(地区)代码。它包含从 0 到 9
* 的一位或多位数字, 数字之后是空格分隔的国家(地区)代码。
* </p>
* <p>
* <b>区号(城市代码):</b>这可能包含一个或多个从 0 到 9 的数字,地区或城市代码放在圆括号——
* 对不使用地区或城市代码的国家(地区),则省略该组件。
* </p>
* <p>
* <b>电话号码:</b>这包含从 0 到 9 的一个或多个数字
* </p>
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkPhone(String phone) {
String regex = "(\\+\\d+)?(\\d{3,4}\\-?)?\\d{7,8}$";
return Pattern.matches(regex, phone);
}
/**
* 验证整数(正整数和负整数)
*
* @param digit 一位或多位0-9之间的整数
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkDigit(String digit) {
String regex = "\\-?[1-9]\\d+";
return Pattern.matches(regex, digit);
}
/**
* 验证整数和浮点数(正负整数和正负浮点数)
*
* @param decimals 一位或多位0-9之间的浮点数,如:1.23,233.30
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkDecimals(String decimals) {
String regex = "\\-?[1-9]\\d+(\\.\\d+)?";
return Pattern.matches(regex, decimals);
}
/**
* 验证空白字符
*
* @param blankSpace 空白字符,包括:空格、\t、\n、\r、\f、\x0B
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkBlankSpace(String blankSpace) {
String regex = "\\s+";
return Pattern.matches(regex, blankSpace);
}
/**
* 验证中文
*
* @param chinese 中文字符
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkChinese(String chinese) {
String regex = "^[\u4E00-\u9FA5]+$";
return Pattern.matches(regex, chinese);
}
/**
* 验证日期(年月日)
*
* @param birthday 日期,格式:1992-09-03,或1992.09.03
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkBirthday(String birthday) {
String regex = "[1-9]{4}([-./])\\d{1,2}\\1\\d{1,2}";
return Pattern.matches(regex, birthday);
}
/**
* 验证URL地址
*
* @param url 格式:http://blog.csdn.net:80/xyang81/article/details/7705960? 或
* http://www.csdn.net:80
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkURL(String url) {
String regex = "(https?://(w{3}\\.)?)?\\w+\\.\\w+(\\.[a-zA-Z]+)*(:\\d{1,5})?(/\\w*)*(\\??(.+=.*)?(&.+=.*)?)?";
return Pattern.matches(regex, url);
}
/**
* <pre>
* 获取网址 URL 的一级域
* </pre>
*
* @param url
* @return
*/
public static String getDomain(String url) {
Pattern p = Pattern.compile("(?<=http://|\\.)[^.]*?\\.(com|cn|net|org|biz|info|cc|tv)",
Pattern.CASE_INSENSITIVE);
// 获取完整的域名
// Pattern
// p=Pattern.compile("[^//]*?\\.(com|cn|net|org|biz|info|cc|tv)",
// Pattern.CASE_INSENSITIVE);
Matcher matcher = p.matcher(url);
matcher.find();
return matcher.group();
}
/**
* 匹配中国邮政编码
*
* @param postcode 邮政编码
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkPostcode(String postcode) {
String regex = "[1-9]\\d{5}";
return Pattern.matches(regex, postcode);
}
/**
* 匹配IP地址(简单匹配,格式,如:192.168.1.1,127.0.0.1,没有匹配IP段的大小)
*
* @param ipAddress IPv4标准地址
* @return 验证成功返回true,验证失败返回false
*/
public static boolean checkIpAddress(String ipAddress) {
String regex = "[1-9](\\d{1,2})?\\.(0|([1-9](\\d{1,2})?))\\.(0|([1-9](\\d{1,2})?))\\.(0|([1-9](\\d{1,2})?))";
return Pattern.matches(regex, ipAddress);
}
}
2.1.3 MsgHandler验证码处理
1.在服务模块(taodong-shop-service
)添加Maven依赖:
<dependency>
<groupId>com.ylw.taodong</groupId>
<artifactId>taodong-shop-common-core</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
2.MsgHandler
生成验证码,并把验证码保存到Redis
服务器,完整代码如下:
@Component
public class MsgHandler extends AbstractHandler {
/**
* 发送验证码消息
*/
@Value("${taodong.weixin.registration.code.message}")
private String registrationCodeMessage;
/**
* 默认回复消息
*/
@Value("${taodong.weixin.default.registration.code.message}")
private String defaultRegistrationCodeMessage;
@Autowired
private RedisUtil redisUtil;
@Override
public WxMpXmlOutMessage handle(WxMpXmlMessage wxMessage,
Map<String, Object> context, WxMpService weixinService,
WxSessionManager sessionManager) {
if (!wxMessage.getMsgType().equals(XmlMsgType.EVENT)) {
// TODO 可以选择将消息保存到本地
}
// 当用户输入关键词如“你好”,“客服”等,并且有客服在线时,把消息转发给在线客服
try {
if (StringUtils.startsWithAny(wxMessage.getContent(), "你好", "客服")
&& weixinService.getKefuService().kfOnlineList().getKfOnlineList().size() > 0) {
return WxMpXmlOutMessage.TRANSFER_CUSTOMER_SERVICE().fromUser(wxMessage.getToUser())
.toUser(wxMessage.getFromUser()).build();
}
} catch (WxErrorException e) {
e.printStackTrace();
}
// 1.获取客户端发送的消息
String fromContent = wxMessage.getContent();
// 2.如果客户端发送消息为手机号码,则发送验证码
if (RegexUtils.checkMobile(fromContent)) {
// 3.生成随机四位注册码
int registCode = registCode();
String content = String.format(registrationCodeMessage, registCode);
// 4.将验证码存放在Redis中
redisUtil.setString(Constants.WEIXINCODE_KEY + fromContent, registCode + "", Constants.WEIXINCODE_TIMEOUT);
return new TextBuilder().build(content, wxMessage, weixinService);
}
return new TextBuilder().build(defaultRegistrationCodeMessage, wxMessage, weixinService);
}
// 获取注册码
private int registCode() {
int registCode = (int) (Math.random() * 9000 + 1000);
return registCode;
}
}
2.2 验证注册码
1.定义验证接口(微信服务接口层taodong-shop-service-api-weixin
):
/**
* description: 微信验证服务接口
* create by: YangLinWei
* create time: 2020/2/20 2:22 下午
*/
@Api(tags = "微信注册码验证码接口")
public interface VerificaCodeService {
@ApiOperation(value = "根据手机号码验证码token是否正确")
@GetMapping("/verificaWeixinCode")
@ApiImplicitParams({
// @ApiImplicitParam(paramType="header",name="name",dataType="String",required=true,value="用户的姓名",defaultValue="zhaojigang"),
@ApiImplicitParam(paramType = "query", name = "phone", dataType = "String", required = true, value = "用户手机号码"),
@ApiImplicitParam(paramType = "query", name = "weixinCode", dataType = "String", required = true, value = "微信注册码") })
BaseResponse<JSONObject> verificaWeixinCode(String phone, String weixinCode);
}
2.实现接口(微信业务层taodong-shop-service-weixin
):
@RestController
public class VerificaCodeServiceImpl extends BaseApiService<JSONObject> implements VerificaCodeService {
@Autowired
private RedisUtil redisUtil;
@Override
public BaseResponse<JSONObject> verificaWeixinCode(String phone, String weixinCode) {
if (StringUtils.isEmpty(phone)) {
return setResultError("手机号码不能为空!");
}
if (StringUtils.isEmpty(weixinCode)) {
return setResultError("注册码不能为空!");
}
String code = redisUtil.getString(Constants.WEIXINCODE_KEY + phone);
if (StringUtils.isEmpty(code)) {
return setResultError("注册码已经过期,请重新发送验证码");
}
if (!code.equals(weixinCode)) {
return setResultError("注册码不正确");
}
return setResultSuccess("注册码验证码正确");
}
}
3.测试
启动微信服务:AppWeiXin
3.1 获取注册码
注意:代码里设置微信注册码超时时间为3分钟!
首先发送手机号,可以看到:
发送错误手机号 | 发送正确的手机号 |
---|---|
3.2 校验注册码
我们在Redis可视化窗口里也可以看到:
浏览器输入:http://127.0.0.1:8200/verificaWeixinCode?phone=18688888888&weixinCode=4208
过了3分钟后,刷新Redis可视化窗口,可以看到没有内容了:
浏览器再次输入:http://127.0.0.1:8200/verificaWeixinCode?phone=18688888888&weixinCode=4208,提示注册码已过期