Redditアプリケーションの4回目の改善

Redditアプリケーションの改善の第4ラウンド

1. 概要

このチュートリアルでは、this public case studyの一部として構築している単純なRedditアプリケーションを改善し続けます。

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が一貫してクライアントにクリーンに返されることを確認しましょう。

これまで、APIは実際のUserエンティティをクライアントに返していたため、ユーザーDTOが必要になります。

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)を構築します。

最初に必要なのは、Userエンティティのenabledフィールドです。

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を構成しましょう–コンテキストto control session timeoutに単純なSessionListenerを追加します。

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. 登録確認メール

登録に欠けているこれらの機能の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. プロジェクトを起動します

次に、プロジェクトをSpringBootに変換/アップグレードしましょう。まず、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/reddit-schedulerではなくhttp://localhost:8080になることに注意してください。

7. プロパティを外部化する

ブートインしたので、@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. 結論

この改善のラウンドは、アプリケーションにとって非常に良い前進でした。

これ以上主要な機能を追加することはありません。これにより、アーキテクチャの改善が次の論理的なステップになります。これがこの記事の内容です。