SpringSecurity登录添加验证码

登录添加验证码是一个非常常见的需求，网上也有非常成熟的解决方案，其实，要是自己自定义登录实现这个并不难，但是如果需要在SpringSecurity框架中实现这个功能，还得稍费一点功夫，本文就和小伙伴来分享下在SpringSecurity框架中如何添加验证码。

关于SpringSecurity基本配置，这里就不再多说，小伙伴有不懂的可以参考我的书《SpringBoot+Vue全栈开发实战》，本文主要来看如何加入验证码功能。

准备验证码

要有验证码，首先得先准备好验证码，本文采用Java自画的验证码，代码如下：

1. /**

2. * 生成验证码的工具类

3. */

4. public class VerifyCode {

5. 
   

6. private int width = 100;// 生成验证码图片的宽度

7. private int height = 50;// 生成验证码图片的高度

8. private String[] fontNames = { "宋体", "楷体", "隶书", "微软雅黑" };

9. private Color bgColor = new Color(255, 255, 255);// 定义验证码图片的背景颜色为白色

10. private Random random = new Random();

11. private String codes = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";

12. private String text;// 记录随机字符串

13. 
    

14. /**

15. * 获取一个随意颜色

16. *

17. * @return

18. */

19. private Color randomColor() {

20. int red = random.nextInt(150);

21. int green = random.nextInt(150);

22. int blue = random.nextInt(150);

23. return new Color(red, green, blue);

24. }

25. 
    

26. /**

27. * 获取一个随机字体

28. *

29. * @return

30. */

31. private Font randomFont() {

32. String name = fontNames[random.nextInt(fontNames.length)];

33. int style = random.nextInt(4);

34. int size = random.nextInt(5) + 24;

35. return new Font(name, style, size);

36. }

37. 
    

38. /**

39. * 获取一个随机字符

40. *

41. * @return

42. */

43. private char randomChar() {

44. return codes.charAt(random.nextInt(codes.length()));

45. }

46. 
    

47. /**

48. * 创建一个空白的BufferedImage对象

49. *

50. * @return

51. */

52. private BufferedImage createImage() {

53. BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);

54. Graphics2D g2 = (Graphics2D) image.getGraphics();

55. g2.setColor(bgColor);// 设置验证码图片的背景颜色

56. g2.fillRect(0, 0, width, height);

57. return image;

58. }

59. 
    

60. public BufferedImage getImage() {

61. BufferedImage image = createImage();

62. Graphics2D g2 = (Graphics2D) image.getGraphics();

63. StringBuffer sb = new StringBuffer();

64. for (int i = 0; i < 4; i++) {

65. String s = randomChar() + "";

66. sb.append(s);

67. g2.setColor(randomColor());

68. g2.setFont(randomFont());

69. float x = i * width * 1.0f / 4;

70. g2.drawString(s, x, height - 15);

71. }

72. this.text = sb.toString();

73. drawLine(image);

74. return image;

75. }

76. 
    

77. /**

78. * 绘制干扰线

79. *

80. * @param image

81. */

82. private void drawLine(BufferedImage image) {

83. Graphics2D g2 = (Graphics2D) image.getGraphics();

84. int num = 5;

85. for (int i = 0; i < num; i++) {

86. int x1 = random.nextInt(width);

87. int y1 = random.nextInt(height);

88. int x2 = random.nextInt(width);

89. int y2 = random.nextInt(height);

90. g2.setColor(randomColor());

91. g2.setStroke(new BasicStroke(1.5f));

92. g2.drawLine(x1, y1, x2, y2);

93. }

94. }

95. 
    

96. public String getText() {

97. return text;

98. }

99. 
    

100. public static void output(BufferedImage image, OutputStream out) throws IOException {

101. ImageIO.write(image, "JPEG", out);

102. }

103. }

这个工具类很常见，网上也有很多，就是画一个简单的验证码，通过流将验证码写到前端页面，提供验证码的Controller如下：

1. @RestController

2. public class VerifyCodeController {

3. @GetMapping("/vercode")

4. public void code(HttpServletRequest req, HttpServletResponse resp) throws IOException {

5. VerifyCode vc = new VerifyCode();

6. BufferedImage image = vc.getImage();

7. String text = vc.getText();

8. HttpSession session = req.getSession();

9. session.setAttribute("index_code", text);

10. VerifyCode.output(image, resp.getOutputStream());

11. }

12. }

这里创建了一个VerifyCode对象，将生成的验证码字符保存到session中，然后通过流将图片写到前端，img标签如下：

1. src="/vercode" alt="">

展示效果如下：

自定义过滤器

在登陆页展示验证码这个就不需要我多说了，接下来我们来看看如何自定义验证码处理器：

1. @Component

2. public class VerifyCodeFilter extends GenericFilterBean {

3. private String defaultFilterProcessUrl = "/doLogin";

4. 
   

5. @Override

6. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)

7. throws IOException, ServletException {

8. HttpServletRequest request = (HttpServletRequest) req;

9. HttpServletResponse response = (HttpServletResponse) res;

10. if ("POST".equalsIgnoreCase(request.getMethod()) && defaultFilterProcessUrl.equals(request.getServletPath())) {

11. // 验证码验证

12. String requestCaptcha = request.getParameter("code");

13. String genCaptcha = (String) request.getSession().getAttribute("index_code");

14. if (StringUtils.isEmpty(requestCaptcha))

15. throw new AuthenticationServiceException("验证码不能为空!");

16. if (!genCaptcha.toLowerCase().equals(requestCaptcha.toLowerCase())) {

17. throw new AuthenticationServiceException("验证码错误!");

18. }

19. }

20. chain.doFilter(request, response);

21. }

22. }

自定义过滤器继承自GenericFilterBean，并实现其中的doFilter方法，在doFilter方法中，当请求方法是POST，并且请求地址是 /doLogin时，获取参数中的code字段值，该字段保存了用户从前端页面传来的验证码，然后获取session中保存的验证码，如果用户没有传来验证码，则抛出验证码不能为空异常，如果用户传入了验证码，则判断验证码是否正确，如果不正确则抛出异常，否则执行 chain.doFilter(request,response);使请求继续向下走。

配置

最后在SpringSecurity的配置中，配置过滤器，如下：

1. @Configuration

2. public class SecurityConfig extends WebSecurityConfigurerAdapter {

3. 
   

4. @Autowired

5. VerifyCodeFilter verifyCodeFilter;

6. ...

7. ...

8. @Override

9. protected void configure(HttpSecurity http) throws Exception {

10. http.addFilterBefore(verifyCodeFilter, UsernamePasswordAuthenticationFilter.class);

11. http.authorizeRequests()

12. .antMatchers("/admin/**").hasRole("admin")

13. ...

14. ...

15. .permitAll()

16. .and()

17. .csrf().disable();

18. }

19. }

这里只贴出了部分核心代码，即 http.addFilterBefore(verifyCodeFilter,UsernamePasswordAuthenticationFilter.class);，如此之后，整个配置就算完成了。
接下来在登录中，就需要传入验证码了，如果不传或者传错，都会抛出异常，例如不传的话，抛出如下异常：

好了，本文就先说到这里，有问题欢迎留言讨论。

▼往期精彩回顾▼ 2019新年福利，新书免费送！ Docker教程 Redis教程 SpringCloud教程 Git教程 MongoDB教程 SpringBoot+Vue前后端分离开源项目-微人事 SpringBoot+Vue前后端分离开源项目-V部落