2015年3月12日木曜日

Eclipse + STS で Spring Data Redisをやってみた

概要
環境
コード実装
動作確認
最後に
Tips

概要

前回からの続きです
この状態からRedisと接続できるようにしてWebアプリとして動作できるようにします

環境

Mac OS X 10.10.2
Eclipse Luna 4.4.1
Spring Tool Suite 3.6.4
Java 1.8.0_31
Tomcat 8.0.20
Redis 2.8.19
Jedis 2.6.2
common-pool2 2.3

コード実装

既存のコードを修正して動作させるようにします

pom.xml修正

プロジェクトのディレクトリ直下にあります
/path/to/project/pom.xml

<dependencies>タグ内に以下を追記します

<dependency>
  <groupId>org.springframework.data</groupId>
  <artifactId>spring-data-redis</artifactId>
  <version>1.4.2.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-pool2</artifactId>
  <version>2.3</version>
</dependency>
<dependency>
  <groupId>redis.clients</groupId>
  <artifactId>jedis</artifactId>
  <version>2.6.2</version>
</dependency>

pom.xmlが長いので追記する部分だけ記載します
というコメントがあるのでその付近を参考に記載すればOKです
公式のクイックスタートとかみるとこの辺の情報が不足していてcommon-pool2が必要とかjedisが必要とか記載されていないので困りました
これらの記述がないとNoClassDefFoundErrorになってしまいます

servlet-context.xml修正

結構深い階層にあります
/path/to/project/src/main/webapp/WEB-INF/spring/appServlet/servlet-context.xml

2箇所追記します

1つ目は先頭箇所でxmlnsを追加します

xmlns:p="http://www.springframework.org/schema/p"

2つ目はbeansの定義を追加します

<beans:bean id="jedisConnFactory"
    class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"
    p:use-pool="true" />

<beans:bean id="stringRedisTemplate"
    class="org.springframework.data.redis.core.StringRedisTemplate"
    p:connection-factory-ref="jedisConnFactory" />

他にもbeansの定義が記載されていると思うのでその階層の並びに記載すればOKです
全文は長いので省略しますが特に迷うことなく追記できると思います

RedisController.javaの作成　

新規でコントローラとなるクラスを追加します
/path/to/project/src/main/java/com/sample/sample/RedisController.java

ソースの全貌は以下の通り

package com.sample.sample;

import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class RedisController {

    private static final Logger logger = LoggerFactory.getLogger(RedisController.class);

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @RequestMapping(value = "/redis/get", method = RequestMethod.GET)
    public void get(@RequestParam(value = "key", required = true) String key, HttpServletResponse response) {
        logger.debug("/redis/get");
        String value = stringRedisTemplate.opsForValue().get(key);
        response.setStatus(200);
        response.setHeader("result", value);
    }

    @RequestMapping(value = "/redis/set", method = RequestMethod.GET)
    public void set(@RequestParam(value = "key", required = true) String key, @RequestParam(value = "value", required = true) String value, HttpServletResponse response) {
        logger.debug("/redis/set");
        stringRedisTemplate.opsForValue().set(key, value);
        response.setStatus(200);
    }

    @RequestMapping(value = "/redis/del", method = RequestMethod.GET)
    public void del(@RequestParam(value = "key", required = true) String key, HttpServletResponse response) {
        logger.debug("/redis/del");
        stringRedisTemplate.delete(key);
        response.setStatus(200);
    }

}

動作確認

curl + redis-cli で動作を確認します
まず起動します
プロジェクトを右クリックしてRun on Serverで起動します
起動後ターミナルで以下のコマンドを実行して動作確認します

curl 'http://localhost:8080/sample/redis/set?key=key-test&value=value-test'

127.0.0.1:6379> get key-test
"value-test"

curl -v 'http://localhost:8080/sample/redis/get?key=key-test'

ヘッダにRedisから取得したvalue情報があることを確認する

< result: value-test

curl 'http://localhost:8080/sample/redis/del?key=key-test'

127.0.0.1:6379> get key-test
(nil)

最後に

いかがでしたでしょうか

自分のググり不足＋英語力不足なのですが、SpringDataRedisに関する情報はあまりWebにないような気がします
もしくは情報が古くて最新版だと動かないというケースが多いような気がします

とりあえずWebAPI + RedisをSpringFrameworkで実現することができました
JavaからRedisを使うだけならJedisを直接使うのでも全然簡単なのでいいのですが、Spring越しに使うことでSpringが用意したテンプレートやコネクションプーリングの機能を実装する必要がないので面倒な部分を省略できます
そもそもここまで来ることが非常に面倒でありますが

あとは、エラーハンドリングやらレスポンスボディやらは全く考慮できていないので、その辺は実装が必要です

Tips

/sample ではなく /でアクセスしたい場合
http://stackoverflow.com/questions/2437465/java-how-to-change-context-root-of-a-dynamic-web-project-in-eclipse

kakakikikekeのブログ