SpringSceurity实现短信验证码功能的示例代码

程序员文章站 2023-08-26 22:58:25

一、思考1、设计思路在获取短信验证码功能和图形验证码还是有很多相似的地方,所以这里在设计获取短信验证的时候，将之前开发好的的图形验证码进一步整合、抽象与重构。在获取验证码的时候,它们最大的不同在于:...

一、思考

1、设计思路

在获取短信验证码功能和图形验证码还是有很多相似的地方,所以这里在设计获取短信验证的时候，将之前开发好的的图形验证码进一步整合、抽象与重构。

在获取验证码的时候,它们最大的不同在于: 图形验证码是通过接口返回获取給前端。而短信验证码而言是通过第三方api向我们手机推送。

但是它们在登陆的时候就有很大的不同了，对于图形验证码而言验证通过之前就走usernamepasswordauthenticationfilter 过滤器了开始校验用户名密码了。

但对于短信登陆而言，确实也需要先现在短信验证码是否通过，但是一旦通过他是不走 usernamepasswordauthenticationfilter，而是通过其它方式查询用户信息来校验

认证已经通过了。

这篇博客只写获取获取短信验证码的功能，不写通过短信验证码登陆的逻辑。

2、重构设计

这里才是最重要的，如何去设计和整合短信验证码和图形验证码的代码,是我们最应该思考的。如何将相似部分抽离出来,然后去实现不相同的部分。

整理后发现不同点主要在于

1、获取验证码。因为对于图形验证码需要有个画布,而短信验证码并不需要,所以它们可以实现同一个接口，来完成不同的逻辑。
2、发送验证码。对于图形验证码来讲只要把验证码返给前端就可以,而短信验证码而言是通过第三方api将验证码发到我们的手机上。
所以这里也可以通过实现统一接口来具体实现不同的方法。

相同部分我可以通过抽象类来完成实现,不同部分可以通过具体的实现类来实现。

SpringSceurity实现短信验证码功能的示例代码

abstractvalidatecodeprocessorservice 抽象类是用来实现两种验证码可以抽离的部分。imagecodeprocessorserviceimpl 和

smscodeprocessorserviceimpl方法是来实现两种验证码不同的发送方式。

在简单看下时序图可能会更加明白点。

SpringSceurity实现短信验证码功能的示例代码

一个接口只有一个方法(processor)就是处理验证码,它其实需要做三件事。

1、获取验证码。2、将验证码存入session。3、将验证码信息通过短信或者图形验证码发送出去。

首先讲生成获取验证码，这里有一个公共接口和两个实现类

SpringSceurity实现短信验证码功能的示例代码

对于保存验证码信息而言,可以在直接在 abstractvalidatecodeprocessorservice抽象类来完成,都不需要去实现。

对发送验证码信息而言，只需要实现abstractvalidatecodeprocessorservice抽象类的send发送验证码接口即可。

整个大致接口设计就是这样,具体的可以通过代码来展示。

二、代码实现

1、验证码属性

短信验证码和图形验证后包含属性有 code 和 expiretime，短信验证码只有这两个属性，而图形验证码还多一个bufferedimage实例对象属性，所以将共同属性进行抽取

，抽取为validatecode类，代码如下：

validatecode实体

@data
@allargsconstructor
@noargsconstructor
public class validatecode {

 private string code;

 private localdatetime expiretime;

 public boolean isexpired() {
 return localdatetime.now().isafter(expiretime);
 }

}

对于图形验证码而言,除了需要code和过期时间还需要图片的画布,所以继承validatecode之后再写自己属性

imagecode实体

@data
public class imagecode extends validatecode {

 private bufferedimage image;

 public imagecode(bufferedimage image, string code, localdatetime expiretime) {
 super(code, expiretime);
 this.image = image;
 }

 public imagecode(bufferedimage image, string code, int expirein) {
 super(code, localdatetime.now().plusseconds(expirein));
 this.image = image;
 }
}

对于短信验证码而言,暂时不需要添加自己的属性字段了。

smscode实体

public class smscode extends validatecode {

 public smscode(string code, localdatetime expiretime) {
 super(code, expiretime);
 }

 public smscode(string code, int expirein) {
 super(code, localdatetime.now().plusseconds(expirein));
 }
}

2、validatecodeprocessor接口

validatecodeprocessor接口主要是完成验证码的生成、保存与发送的完整流程，接口的主要设计如下所示：

validatecodeprocessorservice接口

public interface validatecodeprocessorservice {

