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

投稿日: 2019-10-19 2022-10-31
タグ: REST, Spring

1. 概要

進行中のケーススタディからRedditアプリケーションを進めていきましょう。

2. コメントの投稿で電子メール通知を送信する

Redditには電子メール通知がありません–わかりやすくシンプルです。私が見たいのは、誰かが私の投稿の1つにコメントするたびに、コメントが記載された短い電子メール通知を受け取ることです。

つまり、簡単に言えば、ここでのこの機能の目標は、コメントに関する電子メール通知です。

以下をチェックする単純なスケジューラーを実装します。

どのユーザーが投稿の返信を含む電子メール通知を受信する必要があるか
ユーザーがRedditの受信トレイに投稿の返信を受け取った場合

その後、未読の投稿返信を含む電子メール通知を送信するだけです。

2.1. ユーザー設定

まず、次を追加して、設定エンティティとDTOを変更する必要があります。

private boolean sendEmailReplies;

ユーザーが投稿の返信を含む電子メール通知を受信するかどうかを選択できるようにするため。

2.2. 通知スケジューラ

次に、単純なスケジューラーを示します。

@Component
public class NotificationRedditScheduler {

    @Autowired
    private INotificationRedditService notificationRedditService;

    @Autowired
    private PreferenceRepository preferenceRepository;

    @Scheduled(fixedRate = 60 * 60 * 1000)
    public void checkInboxUnread() {
        List<Preference> preferences = preferenceRepository.findBySendEmailRepliesTrue();
        for (Preference preference : preferences) {
            notificationRedditService.checkAndNotify(preference);
        }
    }
}

スケジューラーは1時間ごとに実行されることに注意してください。ただし、必要に応じて、もちろん、はるかに短いケイデンスで実行することもできます。

2.3. 通知サービス

それでは、通知サービスについて説明しましょう。

@Service
public class NotificationRedditService implements INotificationRedditService {
    private Logger logger = LoggerFactory.getLogger(getClass());
    private static String NOTIFICATION_TEMPLATE = "You have %d unread post replies.";
    private static String MESSAGE_TEMPLATE = "%s replied on your post %s : %s";

    @Autowired
    @Qualifier("schedulerRedditTemplate")
    private OAuth2RestTemplate redditRestTemplate;

    @Autowired
    private ApplicationEventPublisher eventPublisher;

    @Autowired
    private UserRepository userRepository;

    @Override
    public void checkAndNotify(Preference preference) {
        try {
            checkAndNotifyInternal(preference);
        } catch (Exception e) {
            logger.error(
              "Error occurred while checking and notifying = " + preference.getEmail(), e);
        }
    }

    private void checkAndNotifyInternal(Preference preference) {
        User user = userRepository.findByPreference(preference);
        if ((user == null) || (user.getAccessToken() == null)) {
            return;
        }

        DefaultOAuth2AccessToken token = new DefaultOAuth2AccessToken(user.getAccessToken());
        token.setRefreshToken(new DefaultOAuth2RefreshToken((user.getRefreshToken())));
        token.setExpiration(user.getTokenExpiration());
        redditRestTemplate.getOAuth2ClientContext().setAccessToken(token);

        JsonNode node = redditRestTemplate.getForObject(
          "https://oauth.reddit.com/message/selfreply?mark=false", JsonNode.class);
        parseRepliesNode(preference.getEmail(), node);
    }

    private void parseRepliesNode(String email, JsonNode node) {
        JsonNode allReplies = node.get("data").get("children");
        int unread = 0;
        for (JsonNode msg : allReplies) {
            if (msg.get("data").get("new").asBoolean()) {
                unread++;
            }
        }
        if (unread == 0) {
            return;
        }

        JsonNode firstMsg = allReplies.get(0).get("data");
        String author = firstMsg.get("author").asText();
        String postTitle = firstMsg.get("link_title").asText();
        String content = firstMsg.get("body").asText();

        StringBuilder builder = new StringBuilder();
        builder.append(String.format(NOTIFICATION_TEMPLATE, unread));
        builder.append("\n");
        builder.append(String.format(MESSAGE_TEMPLATE, author, postTitle, content));
        builder.append("\n");
        builder.append("Check all new replies at ");
        builder.append("https://www.reddit.com/message/unread/");

        eventPublisher.publishEvent(new OnNewPostReplyEvent(email, builder.toString()));
    }
}

ご了承ください：

Reddit APIを呼び出してすべての返信を取得し、それらを1つずつチェックして、新しい「未読」かどうかを確認します。
未読の返信がある場合は、イベントを発生させて、このユーザーにメール通知を送信します。

2.4. 新しい返信イベント

これが私たちの簡単なイベントです：

public class OnNewPostReplyEvent extends ApplicationEvent {
    private String email;
    private String content;

    public OnNewPostReplyEvent(String email, String content) {
        super(email);
        this.email = email;
        this.content = content;
    }
}

2.5. 返信リスナー

最後に、リスナーは次のとおりです。

@Component
public class ReplyListener implements ApplicationListener<OnNewPostReplyEvent> {
    @Autowired
    private JavaMailSender mailSender;

    @Autowired
    private Environment env;

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

    private SimpleMailMessage constructEmailMessage(OnNewPostReplyEvent event) {
        String recipientAddress = event.getEmail();
        String subject = "New Post Replies";
        SimpleMailMessage email = new SimpleMailMessage();
        email.setTo(recipientAddress);
        email.setSubject(subject);
        email.setText(event.getContent());
        email.setFrom(env.getProperty("support.email"));
        return email;
    }
}

3. セッション同時実行制御

