[译] 学习 Spring Security（四）：使用邮箱激活新帐户

时间  2019-12-01
标签 学习 spring security 使用 邮箱 激活 帐户 栏目 Spring 繁體版
原文   原文链接

www.baeldung.com/registratio…html

做者：Eugen Paraschivjava

转载自公众号：stackgcgit

一、概述

本文续以前的 Spring Security 系列之注册流程中缺失的部分 — 验证用户的电子邮件以确认账户。github

注册确认机制强制用户在成功注册后执行确认注册电子邮件中的操做，以验证其电子邮件地址并激活账户。用户经过单击电子邮件中的惟一激活连接来完成激活操做。spring

根据此逻辑，新注册的用户没法登陆到系统，除非完成了该流程。session

二、验证 Token

咱们将使用一个简单的验证令牌做为验证用户的凭据。并发

2.一、VerificationToken 实体

VerificationToken 实体必须符合如下标准：app

  1. 它必须指向 User（经过一个单向关系）
  2. 它将在注册后当即建立
  3. 它将在建立后 24 小时内过时
  4. 有一个惟1、随机生成的值

第 2 和 3 点是注册逻辑的一部分。其他的两个实现位于简单的 VerificationToken 实体中，如示例 2.1。dom

示例 2.1ide

@Entity
public class VerificationToken {
    private static final int EXPIRATION = 60 * 24;
 
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
     
    private String token;
   
    @OneToOne(targetEntity = User.class, fetch = FetchType.EAGER)
    @JoinColumn(nullable = false, name = "user_id")
    private User user;
     
    private Date expiryDate;
    
    private Date calculateExpiryDate(int expiryTimeInMinutes) {
        Calendar cal = Calendar.getInstance();
        cal.setTime(new Timestamp(cal.getTime().getTime()));
        cal.add(Calendar.MINUTE, expiryTimeInMinutes);
        return new Date(cal.getTime().getTime());
    }
     
    // 省略构造方法、getter 和 setter
}
复制代码

注意 User 上的 nullable = false，其确保了 VerificationToken <-> User 关联中数据的完整性和一致性。

2.二、将 enabled 字段添加到 User 中

当用户注册时，此 enabled 字段将被设置为 false。在账户验证过程当中，若是经过，则置为 true。

添加字段到 User 实体中：

public class User {
    ...
    @Column(name = "enabled")
    private boolean enabled;
     
    public User() {
        super();
        this.enabled=false;
    }
    ...
}
复制代码

请注意，咱们也将该字段的默认值设置为 false。

三、账户注册期间

添加两个额外的业务逻辑到用户注册用例中：

  1. 为 User 生成 VerificationToken 并保存
  2. 发送电子邮件进行账户确认 —— 其中包含带有 VerificationToken 值的确认连接

3.一、使用 Spring Event 建立令牌并发送验证邮件

这两个额外的逻辑不该该由控制器直接执行，由于它们是并行的后台任务。

控制器将发布一个 Spring ApplicationEvent 来触发这些任务的执行。这和注入 ApplicationEventPublisher 并使用它来发布注册同样简单。

示例 3.1 展现了这个简单的逻辑：

示例 3.1

@Autowired
ApplicationEventPublisher eventPublisher
 
@RequestMapping(value = "/user/registration", method = RequestMethod.POST)
public ModelAndView registerUserAccount( @ModelAttribute("user") @Valid UserDto accountDto, BindingResult result, WebRequest request, Errors errors) {
  
    if (result.hasErrors()) {
        return new ModelAndView("registration", "user", accountDto);
    }
     
    User registered = createUserAccount(accountDto);
    if (registered == null) {
        result.rejectValue("email", "message.regError");
    }
    try {
        String appUrl = request.getContextPath();
        eventPublisher.publishEvent(new OnRegistrationCompleteEvent
          (registered, request.getLocale(), appUrl));
    } catch (Exception me) {
        return new ModelAndView("emailError", "user", accountDto);
    }
    return new ModelAndView("successRegister", "user", accountDto);
}
复制代码

另外须要注意的是包裹事件发布的 try catch 块。这段代码表明了只要在发布事件后执行的逻辑中存在异常就展现一个错误页面。此处的逻辑就是发送电子邮件。

3.二、Event 与 Listener

如今让咱们看看 OnRegistrationCompleteEvent 的实际实现，以及要处理它的监听器：

例 3.2.1 — OnRegistrationCompleteEvent

public class OnRegistrationCompleteEvent extends ApplicationEvent {
    private String appUrl;
    private Locale locale;
    private User user;
 
