基于易水公共组件的验证码快速入门教程

通过使用易水公共组件吗,实现快速导入图形验证码、邮件验证码和短信验证码,并可以进行高度定制化

Posted by yishuifengxiao on 2019-10-31

在日常开发过程中,经常需要使用到验证码功能,在易水风萧通用工具中对常见的 【图形验证码】、【邮箱验证码】、【短信验证码】做一个通用封装。在这三种类型的验证码中,目前仅对图形验证码和邮箱验证码做了缺省性实现,由于短信验证码中短信发送的特殊性,需要用户在开发过程中完成短信发送功能的具体实现。

快速启动

  1. 先引入相关依赖
<dependency>
<groupId>com.yishuifengxiao.common</groupId>
<artifactId>common-spring-boot-starter</artifactId>
<version>4.1.2</version>
</dependency>
  1. 将验证码工具注入到需要使用到验证码的地方

注入代码如下:

@Autowired
private CodeProcessorHolder codeProcessorHolder;

图形验证码

生成图形验证码

在注入一个验证码工具后,通过以下代码即可快速生成一个图形验证码。
具体的示例代码如下:

@GetMapping("/code/image")
@ResponseBody
public Response<String> image(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.IMAGE).create(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

在以上代码后,用户即可通过

http://ip:port/code/image?image=唯一的随机值

获取图形验证码了。

在上述请求中,用户应该将image参数存储起来,因为在校验验证码时需要用到。

验证图形验证码

验证图形验证码的示例代码如下:

@GetMapping("/image/validate")
@ResponseBody
public Response<String> validate(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.IMAGE).validate(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

用户在验证图形验证码时,即可用过

http://ip:port/image/validate?image=唯一的随机值&image_code=验证码内容

来判断验证码是否正确。

【注意】上述请求中image参数的值应该与请求中图形验证码的url中的image参数的值保持一致。

特殊提示:对于前后端部署在一起的单体应用,上述两个请求中的image参数都可以省略掉。

配置参数

除此之外,图形验证码相关的配置有

# 验证码的长度,默认为4
yishuifengxiao.code.image.length=4
# 验证码的失效时间,单位秒,默认为300s
yishuifengxiao.code.image.expireIn=300
# 验证码是否包含字母,默认包含
yishuifengxiao.code.image.isContainLetter=true
# 验证码是否包含数字,默认包含
yishuifengxiao.code.image.isContainNumber=true
# 验证码的请求参数
yishuifengxiao.code.image.codeKey=image
# 验证码对应的值的参数
yishuifengxiao.code.image.codeValue=image_code
# 图形验证码的图形宽度
yishuifengxiao.code.image.width=70
# 图形验证码的图形高度
yishuifengxiao.code.image.height=28

注意:

在生成验证码和验证验证码的请求中,请求参数中的image参数由yishuifengxiao.code.image.codeKey属性,image_code参数由yishuifengxiao.code.image.codeValue属性决定。在某些极端情况下,可以通过这两个配置修改请求参数。

如果服务是部署在阿里云ECS上面,由于阿里云默认关闭了25号端口,因此使用默认的端口发送邮件时会导致邮件验证码发送失败,因此需要提交工单到阿里云申请开启25号端口,或者使用465端口。

邮件验证码

在使用邮箱验证码时,需要先进行下述配置:

  1. 在项目中导入邮件发送相关的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
  1. 在项目的配置文件中加入邮件发送相关的配置属性
spring.mail.default-encoding=UTF-8
spring.mail.host=邮箱服务器
spring.mail.username=完整的邮箱地址
spring.mail.password=密码
spring.mail.port=465
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.connectiontimeout=5000
spring.mail.properties.mail.smtp.timeout=3000
spring.mail.properties.mail.smtp.writetimeout=5000
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
spring.mail.properties.mail.smtp.socketFactory.fallback=false
spring.mail.properties.mail.smtp.socketFactory.port=465
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true

如果不加入以上配置,在使用邮件验证码时会提示 【验证码处理器不存在】,且不能正确发送邮件验证码。

【注意】在阿里云ECS服务器上,25端口默认是关闭的,因此最好配置465端口

发送邮件验证码

邮件验证码的发送代码与图形验证码的发送方法基本一致,只需要将CodeType.IMAGE改成CodeType.EMAIL即可。

@GetMapping("/code/email")
@ResponseBody
public Response<String> email(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.EMAIL).create(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

加入上述配置以后,即可通过

http://ip:port/code/email?email=目标邮箱地址

发送邮箱验证码了。

验证邮箱验证码

示例代码如下:

@GetMapping("/email/validate")
@ResponseBody
public Response<String> validate(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.EMAIL).validate(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

加入上述配置以后,即可通过

http://ip:port/email/validate?email=目标邮箱地址&email_code=验证码

来验证了。

配置参数

除此之外,组件还提供了一些额外的配置

# 验证码的长度,默认为4
yishuifengxiao.code.email.length=4
# 验证码的失效时间,单位秒,默认为1800s
yishuifengxiao.code.email.expireIn=1800
# 验证码是否包含字母,默认包含
yishuifengxiao.code.email.isContainLetter=true
# 验证码是否包含数字,默认包含
yishuifengxiao.code.email.isContainNumber=true
# 验证码的请求参数
yishuifengxiao.code.email.codeKey=email
# 验证码对应的值的参数
yishuifengxiao.code.email.codeValue=email_code

类似地,验证码的请求参数中的email参数由yishuifengxiao.code.email.codeKey属性,email_code参数由yishuifengxiao.code.email.codeValue属性决定。

进阶配置

在邮件验证码功能中,组件对邮箱验证码做了一个缺省性实现,在用户对邮件验证码的格式有自定义需求时,可以通过在spring中注入一个名为emailCodeSender的实例来实现自己的模板内容。

示例代码如下

@Component("emailCodeSender")
public class EmailCodeSender implements CodeSender<EmailCode> {

@Override
public void send(String target, EmailCode emailCode, CodeType codeType){
//实现自己的发送逻辑
}
}

短信验证码

由于短信验证码的特殊性,不同的短信提供商有不同的发送接口,因此在使用短信验证码功能之前,需要完成自己的名为 smsCodeSender短信发送器,并将其注入到spring上下文之中。

示例代码如下

@Component("smsCodeSender")
public class SmsCodeSender implements CodeSender<SmsCode> {

@Override
public void send(String target, EmailCode emailCode, CodeType codeType){
//实现自己的发送逻辑
}
}

发送短信验证码

在完成前置配置之后,即可发送短信验证码了。

示例代码如下

@GetMapping("/code/sms")
@ResponseBody
public Response<String> sms(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.SMS).create(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

加入上述配置以后,即可通过

http://ip:port/code/sms?phone=目标手机号

发送邮箱验证码了。

验证短信验证码

示例代码如下:

@GetMapping("/sms/validate")
@ResponseBody
public Response<String> validate(HttpServletRequest request, HttpServletResponse response){
try {
codeProcessorHolder.findValidateCodeProcessor(CodeType.SMS).validate(new ServletWebRequest(request,response));
} catch (ValidateException e) {
return Response.error(e.getMessage());
}
return Response.suc();
}

加入上述配置以后,即可通过

http://ip:port/sms/validate?phone=目标手机号&phone_code=验证码

来验证了。

参数配置

# 验证码的长度,默认为4
yishuifengxiao.code.sms.length=4
# 验证码的失效时间,单位秒,默认为300s
yishuifengxiao.code.sms.expireIn=300
# 验证码是否包含字母,默认包含
yishuifengxiao.code.sms.isContainLetter=true
# 验证码是否包含数字,默认包含
yishuifengxiao.code.sms.isContainNumber=true
# 验证码的请求参数
yishuifengxiao.code.sms.codeKey=phone
# 验证码对应的值的参数
yishuifengxiao.code.sms.codeValue=phone_code

类似地,验证码的请求参数中的phone参数由yishuifengxiao.code.sms.codeKey属性,phone_code参数由yishuifengxiao.code.sms.codeValue属性决定。

验证码的更多用法请参见以下资源

资源链接

易水公共组件官方文档地址http://doc.yishuifengxiao.com

易水公共组件源码地址https://gitee.com/zhiyubujian/common-starter

易水风萧个人博客 http://www.yishuifengxiao.com

相关博客

  1. springboot整合单点登录sso

  2. 搭建基于易水公共组件的资源服务器

  3. spring security之获取当前用户信息

  4. 基于易水公共组件的权限管理系统

  5. 基于易水公共组件的验证码快速入门教程


自定义评论 pages