Redisストア(Lettuce)アダプタ¶

最小構成で動かす¶

ここでは、 localhost の 6379 ポートで起動している単一のRedisインスタンスに対して接続する場合を例に、設定方法を説明する。

> docker run --name redis -d -p 6379:6379 redis:5.0.9

> docker stop redis

<!-- 省略 -->
<config-file file="nablarch/webui/redisstore-lettuce.config" />
<config-file file="common.properties" />
<config-file file="env.properties" />

<!-- 省略 -->
<import file="nablarch/webui/redisstore-lettuce.xml" />

<!-- 初期化が必要なコンポーネント -->
<component name="initializer"
           class="nablarch.core.repository.initialization.BasicApplicationInitializer">
  <property name="initializeList">
    <list>
      <!-- 省略 -->
      <component-ref name="lettuceRedisClientProvider"/>
    </list>
  </property>
</component>

<!-- 廃棄が必要なコンポーネント -->
<component name="disposer"
           class="nablarch.core.repository.disposal.BasicApplicationDisposer">
  <property name="disposableList">
    <list>
      <!-- 省略 -->
      <component-ref name="lettuceRedisClientProvider"/>
    </list>
  </property>
</component>

# デフォルトのセッションストア名
nablarch.sessionManager.defaultStoreName=redis

Redis の構成に合わせて設定する¶

最小構成で動かす では、ローカルで起動する単一のRedisインスタンスに接続する例を示した。

しかし、実際に本番などでRedisを使用する場合は次のような構成のRedisに接続できる必要がある。

• Sentinelを使用したMaster-Replica構成
• Cluster構成

ここでは、接続先のRedisの構成に合わせて、どのように設定を変更すればいいのかについて説明する。

nablarch.lettuce.clientType=cluster

package com.nablarch.example.redisstore;

import io.lettuce.core.RedisURI;
import io.lettuce.core.cluster.ClusterClientOptions;
import io.lettuce.core.cluster.ClusterTopologyRefreshOptions;
import io.lettuce.core.cluster.RedisClusterClient;
import nablarch.integration.redisstore.lettuce.LettuceClusterRedisClient;

import java.time.Duration;
import java.util.List;
import java.util.stream.Collectors;

public class CustomClusterRedisClient extends LettuceClusterRedisClient {

    @Override
    protected RedisClusterClient createClient() {
        List<RedisURI> redisUriList = uriList.stream().map(RedisURI::create).collect(Collectors.toList());
        RedisClusterClient client = RedisClusterClient.create(redisUriList);

        ClusterTopologyRefreshOptions clusterTopologyRefreshOptions = ClusterTopologyRefreshOptions.builder()
                .enableAllAdaptiveRefreshTriggers()
                .enablePeriodicRefresh(Duration.ofSeconds(10))
                .build();

        ClusterClientOptions clusterClientOptions = ClusterClientOptions.builder()
                .topologyRefreshOptions(clusterTopologyRefreshOptions)
                .build();

        client.setOptions(clusterClientOptions);

        return client;
    }
}

<import file="nablarch/webui/redisstore-lettuce.xml" />

<component name="lettuceClusterRedisClient" class="com.nablarch.example.redisstore.CustomClusterRedisClient">
  <property name="uriList" ref="redisClusterUriListFactory" />
</component>

使用するクライアントクラスの決定の仕組み¶

使用するクライアントクラスを設定する で、使用するクライアントクラスは環境設定値 nablarch.lettuce.clientType で設定できることを説明した。 ここでは、具体的にどのようにしてクライアントクラスが決定されているのか、仕組みを説明する。

３つのクライアントクラスのコンポーネントのうち、実際にどのコンポーネントを使用するかは LettuceRedisClientProvider によって決定される。

LettuceRedisClientProvider は、 redisstore-lettuce.xml で次のように定義されている。

<component name="lettuceRedisClientProvider" class="nablarch.integration.redisstore.lettuce.LettuceRedisClientProvider">
    <property name="clientType" value="${nablarch.lettuce.clientType}" />
    <property name="clientList">
        <list>
            <component-ref name="lettuceSimpleRedisClient" />
            <component-ref name="lettuceMasterReplicaRedisClient" />
            <component-ref name="lettuceClusterRedisClient" />
        </list>
    </property>
