Spring Boot Redis Cache

チュートリアル
Spring

Spring Boot Redisキャッシュ

この投稿では、サンプルのSpring Bootアプリケーションを設定し、Redisキャッシュと統合します。Redisは、データベース、キャッシュ、およびメッセージブローカーとして使用されるオープンソースのインメモリデータ構造ストアですが、このレッスンではキャッシュの統合のみを示します。プロジェクトを素早く設定するために、Spring Initializrツールを使用します。

Spring Boot Redisプロジェクトのセットアップ

プロジェクトを素早く設定するために、Spring Initializrツールを使用します。以下に示すように、3つの依存関係を使用します：プロジェクトをダウンロードして解凍します。アプリケーションが停止されるとすべてのデータが失われる組み込みデータベースを使用するため、H2データベース依存性を使用しました。

Spring Boot Redis キャッシュ Maven 依存関係

ツールを使ってセットアップは完了していますが、手動でセットアップしたい場合は、このプロジェクトに Maven ビルドシステムを使用し、以下は使用した依存関係です：

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>1.5.9.RELEASE</version>
  <relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  <java.version>1.8</java.version>
</properties>
<dependencies>
  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>

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

  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
     <scope>test</scope>
  </dependency>

  <!-- for JPA support -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
  </dependency>

  <!-- for embedded database support -->
  <dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
  </dependency>

</dependencies>

<build>
  <plugins>
     <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
     </plugin>
  </plugins>
</build>

maven centralから Spring Boot の安定版を使用してください。

モデルの定義

Redis データベースにオブジェクトを保存するために、基本的なフィールドを持つ Person モデルオブジェクトを定義します：

package com.journaldev.rediscachedemo;

import javax.persistence.*;
import java.io.Serializable;

@Entity
public class User implements Serializable {

    private static final long serialVersionUID = 7156526077883281623L;

    @Id
    @SequenceGenerator(name = "SEQ_GEN", sequenceName = "SEQ_USER", allocationSize = 1)
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "SEQ_GEN")
    private Long id;
    private String name;
    private long followers;

    public User() {
    }

    public User(String name, long followers) {
        this.name = name;
        this.followers = followers;
    }

    // 標準のゲッターとセッター

    @Override
    public String toString() {
        return String.format("User{id=%d, name='%s', followers=%d}", id, name, followers);
    }
}

これは、ゲッターとセッターを持つ標準の POJO です。

Redis キャッシュの設定

Spring Boot と必要な依存関係が Maven で既に動作している場合、application.properties ファイルでわずか三行でローカル Redis インスタンスを構成できます：

# Redis 設定
spring.cache.type=redis
spring.redis.host=localhost
spring.redis.port=6379

また、Spring Boot のメインクラスに @EnableCaching アノテーションを使用してください：

package com.journaldev.rediscachedemo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

@SpringBootApplication
@EnableCaching
public class Application implements CommandLineRunner {

  private final Logger LOG = LoggerFactory.getLogger(getClass());
  private final UserRepository userRepository;

  @Autowired
  public Application(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

  @Override
  public void run(String... strings) {
    // 埋め込みデータベースのポピュレーティング
    LOG.info("Saving users. Current user count is {}.", userRepository.count());
    User shubham = new User("Shubham", 2000);
    User pankaj = new User("Pankaj", 29000);
    User lewis = new User("Lewis", 550);

    userRepository.save(shubham);
    userRepository.save(pankaj);
    userRepository.save(lewis);
    LOG.info("Done saving users. Data: {}.", userRepository.findAll());
  }
}

H2データベースにサンプルデータを追加したいので、CommandLineRunnerを追加しました。

リポジトリの定義

Redisの動作方法を示す前に、JPA関連の機能のためにリポジトリを定義します。

package com.journaldev.rediscachedemo;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository { }

現時点ではメソッド呼び出しはありません。必要がないからです。

コントローラーの定義

コントローラーはRedisキャッシュを呼び出す場所です。実際、これは最適な場所です。キャッシュが直接関連付けられているため、リクエストはサービスコードに入る必要さえありません。以下は、コントローラーの骨組みです。

package com.journaldev.rediscachedemo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.web.bind.annotation.*;

@RestController
public class UserController {