 /**
 * 因为现在有两种验证码，所以存放到seesion的key不能一样，所以前缀+具体type
 */
 string session_key_prefix = "session_key_for_code_";
 /**
 * 通过也是 type+code_processor获取对于的bean
 */
 string code_processor = "codeprocessorservice";

 /**
 * 这个接口要做三件事
 * 1、获取验证码。
 * 2、将验证码存入session
 * 3、将验证码信息通过短信或者图形验证码发送出去。
 * （将spring-boot-security-study-03接口里的那三步进行里封装）
 *
 */
 void processor(servletwebrequest request) throws exception;

由于图片验证码和短信验证码的生成和保存、发送等流程是固定的。所以这里写一个抽象类来实现validatecodeprocessor接口,来实现相似部分。

abstractvalidatecodeprocessorservice抽象类

@component
public abstract class abstractvalidatecodeprocessorservice<c> implements validatecodeprocessorservice {

 private static final string separator = "/code/";

 /**
 * 操作session的工具集
 */
 private sessionstrategy sessionstrategy = new httpsessionsessionstrategy();

 /**
 * 这是spring的一个特性，就是在项目启动的时候会自动收集系统中 {@link validatecodegeneratorservice} 接口的实现类对象
 *
 * key为bean name
 */
 @autowired
 private map<string, validatecodegeneratorservice> validatecodegeneratormap;

 @override
 public void processor(servletwebrequest request) throws exception {
 //第一件事
 c validatecode = generate(request);
 //第二件事
 save(request, validatecode);
 //第三件事
 send(request, validatecode);
 }

 /**
 * 生成验证码
 *
 */
 private c generate(servletwebrequest request) {
 string type = getprocessortype(request);
 //这里 image+codegenerator = imgcodegenerator 对应的就是imagecodegeneratorserviceservice
 validatecodegeneratorservice validatecodegenerator = validatecodegeneratormap.get(type.concat(validatecodegeneratorservice.code_generator));
 return (c) validatecodegenerator.generate(request);
 }

 /**
 * 保存验证码到session中
 */
 private void save(servletwebrequest request, c validatecode) {
 //这里也是封装了一下
 sessionstrategy.setattribute(request, session_key_prefix.concat(getprocessortype(request).touppercase()), validatecode);
 }

 /**
 * 发送验证码 （只有发送验证码是需要自己去实现的。）
 */
 protected abstract void send(servletwebrequest request, c validatecode) throws exception;

 /**
 * 获取请求url中具体请求的验证码类型
 *
 */
 private string getprocessortype(servletwebrequest request) {
 // 获取uri分割后的第二个片段 (/code/image 通过/code/ 切割后就只剩下 image
 return stringutils.substringafter(request.getrequest().getrequesturi(), separator);
 }
}

简单说明：

1、这里用到了spring一个特性就是map<string, validatecodegeneratorservice> validatecodegeneratormap 可以把validatecodegeneratorservice所以的实现类都放
到这个map中,key为bean的名称。

2、抽象类中实现了 validatecodeprocessor接口的processor方法，它主要是完成了验证码的创建、保存和发送的功能。

3、generate 方法根据传入的不同泛型而生成了特定的验证码。

4、save 方法是将生成的验证码实例对象存入到session中，两种验证码的存储方式一致，只是有个key不一致,所以代码也是通用的。

5、send 方法一个抽象方法，分别由imagecodeprocessorservice和smscodeprocessorservice来具体实现，也是根据泛型来判断具体调用哪一个具体的实现类的send方法。

3、验证码的生成接口

上面说过验证的生成应该也是通过实现类

validatecodegeneratorservice

public interface validatecodegeneratorservice {

 /**
 * 这个常量也是用来 type+codegeneratorservice获取对于bean对象
 */
 string code_generator = "codegeneratorservice";

 /**
 * 生成验证码
 * 具体是图片验证码 还是短信验证码就需要对应的实现类
 */
 validatecode generate(servletwebrequest request);
}

图形验证码具体实现类

magecodegeneratorserviceimpl

@data
@component("imagecodegeneratorservice")
public class imagecodegeneratorserviceimpl implements validatecodegeneratorservice {

 private static final string image_width_name = "width";
 private static final string image_height_name = "height";
 private static final integer max_color_value = 255;

 @autowired
 private validatecodeproperties validatecodeproperties;

