【SpringBoot】SpringBoot使用mail实现登录邮箱验证

Spring Boot 实现邮箱登录验证

在现代 web 应用程序中，邮箱验证是保证用户身份和提高安全性的一个重要步骤。使用 Spring Boot，我们可以快速实现一个邮箱验证的功能。本文将通过代码示例详细介绍如何在 Spring Boot 应用中实现邮箱验证。

一、引入依赖

首先，在 pom.xml 中添加 Spring Boot Starter Mail 的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

此外，如果您还需要进行数据库操作，可以引入 JPA 和数据库的依赖，例如 H2 或 MySQL：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>

二、配置邮件发送

在 application.properties 文件中，配置您的邮箱服务器信息（以 Gmail 为例）：

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email@gmail.com
spring.mail.password=your-email-password
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

三、创建用户实体

接下来，我们需要创建一个用户实体类 User，用于存储用户信息和验证状态。

import javax.persistence.*;
import java.time.LocalDateTime;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String email;
    private String password;
    private boolean verified;
    private String verificationCode;
    private LocalDateTime verificationCodeExpiry;

    // Getters and Setters
}

四、编写邮件服务类

然后，我们编写一个服务类，用于发送邮件。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Service;

@Service
public class EmailService {

    @Autowired
    private JavaMailSender emailSender;

    public void sendVerificationEmail(String email, String verificationCode) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(email);
        message.setSubject("邮箱验证");
        message.setText("请点击以下链接完成邮箱验证：http://localhost:8080/verify?code=" + verificationCode);
        emailSender.send(message);
    }
}

五、用户注册和邮箱验证

在控制器中，我们处理用户的注册和邮箱验证请求。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.security.SecureRandom;

@RestController
@RequestMapping("/api/auth")
public class AuthController {

    @Autowired
    private UserService userService;

    @Autowired
    private EmailService emailService;

    @PostMapping("/register")
    public String register(@RequestBody User user) {
        String verificationCode = generateVerificationCode();
        user.setVerificationCode(verificationCode);
        user.setVerified(false);
        userService.save(user);
        emailService.sendVerificationEmail(user.getEmail(), verificationCode);
        return "注册成功，请检查您的邮箱以完成验证";
    }

    @GetMapping("/verify")
    public String verifyEmail(@RequestParam("code") String code) {
        User user = userService.findByVerificationCode(code);
        if (user != null && !user.isVerified()) {
            user.setVerified(true);
            userService.save(user);
            return "邮箱验证成功！";
        } 
        return "邮箱验证失败或已被验证！";
    }

    private String generateVerificationCode() {
        SecureRandom random = new SecureRandom();
        return String.format("%06d", random.nextInt(1000000));
    }
}

在上面的代码中，用户通过 POST 请求注册，并将生成的验证码发送到用户的邮箱。当用户点击链接时，使用 GET 请求到 /verify 进行邮箱验证。

六、安全考虑

请注意，处理邮件发送时，一定要做到以下几点：

1. 安全性：确保不在代码中直接暴露邮件密码，可以考虑使用环境变量。
2. 验证码过期：可以在用户实体中增加验证码过期时间，并在验证时检查是否过期。
3. 错误处理：增加更多的错误处理，以便用户可以清楚地知道发生了什么问题。

总结

通过以上步骤，我们成功地使用 Spring Boot 实现了一个基本的邮箱验证功能。在实际应用中，可以根据需求进一步扩展和优化，比如使用模板引擎生成更为复杂的邮件内容、实现验证码的重发等功能。希望本文对您有所帮助！