次に、アプリケーションが許可する同時セッションの数に関して、より厳密なルールを設定しましょう。さらに重要な点– 同時セッションを許可しない：

@Override
protected void configure(HttpSecurity http) throws Exception {
    http.sessionManagement()
          .maximumSessions(1)
          .maxSessionsPreventsLogin(true);
}

カスタムUserDetails実装を使用しているため、 equals（）および hashcode（）をオーバーライドする必要があることに注意してください。これは、セッション制御戦略がすべてのプリンシパルをマップとそれらを取得できる必要があります：

public class UserPrincipal implements UserDetails {

    private User user;

    @Override
    public int hashCode() {
        int prime = 31;
        int result = 1;
        result = (prime * result) + ((user == null) ? 0 : user.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        UserPrincipal other = (UserPrincipal) obj;
        if (user == null) {
            if (other.user != null) {
                return false;
            }
        } else if (!user.equals(other.user)) {
            return false;
        }
        return true;
    }
}

4. 個別のAPIサーブレット

アプリケーションは現在、同じサーブレットからフロントエンドとAPIの両方を提供していますが、これは理想的ではありません。

次に、これら2つの主要な責任を分割して、2つの異なるサーブレットにまとめましょう。

@Bean
public ServletRegistrationBean frontendServlet() {
    ServletRegistrationBean registration = 
      new ServletRegistrationBean(new DispatcherServlet(), "/*");

    Map<String, String> params = new HashMap<String, String>();
    params.put("contextClass", 
      "org.springframework.web.context.support.AnnotationConfigWebApplicationContext");
    params.put("contextConfigLocation", "org.baeldung.config.frontend");
    registration.setInitParameters(params);
    
    registration.setName("FrontendServlet");
    registration.setLoadOnStartup(1);
    return registration;
}

@Bean
public ServletRegistrationBean apiServlet() {
    ServletRegistrationBean registration = 
      new ServletRegistrationBean(new DispatcherServlet(), "/api/*");
    
    Map<String, String> params = new HashMap<String, String>();
    params.put("contextClass", 
      "org.springframework.web.context.support.AnnotationConfigWebApplicationContext");
    params.put("contextConfigLocation", "org.baeldung.config.api");
    
    registration.setInitParameters(params);
    registration.setName("ApiServlet");
    registration.setLoadOnStartup(2);
    return registration;
}

@Override
protected SpringApplicationBuilder configure(final SpringApplicationBuilder application) {
    application.sources(Application.class);
    return application;
}

すべてのフロントエンドリクエストを処理し、フロントエンドに固有のSpringコンテキストのみをブートストラップするフロントエンドサーブレットがどのように作成されたかに注意してください。次に、APIサーブレットがあります–APIのまったく異なるSpringコンテキストをブートストラップします。

また、非常に重要ですが、これら2つのサーブレットのSpringコンテキストは子コンテキストです。 SpringApplicationBuilder によって作成された親コンテキストは、 root パッケージをスキャンして、永続性、サービスなどの一般的な構成を探します。

WebFrontendConfigは次のとおりです。

@Configuration
@EnableWebMvc
@ComponentScan({ "org.baeldung.web.controller.general" })
public class WebFrontendConfig implements WebMvcConfigurer {

    @Bean
    public static PropertySourcesPlaceholderConfigurer 
      propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }

    @Bean
    public ViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/jsp/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }

    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/home");
        ...
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
    }
}

そしてWebApiConfig：

@Configuration
@EnableWebMvc
@ComponentScan({ "org.baeldung.web.controller.rest", "org.baeldung.web.dto" })
public class WebApiConfig implements WebMvcConfigurer {

    @Bean
    public ModelMapper modelMapper() {
        return new ModelMapper();
    }
}

5. フィードのURLを短縮しない

最後に、RSSの操作を改善します。

RSSフィードが短縮されたり、Feedburnerなどの外部サービスを介してリダイレクトされたりすることがあります。そのため、アプリケーションにフィードのURLを読み込むときは、メインのURLに到達するまで、すべてのリダイレクトでそのURLをたどることを確認する必要があります。私たちは実際に気にしています。

つまり、記事のリンクをRedditに投稿するとき、実際には正しい元のURLを投稿します。

@RequestMapping(value = "/url/original")
@ResponseBody
public String getOriginalLink(@RequestParam("url") String sourceUrl) {
    try {
        List<String> visited = new ArrayList<String>();
        String currentUrl = sourceUrl;
        while (!visited.contains(currentUrl)) {
            visited.add(currentUrl);
            currentUrl = getOriginalUrl(currentUrl);
        }
        return currentUrl;
    } catch (Exception ex) {
        // log the exception
        return sourceUrl;
    }
}

private String getOriginalUrl(String oldUrl) throws IOException {
    URL url = new URL(oldUrl);
    HttpURLConnection connection = (HttpURLConnection) url.openConnection();
    connection.setInstanceFollowRedirects(false);
    String originalUrl = connection.getHeaderField("Location");
    connection.disconnect();
    if (originalUrl == null) {
        return oldUrl;
    }
    if (originalUrl.indexOf("?") != -1) {
        return originalUrl.substring(0, originalUrl.indexOf("?"));
    }
    return originalUrl;
}

この実装で注意すべき点がいくつかあります。

複数レベルのリダイレクトを処理しています
また、リダイレクトループを回避するために、アクセスしたすべてのURLを追跡しています

6. 結論

そしてそれだけです–Redditアプリケーションをより良くするためのいくつかの確かな改善。次のステップは、APIのパフォーマンステストを実行し、本番シナリオでAPIがどのように動作するかを確認することです。

getdocs

13036