  private final Logger LOG = LoggerFactory.getLogger(getClass());

  private final UserRepository userRepository;

  @Autowired
  public UserController(UserRepository userRepository) {
    this.userRepository = userRepository;
  }
   ...
}

今、キャッシュに何かを入れるには、@Cacheable注釈を使用します。

@Cacheable(value = "users", key = "#userId", unless = "#result.followers < 12000")
@RequestMapping(value = "/{userId}", method = RequestMethod.GET)
public User getUser(@PathVariable String userId) {
  LOG.info("Getting user with ID {}.", userId);
  return userRepository.findOne(Long.valueOf(userId));
}

上記のマッピングでは、getUserメソッドが「users」という名前のキャッシュに人を入れ、その人を「userId」というキーで識別し、フォロワーが12000より大きいユーザーのみを保存します。これにより、非常に人気のあるユーザーが頻繁にクエリされるため、キャッシュがこれらのユーザーで満たされることを確認できます。また、意図的にAPI呼び出しでログステートメントを追加しました。この時点でPostmanからいくつかのAPI呼び出しを行います。これらは私たちが行った呼び出しです。

localhost:8090/1
localhost:8090/1
localhost:8090/2
localhost:8090/2

ログを注意深く見ると、これらがそれです。

... : Getting user with ID 1.
... : Getting user with ID 1.
... : Getting user with ID 2.

気付いた？私たちは4つのAPI呼び出しを行いましたが、ログステートメントは3つしかありませんでした。これは、ID 2のユーザーが29000人のフォロワーを持っているため、そのデータがキャッシュされているためです。つまり、それに対してAPI呼び出しが行われたとき、データはキャッシュから返され、このためにDB呼び出しが行われませんでした！

キャッシュの更新

キャッシュの値は、実際のオブジェクトの値が更新されるときにも更新される必要があります。これは、@CachePut注釈を使用して行うことができます：

@CachePut(value = "users", key = "#user.id")
@PutMapping("/update")
public User updatePersonByID(@RequestBody User user) {
  userRepository.save(user);
  return user;
}

これにより、人は再びそのIDで識別され、結果で更新されます。

キャッシュのクリア

実際のデータベースからデータを削除する場合、それをキャッシュに保持する意味はもはやありません。@CacheEvict注釈を使用してキャッシュデータをクリアできます：

@CacheEvict(value = "users", allEntries=true)
@DeleteMapping("/{id}")
public void deleteUserByID(@PathVariable Long id) {
  LOG.info("deleting person with id {}", id);
  userRepository.delete(id);
}

最後のマッピングでは、キャッシュエントリーを削除するだけで、それ以外のことは何もしませんでした。

Spring Boot Redisキャッシュアプリケーションの実行

このアプリを単一のコマンドで実行できます：

mvn spring-boot:run

Redisキャッシュの制限

Redisは非常に高速ですが、64ビットシステムではデータを無制限に保存できます。32ビットシステムではデータを3GBまでしか保存できません。使用可能なメモリが増えると、ヒット率が向上しますが、Redisが占有するメモリが過剰になるとヒット率が低下することがあります。キャッシュサイズがメモリ制限に達すると、古いデータが削除され、新しいデータが追加されます。

まとめ

このレッスンでは、Redisキャッシュが高速なデータインタラクションを提供し、Spring Bootとどのように最小限で強力な構成で統合できるかを見てきました。コメントをご自由にお書きください。

Spring Boot Redisキャッシュプロジェクトのダウンロード

Source:
https://www.digitalocean.com/community/tutorials/spring-boot-redis-cache