Redditアプリケーションの3回目の改良

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

1. 概要

この記事では、既存の機能に小さいながらも便利な改善を実装することで、our little case study appを前進させ続けます。

2. より良いテーブル

まず、jQuery DataTablesプラグインを使用して、アプリが以前使用していた古い基本的なテーブルを置き換えます。

2.1. 投稿リポジトリとサービス

まず、count the scheduled posts of a userにメソッドを追加します–もちろんSpringData構文を利用します。

public interface PostRepository extends JpaRepository {
    ...
    Long countByUser(User user);
}

次に、the service layer implementationを簡単に見てみましょう–ページネーションパラメータに基づいてユーザーの投稿を取得します。

@Override
public List getPostsList(int page, int size, String sortDir, String sort) {
    PageRequest pageReq = new PageRequest(page, size, Sort.Direction.fromString(sortDir), sort);
    Page posts = postRepository.findByUser(userService.getCurrentUser(), pageReq);
    return constructDataAccordingToUserTimezone(posts.getContent());
}

私たちはconverting the dates based on the timezone of the userです：

private List constructDataAccordingToUserTimezone(List posts) {
    String timeZone = userService.getCurrentUser().getPreference().getTimezone();
    return posts.stream().map(post -> new SimplePostDto(
      post, convertToUserTomeZone(post.getSubmissionDate(), timeZone)))
      .collect(Collectors.toList());
}
private String convertToUserTomeZone(Date date, String timeZone) {
    dateFormat.setTimeZone(TimeZone.getTimeZone(timeZone));
    return dateFormat.format(date);
}

2.2. ページネーションを使用したAPI

次に、APIを介して、完全なページ付けと並べ替えを使用してこの操作を公開します。

@RequestMapping(method = RequestMethod.GET)
@ResponseBody
public List getScheduledPosts(
  @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 = "title") String sort,
  HttpServletResponse response) {
    response.addHeader("PAGING_INFO",
      scheduledPostService.generatePagingInfo(page, size).toString());
    return scheduledPostService.getPostsList(page, size, sortDir, sort);
}

カスタムヘッダーを使用してページネーション情報をクライアントに渡す方法に注意してください。他にも、もう少し標準的なways to do thisがあります。これは、後で調べる方法です。

ただし、この実装で十分です。ページング情報を生成する簡単な方法があります。

public PagingInfo generatePagingInfo(int page, int size) {
    long total = postRepository.countByUser(userService.getCurrentUser());
    return new PagingInfo(page, size, total);
}

そして、PagingInfo自体：

public class PagingInfo {
    private long totalNoRecords;
    private int totalNoPages;
    private String uriToNextPage;
    private String uriToPrevPage;

    public PagingInfo(int page, int size, long totalNoRecords) {
        this.totalNoRecords = totalNoRecords;
        this.totalNoPages = Math.round(totalNoRecords / size);
        if (page > 0) {
            this.uriToPrevPage = "page=" + (page - 1) + "&size=" + size;
        }
        if (page < this.totalNoPages) {
            this.uriToNextPage = "page=" + (page + 1) + "&size=" + size;
        }
    }
}

2.3. フロントエンド

最後に、単純なフロントエンドはカスタムJSメソッドを使用してAPIと対話し、jQuery DataTable parametersを処理します。



Post title Submission Date Status
Resubmit Attempts left Actions

2.4. ページングのAPIテスト

APIが公開されたら、a few simple API testsを記述して、ページングメカニズムの基本が期待どおりに機能することを確認できます。

@Test
public void givenMoreThanOnePage_whenGettingUserScheduledPosts_thenNextPageExist()
  throws ParseException, IOException {
    createPost();
    createPost();
    createPost();

    Response response = givenAuth().
      params("page", 0, "size", 2).get(urlPrefix + "/api/scheduledPosts");

    assertEquals(200, response.statusCode());
    assertTrue(response.as(List.class).size() > 0);

    String pagingInfo = response.getHeader("PAGING_INFO");
    long totalNoRecords = Long.parseLong(pagingInfo.split(",")[0].split("=")[1]);
    String uriToNextPage = pagingInfo.split(",")[2].replace("uriToNextPage=", "").trim();

    assertTrue(totalNoRecords > 2);
    assertEquals(uriToNextPage, "page=1&size=2");
}

@Test
public void givenMoreThanOnePage_whenGettingUserScheduledPostsForSecondPage_thenCorrect()
  throws ParseException, IOException {
    createPost();
    createPost();
    createPost();

    Response response = givenAuth().
      params("page", 1, "size", 2).get(urlPrefix + "/api/scheduledPosts");

    assertEquals(200, response.statusCode());
    assertTrue(response.as(List.class).size() > 0);

    String pagingInfo = response.getHeader("PAGING_INFO");
    long totalNoRecords = Long.parseLong(pagingInfo.split(",")[0].split("=")[1]);
    String uriToPrevPage = pagingInfo.split(",")[3].replace("uriToPrevPage=", "").trim();

    assertTrue(totalNoRecords > 2);
    assertEquals(uriToPrevPage, "page=0&size=2");
}

3. メール通知

次に、基本的なメール通知フローを構築します–スケジュールされた投稿が送信されるときのwhere a user receives emails：

3.1. Eメール構成

まず、メールの設定を行いましょう。