</component>

このクラスは、 clientList と clientType という２つのプロパティを持っている。

clientList には、候補となるクライアントクラスのコンポーネントがリストで設定されている。 そして clientType には、使用するクライアントクラスの識別子を設定する。

各クライアントクラスは getType() という自身の識別子を返すメソッドを持っている。 LettuceRedisClientProvider は clientType プロパティに設定された値と clientList プロパティに設定された各コンポーネントが返す getType() の値を比較する。 そして、値が一致したものを、実際に使用するコンポーネントとして決定している。

LettuceRedisClientProvider は ComponentFactory を実装しており、 createObject() メソッドは、決定されたクライアントクラス（LettuceRedisClient）のコンポーネントを返すように実装されている。

クライアントクラスの初期化¶

本アダプタが提供している３つのクライアントクラスは、いずれもRedisへの接続を確立するために初期化が必要となっている。

各クライアントクラスは Initializable を実装しており、 initialize() メソッドを実行することでRedisへの接続が確立される。 したがって、使用するクライアントクラスのコンポーネントは、 BasicApplicationInitializer の initializeList プロパティに設定しなければならない。

実際の initializeList への設定は、以下のように 使用するクライアントクラスの決定の仕組み で説明した LettuceRedisClientProvider のコンポーネントを使用する。

<!-- 初期化が必要なコンポーネント -->
<component name="initializer"
           class="nablarch.core.repository.initialization.BasicApplicationInitializer">
  <property name="initializeList">
    <list>
      <!-- 省略 -->
      <component-ref name="lettuceRedisClientProvider"/>
    </list>
  </property>
</component>

こうすることで、コンポーネント定義の記述を変更することなく、決定されたクライアントクラスのコンポーネントを初期化できる。

クライアントクラスの廃棄処理¶

各クライアントクラスは Disposable を実装しており、 dispose() メソッドを実行することでRedisへの接続が閉じられる。 したがって、使用するクライアントクラスのコンポーネントを BasicApplicationDisposer の disposableList プロパティに設定することで、アプリケーション終了時にRedisとの接続を閉じることができる。

<!-- 廃棄が必要なコンポーネント -->
<component name="disposer"
           class="nablarch.core.repository.disposal.BasicApplicationDisposer">
  <property name="disposableList">
    <list>
      <!-- 省略 -->
      <component-ref name="lettuceRedisClientProvider"/>
    </list>
  </property>
</component>

BasicApplicationInitializer の initializeList と同様で、 disposableList プロパティに LettuceRedisClientProvider コンポーネントを指定することで、実際に使用されるクライアントクラスの廃棄処理が実行されるようになる。

セッション情報の保存方法¶

Redisに保存されたセッション情報は、 nablarch.session.<セッションID> というキーで保存されている。

以下は、 redis-cli で保存されているキーを表示した様子を記載している。

127.0.0.1:6379> keys *
1) "nablarch.session.8b00bce5-d19f-4f63-b1fe-d14ecca9a4f6"

また、セッション情報（SessionEntry のリスト）は、デフォルトでは JavaSerializeStateEncoder でエンコードされたバイナリ形式で保存されている。

使用するエンコーダーは、 serializeEncoder という名前で別のエンコーダーのコンポーネントを定義することで変更できる。

有効期限の管理方法¶

Redisには、保存したキーに対して有効期限を設定する仕組みが用意されている。 有効期限が切れたキーは自動的に削除される。

本アダプタは、セッションの有効期限の管理にこのRedisの有効期限の仕組みを使用している。 したがって、有効期限が切れたセッション情報は自動的に削除されるため、ゴミとして残ったセッション情報を削除するためのバッチを用意する必要はない。

以下は、セッション情報の有効期限を pttl コマンド（外部サイト、英語） で確認している様子を記載している。

127.0.0.1:6379> pttl "nablarch.session.8b00bce5-d19f-4f63-b1fe-d14ecca9a4f6"
(integer) 879774