【第20回】NoSQL(10)-Spring SessionとSpring Data Redisを用いたアプリケーション(1)¶

Spring Data SessionとSpring Data Redisの概要¶

Spring Session はSpringのトップレベルプロジェクトの１つで、ユーザのセッション情報に関するAPIとその実装を提供します。 以下のセッション情報を透過的に(従来のセッション情報と変わらないやり方で)扱うことが可能です。

• HttpSession：従来アプリケーションサーバで保持していたセッション情報を共有キャッシュへ置き換える実装を提供します。
• WebSockets：従来のスティッキーセッションセッションが必要なくなり、WebSocketsメッセージを取り扱うことが可能になります。
• WebSession：Spring5からサポートされたノンブロッキングなWebSessionを取り扱うことが可能になります。

また、 Spring Data Redis は Spring Data JPAやこれまで紹介してきたSpring Data Cassandara、DynamoDBと同じく、 Spring Dataのメインモジュールで、統一的なインターフェースでデータアクセスが行えます。Spring Data Redisの特徴としては、以下の通りです。

• Jedisとlettuceなど、複数のRedisドライバを通した抽象的なアクセス手段の提供
• CrudRepositoryの継承インターフェースによる基本的なデータアクセスコード実装量の軽減
• @EnableRedisRepsitoriesアノテーションを使ったRepositoryインターフェースの拡張実装の提供
• Redis driverがスローする例外の、共通的なDataAccessExceptionなどへの透過的な変換
• Spring Frameworkとの統合、依存性の注入によるRedisTemplateクラスの提供。
• Pub/Subモデルのサポート

今回はこれらのフレームワークを用いて、セッション情報をRedisで共有するアプリケーションを実装してみましょう。 前回構築したローカル環境のRedisへのアクセス及び、次回以降構築するAWS ECSコンテナでアプリケーションをデプロイし、ElastiCacheへアクセスができるようにアプリケーションを実装していきます。

なお、実際に作成したアプリケーションは GitHub 上にコミットしています。 以降記載されているソースコードで、インポート文など本質的でない記述を省略している部分がありますので、実行コードを作成する場合は、 必要に応じて適宜GitHubソースコードも参照してください。

Spring SessionとSpring Data Redisを使ったアプリケーション実装(1)¶

Spring SessionとSpring Data Redisを使用するには、Mavenプロジェクトのpom.xmlで、spring-session-data-redisのライブラリを定義します。 加えて、lettuceのDriverを定義してください。なお、共有セッションへのアクセスを画面から確認するアプリケーションを作成するために、 spring-boot-starter-web、thymeleafテンプレートエンジンを使用するためのspring-boot-starter-thymeleafを追加しておきましょう。

 <dependencies>
   <dependency>
     <groupId>org.springframework.session</groupId>
     <artifactId>spring-session-data-redis</artifactId>
   </dependency>
   <dependency>
     <groupId>io.lettuce</groupId>
     <artifactId>lettuce-core</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-thymeleaf</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
</dependencies>

今回、アプリケーションは以下のコンポーネントで構成しますが、Spring Session とSpring Data Redisで最低限作成しなければならない必須のクラスは以下の通りです。 なお、thymeleafテンプレートエンジンに関する説明は省略しますが、必要に応じて、Thymeleaf公式ドキュメント や Macchinetta Framework テンプレートエンジン を参照してください。 ここでは、index.htmlからセッション情報を更新し、結果に遷移する画面HTMLを各々実装しています。

それでは、実装していくクラスを説明します。まず、最初にSpringBoot起動クラス及び、各種設定クラスです。@SpringBootApplicaitonアノテーションが付与された起動クラスは、同一パッケージにある@Configurationアノテーションが付与された設定クラス及び、 設定クラス内で@ComponentScanされたパッケージにあるクラスを読み取ります。今回は目的に応じて以下の4つに分類して定義します。

• アプリケーションを起動するためのWebAppクラス
• SpringMVCの設定クラスであるWebMvcConfigurerを実装した設定クラス：MvcConfigクラス
• Redisへアクセスを行う設定クラス：RedisConfigクラス
• ElasticCache接続に必要な設定を行う設定クラス：ElastiCacheConfigクラス

