Redditアプリケーションの最初の改善

投稿日: 2019-10-18 2022-10-16
タグ: REST, Security, Spring

1. 概要

RedditWebアプリケーションのケーススタディは順調に進んでおり、小さなWebアプリケーションは形を整え、徐々に使用できるようになっています。

今回の記事では、既存の機能に小さな改善を加えます。一部は外部向けで、一部はそうではありません。一般的にアプリを改善します。

2. セットアップチェック

アプリケーションがブートストラップされたときに実行する必要があるいくつかの単純な、しかし便利なチェックから始めましょう。

@Autowired
private UserRepository repo;

@PostConstruct
public void startupCheck() {
    if (StringUtils.isBlank(accessTokenUri) || 
      StringUtils.isBlank(userAuthorizationUri) || 
      StringUtils.isBlank(clientID) || StringUtils.isBlank(clientSecret)) {
        throw new RuntimeException("Incomplete reddit properties");
    }
    repo.findAll();
}

ここで@PostConstructアノテーションを使用して、依存性注入プロセスが終了した後、アプリケーションのライフサイクルにフックする方法に注意してください。

簡単な目標は次のとおりです。

RedditAPIにアクセスするために必要なすべてのプロパティがあるかどうかを確認します
永続化レイヤーが機能していることを確認します（単純な findAll 呼び出しを発行することにより）

失敗した場合–早期に失敗します。

3. 「リクエストが多すぎる」Redditの問題

Reddit APIは、一意の「User-Agent」を送信しないレート制限リクエストに積極的です。

したがって、カスタム Interceptor を使用して、この一意のUser-AgentヘッダーをredditRestTemplateに追加する必要があります。

**3.1. カスタムインターセプターを作成する**

カスタムインターセプター– UserAgentInterceptor ：

public class UserAgentInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(
      HttpRequest request, byte[] body, 
      ClientHttpRequestExecution execution) throws IOException {

        HttpHeaders headers = request.getHeaders();
        headers.add("User-Agent", "Schedule with Reddit");
        return execution.execute(request, body);
    }
}

**3.2. redditRestTemplateを構成します**

もちろん、使用しているredditRestTemplateを使用してこのインターセプターを設定する必要があります。

@Bean
public OAuth2RestTemplate redditRestTemplate(OAuth2ClientContext clientContext) {
    OAuth2RestTemplate template = new OAuth2RestTemplate(reddit(), clientContext);
    List<ClientHttpRequestInterceptor> list = new ArrayList<ClientHttpRequestInterceptor>();
    list.add(new UserAgentInterceptor());
    template.setInterceptors(list);
    return template;
}

4. テスト用にH2データベースを構成する

次へ–先に進んで、テスト用にインメモリDB – H2 –をセットアップしましょう。この依存関係をpom.xmlに追加する必要があります。

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <version>1.4.187</version>
</dependency>

そして、persistence-test.propertiesを定義します。

## DataSource Configuration ###
jdbc.driverClassName=org.h2.Driver
jdbc.url=jdbc:h2:mem:oauth_reddit;DB_CLOSE_DELAY=-1
jdbc.user=sa
jdbc.pass=
## Hibernate Configuration ##
hibernate.dialect=org.hibernate.dialect.H2Dialect
hibernate.hbm2ddl.auto=update

5. Thymeleafに切り替えます

JSPが出て、Thymeleafが入っています。

**5.1. pom.xmlを変更します**

まず、これらの依存関係をpom.xmlに追加する必要があります。

<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf</artifactId>
    <version>2.1.4.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf-spring4</artifactId>
    <version>2.1.4.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-springsecurity3</artifactId>
    <version>2.1.2.RELEASE</version>
</dependency>

**5.2. ThymeleafConfigを作成します**

次へ–単純な ThymeleafConfig ：

@Configuration
public class ThymeleafConfig {
    @Bean
    public TemplateResolver templateResolver() {
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver();
        templateResolver.setPrefix("/WEB-INF/jsp/");
        templateResolver.setSuffix(".jsp");
        return templateResolver;
    }

    @Bean
    public SpringTemplateEngine templateEngine() {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver());
        templateEngine.addDialect(new SpringSecurityDialect());
        return templateEngine;
    }

    @Bean
    public ViewResolver viewResolver() {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setTemplateEngine(templateEngine());
        viewResolver.setOrder(1);
        return viewResolver;
    }
}

そしてそれをServletInitializerに追加します。

@Override
protected WebApplicationContext createServletApplicationContext() {
    AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
    context.register(PersistenceJPAConfig.class, WebConfig.class, 
      SecurityConfig.class, ThymeleafConfig.class);
    return context;
}

**5.3. home.htmlを変更します**

そしてホームページの簡単な変更：

<html>
<head>
<title>Schedule to Reddit</title>
</head>
<body>
<div class="container">
        <h1>Welcome, <small><span sec:authentication="principal.username">Bob</span></small></h1>
        <br/>
        <a href="posts" >My Scheduled Posts</a>
        <a href="post" >Post to Reddit</a>
        <a href="postSchedule" >Schedule Post to Reddit</a>
</div>
</body>
</html>

6. ログアウト

それでは、アプリケーションのエンドユーザーに実際に表示されるいくつかの改善を行いましょう。ログアウトから始めます。

セキュリティ設定を変更して、アプリケーションに簡単なログアウトオプションを追加します。