    public OnRegistrationCompleteEvent( User user, Locale locale, String appUrl) {
        super(user);
         
        this.user = user;
        this.locale = locale;
        this.appUrl = appUrl;
    }
     
    // standard getters and setters
}
复制代码

例 3.2.2 — RegistrationListener 处理 OnRegistrationCompleteEvent

@Component
public class RegistrationListener implements ApplicationListener<OnRegistrationCompleteEvent> {
  
    @Autowired
    private IUserService service;
  
    @Autowired
    private MessageSource messages;
  
    @Autowired
    private JavaMailSender mailSender;
 
    @Override
    public void onApplicationEvent(OnRegistrationCompleteEvent event) {
        this.confirmRegistration(event);
    }
 
    private void confirmRegistration(OnRegistrationCompleteEvent event) {
        User user = event.getUser();
        String token = UUID.randomUUID().toString();
        service.createVerificationToken(user, token);
         
        String recipientAddress = user.getEmail();
        String subject = "Registration Confirmation";
        String confirmationUrl 
          = event.getAppUrl() + "/regitrationConfirm.html?token=" + token;
        String message = messages.getMessage("message.regSucc", null, event.getLocale());
         
        SimpleMailMessage email = new SimpleMailMessage();
        email.setTo(recipientAddress);
        email.setSubject(subject);
        email.setText(message + " rn" + "http://localhost:8080" + confirmationUrl);
        mailSender.send(email);
    }
}
复制代码

在此处，confirmRegistration 方法将接收 OnRegistrationCompleteEvent，从中提取全部必要的 User 信息，建立验证令牌，将其保存，而后在确认注册连接中将其做为参数发送。

如上所述，JavaMailSender 引起的任何 javax.mail.AuthenticationFailedException 都将由控制器处理。

3.三、处理验证令牌参数

当用户收到确认注册连接时点击它。

一旦点击，控制器将提取 GET 请求中的令牌参数的值，并将使用它来启用 User。

例 3.3.1 — RegistrationController 处理注册确认

@Autowired
private IUserService service;
 
@RequestMapping(value = "/regitrationConfirm", method = RequestMethod.GET)
public String confirmRegistration (WebRequest request, Model model, @RequestParam("token") String token) {
  
    Locale locale = request.getLocale();
     
    VerificationToken verificationToken = service.getVerificationToken(token);
    if (verificationToken == null) {
        String message = messages.getMessage("auth.message.invalidToken", null, locale);
        model.addAttribute("message", message);
        return "redirect:/badUser.html?lang=" + locale.getLanguage();
    }
     
    User user = verificationToken.getUser();
    Calendar cal = Calendar.getInstance();
    if ((verificationToken.getExpiryDate().getTime() - cal.getTime().getTime()) <= 0) {
        String messageValue = messages.getMessage("auth.message.expired", null, locale)
        model.addAttribute("message", messageValue);
        return "redirect:/badUser.html?lang=" + locale.getLanguage();
    } 
     
    user.setEnabled(true); 
    service.saveRegisteredUser(user); 
    return "redirect:/login.html?lang=" + request.getLocale().getLanguage(); 
}
复制代码

若是出现如下状况，用户将被重定向到错误页面并显示相应的信息：

  1. 因为某些缘由 VerificationToken 不存在
  2. VerificationToken 已过时

见示例 3.3.2 的错误页面。

例 3.3.2 — badUser.html

<html>
<body>
    <h1 th:text="${param.message[0]}">Error Message</h1>
    <a th:href="@{/registration.html}" th:text="#{label.form.loginSignUp}">signup</a>
</body>
</html>
复制代码

若是没有发现错误，则启用用户。

在处理 VerificationToken 检查和过时流程中有两个地方能够改进：

  1. 咱们可使用 Cron 做业在后台检查令牌是否过时
  2. 一旦过时，咱们能够让用户有机会得到新的令牌

咱们将生成新令牌流程推迟到后面的文章再讲，如今假设用户确实在这里成功验证了令牌。

四、将账户激活检查添加到登陆流程

咱们须要添加检查用户是否启用的代码：

示例 4.1展现了 MyUserDetailsService 的 loadUserByUsername方法。

例 4.1

@Autowired
UserRepository userRepository;
 
