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

1概要

このチュートリアルでは、リンクの一部として構築している単純なRedditアプリケーションを改良していきます。

** 2管理者にとってより良いテーブル

**

まず、jQueryのDataTableプラグインを使用して、Adminページのテーブルをユーザー向けアプリケーションのテーブルと同じレベルにします。

2.1. ページ付けされたユーザーを取得 - サービス層

サービス層に改ページ対応操作を追加しましょう。

public List<User> 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をクライアントに一貫してきれいに返すようにしましょう。

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

public class UserDto {
    private Long id;

    private String username;

    private Set<Role> roles;

    private long scheduledPostsCount;
}

2.3. ユーザーをページ区切りで表示する - コントローラーで

それでは、この単純な操作をコントローラー層にも実装しましょう。

public List<UserDto> 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<User> 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. フロントエンド

最後に、クライアントサイドで、この新しい操作を使用して、管理ユーザーページを再実装しましょう。

<table><thead><tr>
<th>Username</th><th>Scheduled Posts Count</th><th>Roles</th><th>Actions</th>
</tr></thead></table>

<script>
$(function(){
    $('table').dataTable( {
        "processing": true,
        "searching":false,
        "columnDefs":[            { "name": "username",   "targets": 0},
            { "name": "scheduledPostsCount",   "targets": 1,"orderable": false},
            { "targets": 2, "data": "roles", "width":"20%", "orderable": false,
              "render":
                function ( data, type, full, meta ) { return extractRolesName(data); } },
            { "targets": 3, "data": "id", "render": function ( data, type, full, meta ) {
                return '<a onclick="showEditModal('+data+',\'' +
                  extractRolesName(full.roles)+'\')">Modify User Roles</a>'; }}
                    ],
        "columns":[            { "data": "username" },
            { "data": "scheduledPostsCount" }
       ],
        "serverSide": true,
        "ajax": function(data, callback, settings) {
            $.get('admin/users', {
                size: data.length,
                page: (data.start/data.length),
                sortDir: data.order[0].dir,
                sort: data.columns[data.order[0].column].name
            }, function(res,textStatus, request) {
                var pagingInfo = request.getResponseHeader('PAGING__INFO');
                var total = pagingInfo.split(",")[0].split("=")[1];
                callback({
                    recordsTotal: total,recordsFiltered: total,data: res
            });});
        }
});});
</script>

3ユーザーを無効にする

次に、簡単な管理機能 - ユーザーを無効にする機能 - を構築します。

最初に必要なのは、 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セッションタイムアウト処理

次に、 セッションタイムアウト を処理するようにアプリを設定しましょう - 私たちのコンテキストリンクに単純な SessionListener を追加します。/servlet-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登録を強化する

次に、以前は欠けていた機能をいくつか追加することで、登録フローを強化します。

ここでは主な点だけを説明します。登録に深く入り込むには - 登録シリーズ を調べてください。

5.1. 登録確認メール

登録に欠けているこれらの機能の1つは、ユーザーが彼らのEメールを確認するように促されなかったことでした。

システムでアクティブになる前に、まずユーザーに自分のメールアドレスを確認させます。

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);
}

これで、サービス層は単にユーザーにEメールを送信します。リンクを使って、パスワードをリセットできます。

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. パスワードを再設定する

ユーザーが電子メールのリンクをクリックすると、実際には パスワードのリセット操作を実行できます

@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 を変更します。

...
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.2.5.RELEASE</version>
</parent>

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

    <dependency>
       <groupId>org.aspectj</groupId>
       <artifactId>aspectjweaver</artifactId>
     </dependency>
...

また、起動用のシンプルなBootアプリケーションも提供します。

@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);
    }
}
  • 新しいベース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結論

この一連の改善は、アプリケーションにとって非常に良い前進です。

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