@Override
protected void configure(HttpSecurity http) throws Exception {
    http
        .....
        .and()
        .logout()
        .deleteCookies("JSESSIONID")
        .logoutUrl("/logout")
        .logoutSuccessUrl("/");
}

7. Subredditオートコンプリート

次へ–サブレディットを埋めるためのシンプルなオートコンプリート機能を実装しましょう。手動で書くのは良い方法ではありません。間違ってしまう可能性がかなりあるからです。

クライアント側から始めましょう：

<input id="sr" name="sr"/>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.11.2/jquery-ui.min.js"></script>
<script>
$(function() {
    $( "#sr" ).autocomplete({
        source: "/subredditAutoComplete"
    });
});
</script>

十分に単純です。さて、サーバー側：

@RequestMapping(value = "/subredditAutoComplete")
@ResponseBody
public String subredditAutoComplete(@RequestParam("term") String term) {
    MultiValueMap<String, String> param = new LinkedMultiValueMap<String, String>();
    param.add("query", term);
    JsonNode node = redditRestTemplate.postForObject(
      "https://oauth.reddit.com//api/search_reddit_names", param, JsonNode.class);
    return node.get("names").toString();
}

8. リンクがすでにRedditにあるかどうかを確認する

次へ–Redditにリンクがすでに送信されているかどうかを確認する方法を見てみましょう。

これがsubmissionForm.htmlです。

<input name="url" />
<input name="sr">

<a href="#" onclick="checkIfAlreadySubmitted()">Check if already submitted</a>
<span id="checkResult" style="display:none"></span>

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script>
$(function() {
    $("input[name='url'],input[name='sr']").focus(function (){
        $("#checkResult").hide();
    });
});
function checkIfAlreadySubmitted(){
    var url = $("input[name='url']").val();
    var sr = $("input[name='sr']").val();
    if(url.length >3 && sr.length > 3){
        $.post("checkIfAlreadySubmitted",{url: url, sr: sr}, function(data){
            var result = JSON.parse(data);
            if(result.length == 0){
                $("#checkResult").show().html("Not submitted before");
            }else{
                $("#checkResult").show().html(
               'Already submitted <b><a target="_blank" href="http://www.reddit.com'
               +result[0].data.permalink+'">here</a></b>');
            }
        });
    }
    else{
        $("#checkResult").show().html("Too short url and/or subreddit");
    }
}           
</script>

そして、これが私たちのコントローラーメソッドです：

@RequestMapping(value = "/checkIfAlreadySubmitted", method = RequestMethod.POST)
@ResponseBody
public String checkIfAlreadySubmitted(
  @RequestParam("url") String url, @RequestParam("sr") String sr) {
    JsonNode node = redditRestTemplate.getForObject(
      "https://oauth.reddit.com/r/" + sr + "/search?q=url:" + url + "&restrict_sr=on", JsonNode.class);
    return node.get("data").get("children").toString();
}

9. Herokuへのデプロイ

最後に、Herokuへのデプロイをセットアップし、無料利用枠を使用してサンプルアプリを強化します。

**9.1. pom.xmlを変更します**

まず、このWebRunnerプラグインをpom.xmlに追加する必要があります。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>2.3</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals><goal>copy</goal></goals>
            <configuration>
                <artifactItems>
                    <artifactItem>
                        <groupId>com.github.jsimone</groupId>
                        <artifactId>webapp-runner</artifactId>
                        <version>7.0.57.2</version>
                        <destFileName>webapp-runner.jar</destFileName>
                    </artifactItem>
                </artifactItems>
            </configuration>
        </execution>
    </executions>
</plugin>

注–WebRunnerを使用してHerokuでアプリを起動します。

HerokuでPostgresqlを使用するので、ドライバーに依存する必要があります。

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>9.4-1201-jdbc41</version>
</dependency>

9.2. Procfile

サーバーで実行されるプロセスをProcfileで次のように定義する必要があります。

web:    java $JAVA_OPTS -jar target/dependency/webapp-runner.jar --port $PORT target/*.war

9.3. Herokuアプリを作成する

プロジェクトからHerokuアプリを作成するには、次のようにします。

cd path_to_your_project
heroku login
heroku create

9.4. データベース構成

次に、アプリのPostgresデータベースプロパティを使用してデータベースを構成する必要があります。

たとえば、persistence-prod.propertiesは次のとおりです。

## DataSource Configuration ##
jdbc.driverClassName=org.postgresql.Driver
jdbc.url=jdbc:postgresql://hostname:5432/databasename
jdbc.user=xxxxxxxxxxxxxx
jdbc.pass=xxxxxxxxxxxxxxxxx

## Hibernate Configuration ##
hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
hibernate.hbm2ddl.auto=update

Herokuダッシュボードからデータベースの詳細[ホスト名、データベース名、ユーザー、パスワード]を取得する必要があることに注意してください。

また、ほとんどの場合と同様に、キーワード「user」はPostgres の予約語であるため、「User」エンティティテーブル名を変更する必要があります。

@Entity
@Table(name = "APP_USER")
public class User { .... }

9.5. コードをHeokuにプッシュ

では、コードをHerokuにプッシュしましょう。

git add .
git commit -m "init"
git push heroku master

10. 結論

ケーススタディのこの4番目の部分では、焦点は小さいですが重要な改善でした。フォローしていると、これがどのように面白くて便利な小さなアプリになりつつあるかがわかります。

getdocs

13036