Spring Boot实现登录验证码功能的案例详解

下面我将详细讲解“Spring Boot实现登录验证码功能的案例详解”的攻略。

一、前置条件

• 熟悉Spring Boot框架的使用
• 了解Thymeleaf模板引擎的使用
• 需要引入spring-boot-starter-security 和 spring-boot-starter-thymeleaf两个Starter

二、添加验证码依赖

在pom.xml中添加以下依赖：

<!-- 验证码 -->
<dependency>
    <groupId>com.github.axet</groupId>
    <artifactId>kaptcha</artifactId>
    <version>0.0.9</version>
</dependency>

三、配置验证码

在application.yml中添加以下配置：

kaptcha:
  border:
    color: black
  textproducer:
    font.color: black
    char.space: 5
  image.width: 120
  image.height: 40

四、Controller实现

在Controller中添加以下代码：

@GetMapping("/login")
public String login() {
    return "login";
}

@PostMapping("/login")
public String doLogin(@RequestParam String username, @RequestParam String password,
                      @RequestParam String code, HttpSession session, Model model) {
    // 验证验证码
    String captcha = (String) session.getAttribute("captcha");
    if (captcha == null || !captcha.equals(code)) {
        model.addAttribute("errorMsg", "验证码错误");
        return "login";
    }
    // 验证用户名和密码
    if ("admin".equals(username) && "123456".equals(password)) {
        return "success";
    } else {
        model.addAttribute("errorMsg", "用户名或密码错误");
        return "login";
    }
}

其中/login是显示登录页面的请求，使用GET方式实现；/login是进行登录验证的请求，使用POST方式实现。其中验证过程分为两步，首先验证验证码是否正确，如果不正确则返回登录页面，并提示验证码错误；如果验证码正确，则进行用户名和密码的验证，如果用户名和密码正确，则返回成功页面；如果用户名或密码错误，则返回登录页面，并提示用户名或密码错误。

五、Thymeleaf模板实现

在Thymeleaf的模板文件login.html中，添加如下代码：

<div class="form-group row">
    <label for="codeInput" class="col-sm-2 col-form-label">验证码：</label>
    <div class="col-sm-10">
        <div class="input-group">
            <input type="text" class="form-control" id="codeInput" name="code" required>
            <div class="input-group-append">
                <img th:src="@{'/captcha?'+${T(System).currentTimeMillis()}}" onclick="this.src='captcha?'+Math.random()" style="cursor: pointer;"/>
            </div>
        </div>
        <div class="valid-feedback">验证码输入正确</div>
        <div class="invalid-feedback" th:if="${errorMsg != null}">[[${errorMsg}]]</div>
    </div>
</div>

这段代码实现了验证码的显示功能。其中，<img>标签中的th:src="@{'/captcha?'+${T(System).currentTimeMillis()}}"表示验证码的请求地址，后面的onclick="this.src='captcha?'+Math.random()"表示当鼠标点击时，动态更新验证码。

六、CaptchaController实现

在CaptchaController中添加以下代码：

@GetMapping("/captcha")
public void captcha(HttpServletResponse response, HttpSession session) throws Exception {
    // 生成验证码
    String captcha = producer.createText();
    // 验证码存放到session中
    session.setAttribute("captcha", captcha);
    // 将验证码输出到输出流中
    BufferedImage bi = producer.createImage(captcha);
    ImageIO.write(bi, "jpg", response.getOutputStream());
    response.getOutputStream().flush();
}

这段代码的作用是生成验证码，并将验证码存放到session中，然后将验证码输出到输出流中。

以上就是“Spring Boot实现登录验证码功能的案例详解”的攻略。实现原理其实很简单，就是通过Kaptcha依赖生成验证码，然后在登录界面中展示和验证验证码即可。