The English version of quarkus.io is the official project site. Translated sites are community supported on a best-effort basis.
Back to Guides
このページを編集

Redisキャッシュ

デフォルトでは、Quarkus CacheはバックエンドとしてCaffeineを使用します。代わりにRedisを使用することも可能です。

この技術は、previewと考えられています。

preview では、下位互換性やエコシステムでの存在は保証されていません。具体的な改善には設定や API の変更が必要になるかもしれませんが、 stable になるための計画は現在進行中です。フィードバックは メーリングリスト や GitHub の課題管理 で受け付けています。

とりうるステータスの完全なリストについては、 FAQの項目 を参照してください。

キャッシュバックエンドとしてのRedis

QuarkusキャッシュのバックエンドとしてRedisを使用する場合、各キャッシュアイテムはRedisに保存されます:

  • バックエンドは <default> Redisクライアントを使うので(他に設定されていない場合)、設定されているようにしてください(または Redis Dev Service を使ってください)

  • the Redis key is built as follows: cache:{cache-name}:{cache-key}, where cache-key is the key the application uses and cache:{cache-name} the prefix.

  • 必要に応じて、値はJSONにエンコードされます。

Redisバックエンドの使用

まず、 quarkus-redis-cache のエクステンションをプロジェクトに追加する必要があります:

pom.xml
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-redis-cache</artifactId>
</dependency>
build.gradle
implementation("io.quarkus:quarkus-redis-cache")

その後、 Quarkus Cacheガイド で説明されているように、 @CacheResult や、その他のキャッシュアノテーションを使用します:

@GET
@Path("/{keyElement1}/{keyElement2}/{keyElement3}")
@CacheResult(cacheName = "expensiveResourceCache")
public ExpensiveResponse getExpensiveResponse(@PathParam("keyElement1") @CacheKey String keyElement1,
        @PathParam("keyElement2") @CacheKey String keyElement2, @PathParam("keyElement3") @CacheKey String keyElement3,
        @QueryParam("foo") String foo) {
    invocations.incrementAndGet();
    ExpensiveResponse response = new ExpensiveResponse();
    response.setResult(keyElement1 + " " + keyElement2 + " " + keyElement3 + " too!");
    return response;
}

@POST
@CacheInvalidateAll(cacheName = "expensiveResourceCache")
public void invalidateAll() {

}

Redisのバックエンドの設定

Redisバックエンドは、 <default> Redisクライアントを使用します。Redisへのアクセスを設定するには、 Redisリファレンス を参照してください。

開発モードでは、 Redis Dev Service を使用することができます。

キャッシュに別のRedisを使用する場合は、 client-name を以下のように設定してください:

quarkus.cache.redis.client-name=my-redis-for-cache

Redisに書き込んだり、Redisから読み込んだりするとき、Quarkusは型を知っておく必要があります。実際、オブジェクトをシリアライズしたりデシリアライズしたりする必要があります。そのため、キャッシュしたいキーと値の型（クラス名）を設定する必要がある場合があります。ビルド時に、Quarkusはアプリケーションコードから型を推測しようとしますが、この決定は、以下の方法でオーバーライドできます:

# Default configuration
quarkus.cache.redis.key-type=java.lang.String
quarkus.cache.redis.value-type=org.acme.Person

# Configuration for `expensiveResourceCache`
quarkus.cache.redis.expensiveResourceCache.key-type=java.lang.String
quarkus.cache.redis.expensiveResourceCache.value-type=org.acme.Supes

また、キャッシュされたエントリーの生存時間(TTL) を設定することも可能です:

# Default configuration
quarkus.cache.redis.expire-after-write=10s

# Configuration for `expensiveResourceCache`
quarkus.cache.redis.expensiveResourceCache.expire-after-write=1h

expire-after-write が構成されていない場合、エントリは退避されません。 @CacheInvalidateAll または @CacheInvalidate アノテーションを使用して値を無効にする必要があります。

次の表は、サポートされるプロパティの一覧です:

ビルド時に固定される構成プロパティ - 他のすべての構成プロパティは実行時にオーバーライド可能

Configuration property

タイプ

デフォルト

quarkus.cache.redis.client-name

The name of the named Redis client to be used for communicating with Redis. If not set, use the default Redis client.

Environment variable: QUARKUS_CACHE_REDIS_CLIENT_NAME

Show more

string

quarkus.cache.redis.value-type

The default type of the value stored in the cache.

Environment variable: QUARKUS_CACHE_REDIS_VALUE_TYPE

Show more

string

quarkus.cache.redis.key-type

The key type, String by default.

Environment variable: QUARKUS_CACHE_REDIS_KEY_TYPE

Show more

string

quarkus.cache.redis.expire-after-write

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.

Environment variable: QUARKUS_CACHE_REDIS_EXPIRE_AFTER_WRITE

Show more

Duration 