public UserDetails loadUserByUsername(String email) throws UsernameNotFoundException {
  
    boolean enabled = true;
    boolean accountNonExpired = true;
    boolean credentialsNonExpired = true;
    boolean accountNonLocked = true;
    try {
        User user = userRepository.findByEmail(email);
        if (user == null) {
            throw new UsernameNotFoundException(
              "No user found with username: " + email);
        }
         
        return new org.springframework.security.core.userdetails.User(
          user.getEmail(), 
          user.getPassword().toLowerCase(), 
          user.isEnabled(), 
          accountNonExpired, 
          credentialsNonExpired, 
          accountNonLocked, 
          getAuthorities(user.getRole()));
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}
复制代码

咱们能够发现，如今 MyUserDetailsService 不使用 User 的 enabled 标志。

如今将添加一个 AuthenticationFailureHandler 来自定义来自 MyUserDetailsService 的异常消息。咱们的 CustomAuthenticationFailureHandler 如示例 4.2 所示：

例 4.2 — CustomAuthenticationFailureHandler：

@Component
public class CustomAuthenticationFailureHandler extends SimpleUrlAuthenticationFailureHandler {
 
    @Autowired
    private MessageSource messages;
 
    @Autowired
    private LocaleResolver localeResolver;
 
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
        setDefaultFailureUrl("/login.html?error=true");
 
        super.onAuthenticationFailure(request, response, exception);
 
        Locale locale = localeResolver.resolveLocale(request);
 
        String errorMessage = messages.getMessage("message.badCredentials", null, locale);
 
        if (exception.getMessage().equalsIgnoreCase("User is disabled")) {
            errorMessage = messages.getMessage("auth.message.disabled", null, locale);
        } else if (exception.getMessage().equalsIgnoreCase("User account has expired")) {
            errorMessage = messages.getMessage("auth.message.expired", null, locale);
        }
 
        request.getSession().setAttribute(WebAttributes.AUTHENTICATION_EXCEPTION, errorMessage);
    }
}
复制代码

须要修改 login.html 以显示错误消息。

示例 4.3 — 在 login.html 处显示错误消息：

<div th:if="${param.error != null}" th:text="${session[SPRING_SECURITY_LAST_EXCEPTION]}">error</div>
复制代码

五、适配持久层

让咱们来看看一些涉及到验证令牌和用户操做的实际实现。

涵盖如下内容：

  1. 一个新的 VerificationTokenRepository
  2. IUserInterface 中的新方法及其对新 CRUD 操做的实现需求

示例 5.1 — 5.3 展现新的接口和实现：

示例 5.1 — VerificationTokenRepository

public interface VerificationTokenRepository extends JpaRepository<VerificationToken, Long> {
 
    VerificationToken findByToken(String token);
 
    VerificationToken findByUser(User user);
}
复制代码

示例5.2 — IUserService 接口

public interface IUserService {
     
    User registerNewUserAccount(UserDto accountDto) throws EmailExistsException;
 
    User getUser(String verificationToken);
 
    void saveRegisteredUser(User user);
 
    void createVerificationToken(User user, String token);
 
    VerificationToken getVerificationToken(String VerificationToken);
}
复制代码

示例 5.3 — UserService

@Service
@Transactional
public class UserService implements IUserService {
    @Autowired
    private UserRepository repository;
 
    @Autowired
    private VerificationTokenRepository tokenRepository;
 
    @Override
    public User registerNewUserAccount(UserDto accountDto) throws EmailExistsException {
         
        if (emailExist(accountDto.getEmail())) {
            throw new EmailExistsException(
              "There is an account with that email adress: "
              + accountDto.getEmail());
        }
         
        User user = new User();
        user.setFirstName(accountDto.getFirstName());
        user.setLastName(accountDto.getLastName());
        user.setPassword(accountDto.getPassword());
        user.setEmail(accountDto.getEmail());
        user.setRole(new Role(Integer.valueOf(1), user));
        return repository.save(user);
    }
 
    private boolean emailExist(String email) {
        User user = repository.findByEmail(email);
        if (user != null) {
            return true;
        }
        return false;
    }
     
    @Override
    public User getUser(String verificationToken) {
        User user = tokenRepository.findByToken(verificationToken).getUser();
        return user;
    }
     
    @Override
    public VerificationToken getVerificationToken(String VerificationToken) {
        return tokenRepository.findByToken(VerificationToken);
    }
     
    @Override
    public void saveRegisteredUser(User user) {
        repository.save(user);
    }
     
    @Override
    public void createVerificationToken(User user, String token) {
        VerificationToken myToken = new VerificationToken(token, user);
        tokenRepository.save(myToken);
    }
}
复制代码

六、总结

本文介绍了注册流程 —— 基于电子邮件的账户激活流程。

账户激活逻辑为经过电子邮件向用户发送验证令牌，以便他们能够将信息发送回控制器以验证身份。

该注册示例和 Spring Security 教程的实现能够在 GitHub 项目中找到。

原文项目源码

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程