 @override
 public imagecode generate(servletwebrequest request) {
 int width = servletrequestutils.getintparameter(request.getrequest(), image_width_name, validatecodeproperties.getimage().getwidth());
 int height = servletrequestutils.getintparameter(request.getrequest(), image_height_name,validatecodeproperties.getimage().getheight());
 bufferedimage image = new bufferedimage(width, height, bufferedimage.type_int_rgb);
 graphics g = image.getgraphics();

 random random = new random();

 // 生成画布
 g.setcolor(getrandcolor(200, 250));
 g.fillrect(0, 0, width, height);
 g.setfont(new font("times new roman", font.italic, 20));
 g.setcolor(getrandcolor(160, 200));
 for (int i = 0; i < 155; i++) {
 int x = random.nextint(width);
 int y = random.nextint(height);
 int xl = random.nextint(12);
 int yl = random.nextint(12);
 g.drawline(x, y, x + xl, y + yl);
 }

 // 生成数字验证码
 stringbuilder srand = new stringbuilder();
 for (int i = 0; i < validatecodeproperties.getimage().getlength(); i++) {
 string rand = string.valueof(random.nextint(10));
 srand.append(rand);
 g.setcolor(new color(20 + random.nextint(110), 20 + random.nextint(110), 20 + random.nextint(110)));
 g.drawstring(rand, 13 * i + 6, 16);
 }

 g.dispose();

 return new imagecode(image, srand.tostring(), validatecodeproperties.getimage().getexpirein());
 }

 /**
 * 生成随机背景条纹
 *
 * @param fc 前景色
 * @param bc 背景色
 * @return rgb颜色
 */
 private color getrandcolor(int fc, int bc) {
 random random = new random();
 if (fc > max_color_value) {
 fc = max_color_value;
 }
 if (bc > max_color_value) {
 bc = max_color_value;
 }
 int r = fc + random.nextint(bc - fc);
 int g = fc + random.nextint(bc - fc);
 int b = fc + random.nextint(bc - fc);
 return new color(r, g, b);
 }
}

短信验证码具体实现类

smscodegeneratorserviceimpl

@data
@component("smscodegeneratorservice")
public class smscodegeneratorserviceimpl implements validatecodegeneratorservice {

 @autowired
 private validatecodeproperties validatecodeproperties;


 @override
 public smscode generate(servletwebrequest request) {
 //生成随机数
 string code = randomstringutils.randomnumeric(validatecodeproperties.getsms().getlength());
 return new smscode(code, validatecodeproperties.getsms().getexpirein());
 }
}

4、验证码的发送逻辑类

获取的实现类写好了，我们在写发送具体的发送实现类,发送类的实现类是实现abstractvalidatecodeprocessorservice抽象类的。

图片发送实现类

imagecodeprocessorserviceimpl

@component("imagecodeprocessorservice")
public class imagecodeprocessorserviceimpl extends abstractvalidatecodeprocessorservice<imagecode> {

 private static final string format_name = "jpeg";

 /**
 * 发送图形验证码，将其写到相应中
 *
 * @param request servletwebrequest实例对象
 * @param imagecode 验证码
 */
 @override
 protected void send(servletwebrequest request, imagecode imagecode) throws exception {
 imageio.write(imagecode.getimage(), format_name, request.getresponse().getoutputstream());
 }
}

短信发送具体实现类。这里只是后台输出就好了，实际中只要接入对于的sdk就可以了。

smscodeprocessorserviceimpl

@component("smscodeprocessorservice")
public class smscodeprocessorserviceimpl extends abstractvalidatecodeprocessorservice<smscode> {
 private static final string sms_code_param_name = "mobile";

 @override
 protected void send(servletwebrequest request, smscode smscode) throws exception {
 //这里有一个参数也是前端需要传来的 就是用户的手机号
 string mobile = servletrequestutils.getrequiredstringparameter(request.getrequest(), sms_code_param_name);
 // 这里仅仅写个打印，具体逻辑一般都是调用第三方接口发送短信
 system.out.println("向手机号为：" + mobile + "的用户发送验证码：" + smscode.getcode());
 }

整个大致就是这样，我们再来测试一下。

三、测试

1、validatecodecontroller接口

获取验证码接口

@restcontroller
@slf4j
public class validatecodecontroller {


 @autowired
 private map<string, validatecodeprocessorservice> validatecodeprocessormap;


 @requestmapping("/code/{type}")
 public void createcode(httpservletrequest request, httpservletresponse response, @pathvariable string type) throws exception {
 if(!stringutils.equalsany(type, "image", "sms")){
 log.info("type类型错误 type={}",type);
 return;
 };

 //根据type获取具体的实现类
 validatecodeprocessorservice validatecodeprocessorservice = validatecodeprocessormap.get(type.concat(validatecodeprocessorservice.code_processor));
 validatecodeprocessorservice.processor(new servletwebrequest(request, response));

 }

}

2、获得图形验证码

SpringSceurity实现短信验证码功能的示例代码