quarkus.cache.redis.expire-after-access

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.

Environment variable: QUARKUS_CACHE_REDIS_EXPIRE_AFTER_ACCESS

Show more

Duration 

quarkus.cache.redis.prefix

The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:{cache-name`}" will be used. The variable "`{cache-name`}" is resolved from the value set in the cache annotations.

Environment variable: QUARKUS_CACHE_REDIS_PREFIX

Show more

string

quarkus.cache.redis.use-optimistic-locking

Whether the access to the cache should be using optimistic locking. See Redis Optimistic Locking for details. Default is false.

Environment variable: QUARKUS_CACHE_REDIS_USE_OPTIMISTIC_LOCKING

Show more

ブーリアン

quarkus.cache.redis.invalidation-scan-size

If set, the SCAN command (used to implement invalidation) will have the COUNT argument with given value. If not set (default), no COUNT argument is present.

Environment variable: QUARKUS_CACHE_REDIS_INVALIDATION_SCAN_SIZE

Show more

int

Additional configuration applied to a specific Redis cache (highest precedence)

タイプ

デフォルト

quarkus.cache.redis."cache-name".value-type

The default type of the value stored in the cache.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE

Show more

string

quarkus.cache.redis."cache-name".key-type

The key type, String by default.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE

Show more

string

quarkus.cache.redis."cache-name".expire-after-write

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE

Show more

Duration 

quarkus.cache.redis."cache-name".expire-after-access

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS

Show more

Duration 

quarkus.cache.redis."cache-name".prefix

The key prefix allowing to identify the keys belonging to the cache. If not set, the value "`cache:{cache-name`}" will be used. The variable "`{cache-name`}" is resolved from the value set in the cache annotations.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX

Show more

string

quarkus.cache.redis."cache-name".use-optimistic-locking

Whether the access to the cache should be using optimistic locking. See Redis Optimistic Locking for details. Default is false.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING

Show more

ブーリアン

quarkus.cache.redis."cache-name".invalidation-scan-size

If set, the SCAN command (used to implement invalidation) will have the COUNT argument with given value. If not set (default), no COUNT argument is present.

Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__INVALIDATION_SCAN_SIZE

Show more

int
期間フォーマットについて

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

数字で始まる簡略化した書式を使うこともできます:

  • 数値のみの場合は、秒単位の時間を表します。

  • 数値の後に ms が続く場合は、ミリ秒単位の時間を表します。

その他の場合は、簡略化されたフォーマットが解析のために java.time.Duration フォーマットに変換されます：

  • 数値の後に h 、 m 、 s が続く場合は、その前に PT が付けられます。

  • 数値の後に d が続く場合は、その前に P が付けられます。

Redisキーの設定

By default, the Redis backend stores the entry using the following keys pattern: cache:{cache-name}:{cache-key}, where cache-key is the key the application uses and cache:{cache-name} the prefix. The variable {cache-name} is resolved from the value set in the cache annotations. So, you can find all the entries for a single cache using the Redis KEYS command: KEYS cache:{cache-name}:*

The prefix can be configured by using the prefix property:

# Default configuration
quarkus.cache.redis.prefix=my-cache

# Configuration for `expensiveResourceCache`
quarkus.cache.redis.expensiveResourceCache.prefix=my-expensive-cache

このような場合、デフォルトキャッシュで管理されているすべての鍵は KEYS my-cache:* で、 expensiveResourceCache キャッシュで管理されているすべての鍵は KEYS my-expensive-cache:* で検索できます。

# Default configuration
# The variable "{cache-name}" is resolved from the value set in the cache annotations.
quarkus.cache.redis.prefix=my-cache-{cache-name}

In this latest example, you can find all the keys managed by the default cache using KEYS my-cache-{cache-name}:*.

楽観的ロックの有効化

キャッシュへのアクセスは、 直接アクセス することも、 楽観的ロック を使用することも可能です。デフォルトでは、楽観的なロックは無効です。

以下を使用して、楽観的なロックを有効にすることができます:

# Default configuration
quarkus.cache.redis.use-optimistic-locking=true

# Configuration for `expensiveResourceCache`
quarkus.cache.redis.expensiveResourceCache.use-optimistic-locking=true

使用すると、キーが ウォッチ され、トランザクション（ MULTI/EXEC ）で SET コマンドが実行されます。

関連コンテンツ

On the same extensions

On the same topics

Quarkusはオープンです。このプロジェクトのすべての依存関係は、Apache Software License 2.0 または互換性のあるライセンスのもとで利用可能です。

このウェブサイトはJekyll で構築され、GitHub Pages にホストされ、完全にオープンソースです。改善したい場合は、ウェブサイトをフォークし、修正してみせてください。

ナビゲーション
フォローする
ヘルプ
言語
Quarkusはコミュニティプロジェクトで構成されています
CC by 3.0 | Privacy Policy Sponsored by