@Bean
public JavaMailSenderImpl javaMailSenderImpl() {
    JavaMailSenderImpl mailSenderImpl = new JavaMailSenderImpl();
    mailSenderImpl.setHost(env.getProperty("smtp.host"));
    mailSenderImpl.setPort(env.getProperty("smtp.port", Integer.class));
    mailSenderImpl.setProtocol(env.getProperty("smtp.protocol"));
    mailSenderImpl.setUsername(env.getProperty("smtp.username"));
    mailSenderImpl.setPassword(env.getProperty("smtp.password"));
    Properties javaMailProps = new Properties();
    javaMailProps.put("mail.smtp.auth", true);
    javaMailProps.put("mail.smtp.starttls.enable", true);
    mailSenderImpl.setJavaMailProperties(javaMailProps);
    return mailSenderImpl;
}

SMTPを機能させるために必要なプロパティとともに：

smtp.host=email-smtp.us-east-1.amazonaws.com
smtp.port=465
smtp.protocol=smtps
smtp.username=example
smtp.password=
[email protected]

3.2. 投稿が公開されたときにイベントを発生させる

スケジュールされた投稿がRedditに正常に公開されたときに、イベントを開始することを確認しましょう。

private void updatePostFromResponse(JsonNode node, Post post) {
    JsonNode errorNode = node.get("json").get("errors").get(0);
    if (errorNode == null) {
        ...
        String email = post.getUser().getPreference().getEmail();
        eventPublisher.publishEvent(new OnPostSubmittedEvent(post, email));
    }
    ...
}

3.3. イベントとリスナー

イベントの実装は非常に簡単です。

public class OnPostSubmittedEvent extends ApplicationEvent {
    private Post post;
    private String email;

    public OnPostSubmittedEvent(Post post, String email) {
        super(post);
        this.post = post;
        this.email = email;
    }
}

そしてリスナー：

@Component
public class SubmissionListner implements ApplicationListener {
    @Autowired
    private JavaMailSender mailSender;

    @Autowired
    private Environment env;

    @Override
    public void onApplicationEvent(OnPostSubmittedEvent event) {
        SimpleMailMessage email = constructEmailMessage(event);
        mailSender.send(email);
    }

    private SimpleMailMessage constructEmailMessage(OnPostSubmittedEvent event) {
        String recipientAddress = event.getEmail();
        String subject = "Your scheduled post submitted";
        SimpleMailMessage email = new SimpleMailMessage();
        email.setTo(recipientAddress);
        email.setSubject(subject);
        email.setText(constructMailContent(event.getPost()));
        email.setFrom(env.getProperty("support.email"));
        return email;
    }

    private String constructMailContent(Post post) {
        return "Your post " + post.getTitle() + " is submitted.\n" +
          "http://www.reddit.com/r/" + post.getSubreddit() +
          "/comments/" + post.getRedditID();
    }
}

4. 総投票数の使用

次に、再送信オプションを単純化するためのいくつかの作業を行います–賛成率（理解するのが困難でした）ではなく–it’s now working with the total number of votes。

投稿スコアと投票率を使用して総投票数を計算できます。

スコア=プラス投票-マイナス投票
総投票数=プラス投票+マイナス投票
投票率=投票数/総投票数

など：

総投票数= Math.round（スコア/（（2 *賛成率）– 1））

まず、スコアロジックを変更して、この総投票数を計算して追跡します。

public PostScores getPostScores(Post post) {
    ...

    float ratio = node.get("upvote_ratio").floatValue();
    postScore.setTotalVotes(Math.round(postScore.getScore() / ((2 * ratio) - 1)));

    ...
}

そしてもちろん、checking if a post is considered failed or notの場合にそれを利用します。

private boolean didPostGoalFail(Post post) {
    PostScores postScores = getPostScores(post);
    int totalVotes = postScores.getTotalVotes();
    ...
    return (((score < post.getMinScoreRequired()) ||
            (totalVotes < post.getMinTotalVotes())) &&
            !((noOfComments > 0) && post.isKeepIfHasComments()));
}

最後に、もちろん古いratioフィールドを使用から削除します。

5. 再送信オプションの検証

最後に、複雑な再送信オプションにいくつかの検証を追加することにより、ユーザーを支援します。

**5.1. ScheduledPostサービス**

単純なcheckIfValidResubmitOptions()メソッドは次のとおりです。

private boolean checkIfValidResubmitOptions(Post post) {
    if (checkIfAllNonZero(
          post.getNoOfAttempts(),
          post.getTimeInterval(),
          post.getMinScoreRequired())) {
        return true;
    } else {
        return false;
    }
}
private boolean checkIfAllNonZero(int... args) {
    for (int tmp : args) {
       if (tmp == 0) {
           return false;
        }
    }
    return true;
}

新しい投稿をスケジュールするときに、この検証をうまく利用します。

public Post schedulePost(boolean isSuperUser, Post post, boolean resubmitOptionsActivated)
  throws ParseException {
    if (resubmitOptionsActivated && !checkIfValidResubmitOptions(post)) {
        throw new InvalidResubmitOptionsException("Invalid Resubmit Options");
    }
    ...
}

再送信ロジックがオンの場合、次のフィールドにはゼロ以外の値が必要であることに注意してください。

試行回数
時間間隔
最低限必要なスコア

5.2. 例外処理

最後に–無効な入力の場合、InvalidResubmitOptionsExceptionはメインのエラー処理ロジックで処理されます。

@ExceptionHandler({ InvalidResubmitOptionsException.class })
public ResponseEntity

TOC