Четвертый раунд улучшений в приложении Reddit

Четвертый раунд улучшений в приложении Reddit

1. обзор

В этом руководстве мы продолжим улучшать простое приложение Reddit, которое мы создаем как частьthis public case study.

2. Лучшие таблицы для администратора

Во-первых, мы приведем таблицы на страницах администратора к тому же уровню, что и таблицы в приложении, предназначенном для пользователей, - с помощью подключаемого модуля jQuery DataTable.

2.1. Разбивка пользователей на страницы - уровень обслуживания

Давайте добавим операцию с включенной разбивкой на страницы на уровне сервиса:

public List getUsersList(int page, int size, String sortDir, String sort) {
    PageRequest pageReq = new PageRequest(page, size, Sort.Direction.fromString(sortDir), sort);
    return userRepository.findAll(pageReq).getContent();
}
public PagingInfo generatePagingInfo(int page, int size) {
    return new PagingInfo(page, size, userRepository.count());
}

2.2. Пользовательский DTO

Далее - давайте теперь убедимся, что мы последовательно возвращаем DTO клиенту.

Нам понадобится User DTO, потому что до сих пор API возвращал фактическую сущностьUser обратно клиенту:

public class UserDto {
    private Long id;

    private String username;

    private Set roles;

    private long scheduledPostsCount;
}

2.3. Разбивка пользователей на страницы - в контроллере

Теперь давайте также реализуем эту простую операцию на уровне контроллера:

public List getUsersList(
  @RequestParam(value = "page", required = false, defaultValue = "0") int page,
  @RequestParam(value = "size", required = false, defaultValue = "10") int size,
  @RequestParam(value = "sortDir", required = false, defaultValue = "asc") String sortDir,
  @RequestParam(value = "sort", required = false, defaultValue = "username") String sort,
  HttpServletResponse response) {
    response.addHeader("PAGING_INFO", userService.generatePagingInfo(page, size).toString());
    List users = userService.getUsersList(page, size, sortDir, sort);

    return users.stream().map(
      user -> convertUserEntityToDto(user)).collect(Collectors.toList());
}

А вот логика преобразования DTO:

private UserDto convertUserEntityToDto(User user) {
    UserDto dto = modelMapper.map(user, UserDto.class);
    dto.setScheduledPostsCount(scheduledPostService.countScheduledPostsByUser(user));
    return dto;
}

2.4. Внешний интерфейс

Наконец, на стороне клиента давайте воспользуемся этой новой операцией и повторно реализуем нашу страницу для администраторов:

UsernameScheduled Posts CountRolesActions

3. Отключить пользователя

Далее мы собираемся создать простую функцию администратора -the ability to disable a user.

Первое, что нам нужно, это полеenabled в сущностиUser:

private boolean enabled;

Затем мы можем использовать это в нашей реализацииUserPrincipal, чтобы определить, включен ли принципал или нет:

public boolean isEnabled() {
    return user.isEnabled();
}

Вот операция API, которая имеет дело с отключением / включением пользователей:

@PreAuthorize("hasRole('USER_WRITE_PRIVILEGE')")
@RequestMapping(value = "/users/{id}", method = RequestMethod.PUT)
@ResponseStatus(HttpStatus.OK)
public void setUserEnabled(@PathVariable("id") Long id,
  @RequestParam(value = "enabled") boolean enabled) {
    userService.setUserEnabled(id, enabled);
}

А вот простая реализация уровня сервиса:

public void setUserEnabled(Long userId, boolean enabled) {
    User user = userRepository.findOne(userId);
    user.setEnabled(enabled);
    userRepository.save(user);
}

4. Обработка тайм-аута сеанса

Затем давайте настроим приложениеto handle a session timeout - мы добавим простойSessionListener в наш контекстto control session timeout:

public class SessionListener implements HttpSessionListener {

    @Override
    public void sessionCreated(HttpSessionEvent event) {
        event.getSession().setMaxInactiveInterval(5 * 60);
    }
}