以下にアプリケーション起動クラスを示します。@SpringBootApplicaitonアノテーションを設定し、SpringAppcalition.run()を実行するmain()メソッドを実装します。 設定クラスは必ずしも複数である必要はなく一つにまとめても動作上問題ありませんが、クラス名と役割を対応づけて作成していた方が、後々設定内容を混乱することなく、クラス名から識別できてベターです。

package org.debugroom.mynavi.sample.aws.elasticache.config;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class WebApp {

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

}

同一パッケージに配置するMvcConfigクラスでは、HTMLやCSSなどの静的リソースのURLと実際のリソースの物理配置の対応づけの定義をResourceHandlerRegistryに追加しておきます。 また、Controllerクラスを読み取るために、ComponentScanアノテーションにパッケージを指定しておきます。

package org.debugroom.mynavi.sample.aws.elasticache.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@ComponentScan("org.debugroom.mynavi.sample.aws.elasticache.app.web")
public class MvcConfig implements WebMvcConfigurer {

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

}

続いて、Redisのアクセス設定をRedisConfigクラス及びapplication.ymlで行います。基本的には、Spring SessionでRedisを使用する場合、Mavenのpom.xmlでライブラリを追加した後、 設定クラスに@EnableRedisHttpSessionアノテーションを付与するか、application.ymlでspring.session.store-typeプロパティをredisに設定にすることで、 同等の効果を得ることができます。

spring:
  session:
    store-type: redis

application.ymlの設定があれば、Configクラスの設定は必ずしも必要ではありませんが、デフォルトではセッション情報保存時にJavaオブジェクトをシリアライズして保存するため、 Redisクライアントから中身を確認するためにJSON形式で保存するようにデフォルトのシリアライザを変更します。

package org.debugroom.mynavi.sample.aws.elasticache.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;

@Configuration
public class RedisConfig {

    @Bean
    public RedisSerializer<Object> springSessionDefaultRedisSerializer() {
        return new GenericJackson2JsonRedisSerializer();
    }

}

また、ローカル環境のRedisでは問題ありませんが、ElastiCacheではconfigコマンドの実行が禁止されているため、ConfigureRedisActionをNO_OPに設定しておく必要があります。 ElastiCache接続時に有効化すれば良いため、実行時にプロファイル「production」を指定するものとして、以下のようなConfigクラスを追加しておきましょう。

package org.debugroom.mynavi.sample.aws.elasticache.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.session.data.redis.config.ConfigureRedisAction;

@Profile("production")
@Configuration
public class ElastiCacheConfig {

    @Bean
    public ConfigureRedisAction configureRedisAction() {
        return ConfigureRedisAction.NO_OP;
    }

}

加えて、Redisに接続するためのIPアドレス及びポートをspring.redis.host及びspring.redis.portプロパティに指定しておく必要があります。

applicaiton.yml

spring:
  redis:
    host: localhost
    port: 6379

また、ElastiCacheに接続するAWS環境では、ECSタスクに設定する環境変数からElastiCacheのエンドポイントを取得するよう、application-production.ymlを作成しておきます。

applicaiton-production.yml

spring:
  redis:
    host: ${REDIS_CLUSTER_ENDPOINT:localhost}
    port: ${REDIS_CLUSTER_PORT:6379}

アプリケーションの設定に関する実装はここまでです。次回以降、引き続きセッション共有処理に関わる実装を進めていきます。

著者紹介¶

川畑 光平(KAWABATA Kohei)

某システムインテグレータにて、金融機関システム業務アプリケーション開発・システム基盤担当を経て、現在はソフトウェア開発自動化関連の研究開発・推進に従事。

Red Hat Certified Engineer、Pivotal Certified Spring Professional、AWS Certified Solutions Architect Professional等の資格を持ち、アプリケーション基盤・クラウドなど様々な開発プロジェクト支援にも携わる。

2019 APN AWS Top Engineers & Ambassadors 選出。

本連載記事の内容に対するご意見・ご質問は Facebook まで。