А вот конфигурация Spring Security:

protected void configure(HttpSecurity http) throws Exception {
    http
    ...
        .sessionManagement()
        .invalidSessionUrl("/?invalidSession=true")
        .sessionFixation().none();
}

Замечания:

  • Мы настроили время нашего сеанса на 5 минут.

  • По истечении сеанса пользователь будет перенаправлен на страницу входа.

5. Улучшить регистрацию

Затем мы улучшим процесс регистрации, добавив некоторые функции, которые ранее отсутствовали.

Мы собираемся здесь только проиллюстрировать основные моменты; чтобы углубиться в регистрацию - посмотритеRegistration series.

5.1. Электронное письмо с подтверждением регистрации

Одна из этих функций, отсутствующих при регистрации, заключалась в том, что пользователям не предлагалось подтвердить свой адрес электронной почты.

Теперь мы заставим пользователей подтверждать свой адрес электронной почты, прежде чем они будут активированы в системе:

public void register(HttpServletRequest request,
  @RequestParam("username") String username,
  @RequestParam("email") String email,
  @RequestParam("password") String password) {
    String appUrl =
      "http://" + request.getServerName() + ":" +
       request.getServerPort() + request.getContextPath();
    userService.registerNewUser(username, email, password, appUrl);
}

Служебному слою также нужно немного поработать, чтобы убедиться, что пользователь изначально отключен:

@Override
public void registerNewUser(String username, String email, String password, String appUrl) {
    ...
    user.setEnabled(false);
    userRepository.save(user);
    eventPublisher.publishEvent(new OnRegistrationCompleteEvent(user, appUrl));
}

Теперь для подтверждения:

@RequestMapping(value = "/user/regitrationConfirm", method = RequestMethod.GET)
public String confirmRegistration(Model model, @RequestParam("token") String token) {
    String result = userService.confirmRegistration(token);
    if (result == null) {
        return "redirect:/?msg=registration confirmed successfully";
    }
    model.addAttribute("msg", result);
    return "submissionResponse";
}
public String confirmRegistration(String token) {
    VerificationToken verificationToken = tokenRepository.findByToken(token);
    if (verificationToken == null) {
        return "Invalid Token";
    }

    Calendar cal = Calendar.getInstance();
    if ((verificationToken.getExpiryDate().getTime() - cal.getTime().getTime()) <= 0) {
        return "Token Expired";
    }

    User user = verificationToken.getUser();
    user.setEnabled(true);
    userRepository.save(user);
    return null;
}

5.2. Запуск сброса пароля

Теперь давайте посмотрим, как разрешить пользователям сбрасывать собственный пароль, если они его забудут:

@RequestMapping(value = "/users/passwordReset", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public void passwordReset(HttpServletRequest request, @RequestParam("email") String email) {
    String appUrl = "http://" + request.getServerName() + ":" +
      request.getServerPort() + request.getContextPath();
    userService.resetPassword(email, appUrl);
}

Теперь сервисный слой просто отправит пользователю электронное письмо со ссылкой, где он сможет сбросить свой пароль:

public void resetPassword(String userEmail, String appUrl) {
    Preference preference = preferenceRepository.findByEmail(userEmail);
    User user = userRepository.findByPreference(preference);
    if (user == null) {
        throw new UserNotFoundException("User not found");
    }

    String token = UUID.randomUUID().toString();
    PasswordResetToken myToken = new PasswordResetToken(token, user);
    passwordResetTokenRepository.save(myToken);
    SimpleMailMessage email = constructResetTokenEmail(appUrl, token, user);
    mailSender.send(email);
}

5.3. Сброс пароля

После того, как пользователь щелкнет ссылку в письме, он можетperform the reset password operation:

@RequestMapping(value = "/users/resetPassword", method = RequestMethod.GET)
public String resetPassword(
  Model model,
  @RequestParam("id") long id,
  @RequestParam("token") String token) {
    String result = userService.checkPasswordResetToken(id, token);
    if (result == null) {
        return "updatePassword";
    }
    model.addAttribute("msg", result);
    return "submissionResponse";
}

И уровень обслуживания:

public String checkPasswordResetToken(long userId, String token) {
    PasswordResetToken passToken = passwordResetTokenRepository.findByToken(token);
    if ((passToken == null) || (passToken.getUser().getId() != userId)) {
        return "Invalid Token";
    }

    Calendar cal = Calendar.getInstance();
    if ((passToken.getExpiryDate().getTime() - cal.getTime().getTime()) <= 0) {
        return "Token Expired";
    }

    UserPrincipal userPrincipal = new UserPrincipal(passToken.getUser());
    Authentication auth = new UsernamePasswordAuthenticationToken(
      userPrincipal, null, userPrincipal.getAuthorities());
    SecurityContextHolder.getContext().setAuthentication(auth);
    return null;
}

Наконец, вот реализация обновления пароля:

@RequestMapping(value = "/users/updatePassword", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public void changeUserPassword(@RequestParam("password") String password) {
    userService.changeUserPassword(userService.getCurrentUser(), password);
}

5.4. Измени пароль

Далее мы собираемся реализовать аналогичную функцию - изменить пароль внутри компании:

@RequestMapping(value = "/users/changePassword", method = RequestMethod.POST)
@ResponseStatus(HttpStatus.OK)
public void changeUserPassword(@RequestParam("password") String password,
  @RequestParam("oldpassword") String oldPassword) {
    User user = userService.getCurrentUser();
    if (!userService.checkIfValidOldPassword(user, oldPassword)) {
        throw new InvalidOldPasswordException("Invalid old password");
    }
    userService.changeUserPassword(user, password);
}
public void changeUserPassword(User user, String password) {
    user.setPassword(passwordEncoder.encode(password));
    userRepository.save(user);
}

6. Усилить проект

Затем давайте преобразуем / обновим проект до Spring Boot; сначала мы изменимpom.xml:

...

    org.springframework.boot
    spring-boot-starter-parent
    1.2.5.RELEASE



    
        org.springframework.boot
        spring-boot-starter-web
    

    
       org.aspectj
       aspectjweaver
     
...

А также укажитеa simple Boot application for startup:

@SpringBootApplication
public class Application {

    @Bean
    public SessionListener sessionListener() {
        return new SessionListener();
    }

    @Bean
    public RequestContextListener requestContextListener() {
        return new RequestContextListener();
    }

    public static void main(String... args) {
        SpringApplication.run(Application.class, args);
    }
}

Обратите внимание, чтоthe new base URL теперь будетhttp://localhost:8080 вместо старогоhttp://localhost:8080/reddit-scheduler.

7. Внешние свойства

Теперь, когда у нас есть Boot in, мы можем использовать@ConfigurationProperties для экстернализации наших свойств Reddit:

@ConfigurationProperties(prefix = "reddit")
@Component
public class RedditProperties {

    private String clientID;
    private String clientSecret;
    private String accessTokenUri;
    private String userAuthorizationUri;
    private String redirectUri;

    public String getClientID() {
        return clientID;
    }

    ...
}

Теперь мы можем чисто использовать эти свойства безопасным для типов образом:

@Autowired
private RedditProperties redditProperties;

@Bean
public OAuth2ProtectedResourceDetails reddit() {
    AuthorizationCodeResourceDetails details = new AuthorizationCodeResourceDetails();
    details.setClientId(redditProperties.getClientID());
    details.setClientSecret(redditProperties.getClientSecret());
    details.setAccessTokenUri(redditProperties.getAccessTokenUri());
    details.setUserAuthorizationUri(redditProperties.getUserAuthorizationUri());
    details.setPreEstablishedRedirectUri(redditProperties.getRedirectUri());
    ...
    return details;
}

8. Заключение

Этот раунд улучшений был очень хорошим шагом вперед для приложения.

Мы больше не добавляем никаких важных функций, поэтому улучшение архитектуры станет следующим логическим шагом - именно об этом и идет эта статья.