SpringData ve Redis

Bir önceki yazıda Redis’in ne olduğuna, kısaca geliştirme ortamınız için nasıl Redis kurulumu yapabileceğinize değinmiştik. Bu yazıda ise bir seviye daha ileriye gidip spring-data kullanarak, Redis ile nasıl haberleşebileceğimize bakalım.

Projemiz basit bir “Hello, World” tipi bir uygulama olucak. Yani kısaca String tipindeki key-value ikililerinin nasıl Redis üzerinde tutulacağına bakacağız. Basitçe Redis’in nasıl kullanıldığını anladıktan sonra, cache’lemek için Redis’i nasıl kullanacağımıza değineceğiz. Projeyi geliştirirken spring-boot ve spring-Data kütüphanelerini kullanacağız. Ben geliştirme ortamı olarak Intellij 14 kullanıyorum. Temel sebebi spring-boot projelerini çok rahatlıkla oluşturabilmenizdir. Fakat isterseniz https://start.spring.io adresinden de aynı şekilde bir porje oluşturabilir ve bunu favori geliştirme ortamınıza ekleyebilirsiniz. Build aracı olarak her zamanki gibi maven kullanacağım. Spring boot bizim için herşeyi hallettiğinden, pom.xml ile ya da başka herhangibir xml dosyası ile uğraşmayacağız. Ondan gradle kullanmamanız için de bir sebep yok.

Projenin Yaratılması

Projemizin ne olduğuna kısaca değindiğimize göre şimdi projemizi nasıl yaratılacağına değinebiliriz. Dediğim gibi ben intellij kullanarak anlatacağım ama start.spring.io üzerinden de aynı işlemleri gerçekleyebilirsiniz.

Öncelikle yeni bir proje yaratıyoruz. Proje tipi olarak Spring Initializr seçiyoruz.

Daha sonra gelen ekranda hangi kütüphaneleri kullanacağımızı seçiyoruz. Biz sadece spring-data ve Redis kullanacağımız için, sadece Redis’i seçiyoruz.

Daha sonra gelen ekranda proje bilgilerini dolduruyoruz. Ben aşağıdaki şekilde doldurdum.

Böylelikle projemizi yaratmış oluyoruz.

“Hello, World”

Şimdi hızlıca “Hello, World” uygulamasını nasıl yapacağımıza bakalım. SpringBoot sağolsun bizim için herşeyi ayarladığından bizim yapacağımız çok fazla bir şey kalmıyor. Şimdi SpringRedisApplication.java sınıfını aşağıdaki gibi güncelleyelim.

SpringRedisApplication.java

package com.bahadirakin.redis;

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.CacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.core.StringRedisTemplate;

@SpringBootApplication
public class SpringRedisApplication implements CommandLineRunner {

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

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

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

    @Override
    public void run(String... strings) throws Exception {

        // Messaging Demonstration
        logger.info("Sending message.....");
        stringRedisTemplate.opsForValue().set("message", "Hello, World");
        final String message = stringRedisTemplate.opsForValue().get("message");
        logger.info("Message From Redis Server {}", message);
    }
}

package com.bahadirakin.redis;

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.CacheManager;

import org.springframework.context.annotation.Bean;

import org.springframework.data.redis.cache.RedisCacheManager;

import org.springframework.data.redis.core.StringRedisTemplate;

@SpringBootApplication

public class SpringRedisApplication implements CommandLineRunner {

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

@Autowired

private StringRedisTemplate stringRedisTemplate;

public static void main(String[] args) {

SpringApplication.run(SpringRedisApplication.class, args);

}

@Override

public void run(String... strings) throws Exception {

// Messaging Demonstration

logger.info("Sending message.....");

stringRedisTemplate.opsForValue().set("message", "Hello, World");

final String message = stringRedisTemplate.opsForValue().get("message");

logger.info("Message From Redis Server {}", message);

}

Uygulamamızı bir önceki yazımızda hazırladığımız Vagrant dosyasını kullanarak çalıştıracağız. Vagrant ile yeni bir sanal makine oluşturmuş oluyoruz. Ve kendi makinemizle bu sanal makine bir ağda çalışıyor oluyorlar. Biz Vagrant’ın oluşturduğu sanal makineye Vagrantfile içerisinde verdiğimiz adresten yani 192.168.33.10’ten ulaşıyoruz. Aynı şekilde yeni yazdığımız uygulamamıza da Redis sunucusuna hangi adresten ulaşabileceğini söylememiz gerekiyor. Bunun için application.properties dosyasına aşağıdaki satırları eklememiz yeterli olacaktır.

application.properties

spring.redis.host=192.168.33.10
spring.redis.port=6379

1 2	spring.redis.host=192.168.33.10 spring.redis.port=6379

Şimdi SpringRedisApplication uygulamamızı çalıştıralım ve mesajımızın düzgün şekilde iletilip alındığını görmüş olalım. Peki sadece String tipinde mi mesajlar gönderebiliyoruz? Tabiki de hayır. RedisSerializer tipinde bir interface bulunuyor. Bunu implement ederek istediğiniz her türde veriyi gönderip almanız mümkün. Ama unutmayın uygulamanızı ayarlarken key için hangi RedisSerializer’ı, ilgili değer için hangi RedisSerializer’ı kullanacağınızı belirtmeniz gerekiyor.

Redis Cache

Temel kısmı hızlıca halletiğimize göre asıl eğlenceli kısma gelebiliriz. Spring-Cache’i daha önce kullandıysanız ne kadar güzel bir kütüphane olduğu konusunda az buçuk fikriniz vardır. Daha önce kullanmamış olanlar için kısaca ne olduğundan bahsedeyim.

Spring Cache

Spring Cache annotasyonlar üzerinden bilgileri cache’lemenize olanak sağlayan bir mekanizma. Spring’in bir parçası. Tek kısıtı, annotasyonlarınızı kullandığınız Bean’lerin Spring tarafından yönetilmesi gerekiyor. En güzel yanı ise alt tarafta istediğiniz cache kütüphanesini(Ehcache, Memcache, Guava, Redis vs.) kullanabilirsiniz. İleride bununla ilgili daha detaylı bir yazı yazmayı düşünüyorum zaten.

Her ne kadar biz örneğimizde tek tip annotasyonunu kullanacak olsakta, kısaca tüm annotasyonlarının üzerinden geçeyim.

Annotasyon	İşlevi
@Cacheable	İlgili metodun sonucu ayarlanan cache kütüphanesine kaydedilir. Eğer yeni bir talep gelirse ve aynı ‘key’ değeri kullanıldıysa yeni sonuç doğruca cacheten okunur. Default olarak metodun parametreleri ‘key’ olarak kullanılmaya çalışılır. Tabi burada parametrelerin alt taraftaki cache kütüphanesi tarafından desteklenen veri tiplerinden olması gerekiyor.
@CachePut	@Cacheable’da olduğu gibi metod sonucunu ilgili cache kütüphanesine kaydeder. Fakat bir sonraki çağırımda yine method çalışır.
@CacheEvict	Bir verinin cache’lenmesinde en önemli konu, cache’teki verinin güncelliğinin korunmasıdır. Bu annotasyon cache’inizin gerektiğinde güncellenmesine olanak sağlar. İlgili metod çağırıldığında ‘key’ değerindeki veri cache’ten silinir.
@EnableCaching	Bu daha çok ayarlarla ilgili. Ayarlarınızı java sınıfı üzerinden yapıyorsanız, ilgili ayar sınıfınızın tepesine bu annotasyonu koyduğunuzda cache’iniz aktif hale gelir. Fakat sadece aktif etmeniz yetmez bit CacheManager tipinde Bean yaratmanız ve hangi Cache kütüphanesinin yaratılacağını belirtmeniz gerekir.

Cache’lenek Servis Katmanı

Şimdi, çok zaman tüketen, bir hayli işlem yapan bir servis katmanı yazalım. Daha sonra annotasyonlarımızı ekleyeylim. Öncelikle src/main/java altında, com.bahadirakin.redis paketine SomeLongBusiness.java isminde bir interface yaratalım. Tahmin edebileceğiniz gibi bu interface bizim zaman alan servis katmanımızı oluşturacak.

SomeLongBusiness.java

package com.bahadirakin.redis;

public interface SomeLongBusiness {

    String doSomeHeavyWork(String input);
}

package com.bahadirakin.redis;

public interface SomeLongBusiness {

String doSomeHeavyWork(String input);

}

Şimdi de bu sınıfımızın implementasyonunu aynı paket içerisine yaratalım.

SomeLongBuinessImpl.java

package com.bahadirakin.redis;

import org.springframework.cache.annotation.Cacheable;

public class SomeLongBusinessImpl implements SomeLongBusiness {

    @Cacheable(value = "resultCache")
    @Override
    public String doSomeHeavyWork(String input) {
        try {
            Thread.sleep(5000);
            return "Result: " + input;
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }

    }
}

package com.bahadirakin.redis;

import org.springframework.cache.annotation.Cacheable;

public class SomeLongBusinessImpl implements SomeLongBusiness {

@Cacheable(value = "resultCache")

@Override

public String doSomeHeavyWork(String input) {

try {

Thread.sleep(5000);

return "Result: " + input;

} catch (InterruptedException e) {

throw new RuntimeException(e);

}

Gördüğünüz gibi işlemimiz bir hayli zaman alacak şekilde tasarlanmış. Yaklaşık 5sn sürecek bu işlem. Anlaşılmayan bir konu olduğunu düşünmüyorum. Şimdi bunu çağıracak sınıfımıza bakalım. SpringRedisApplication.java dosyasını aşağıdaki gibi düzenleyelim.

package com.bahadirakin.redis;

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.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.core.StringRedisTemplate;

@EnableCaching
@SpringBootApplication
public class SpringRedisApplication implements CommandLineRunner {

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

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Autowired
    private SomeLongBusiness someLongBusiness;

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

    @Bean
    CacheManager cacheManager(StringRedisTemplate stringRedisTemplate) {
        return new RedisCacheManager(stringRedisTemplate);
    }

    @Bean
    SomeLongBusiness someLongBusiness() {
        return new SomeLongBusinessImpl();
    }


    @Override
    public void run(String... strings) throws Exception {

        // Messaging Demonstration
        logger.info("Sending message.....");
        stringRedisTemplate.opsForValue().set("message", "Hello, World");
        final String message = stringRedisTemplate.opsForValue().get("message");
        logger.info("Message From Redis Server {}", message);

        // Caching Demonstration
        logger.info("Heavy work is starting for the first time");
        final String firstResult = someLongBusiness.doSomeHeavyWork(message);
        logger.info("First (Takes 5 sec): {}", firstResult);
        final String secondResult = someLongBusiness.doSomeHeavyWork(message);
        logger.info("Second: {}", secondResult);
        final String thirdResult = someLongBusiness.doSomeHeavyWork("Different Message");
        logger.info("Third (Takes 5 sec): {}", thirdResult);
        final String forthResult = someLongBusiness.doSomeHeavyWork("Different Message");
        logger.info("Forth: {}", forthResult);
    }
}

package com.bahadirakin.redis;

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.CacheManager;

import org.springframework.cache.annotation.EnableCaching;

import org.springframework.context.annotation.Bean;

import org.springframework.data.redis.cache.RedisCacheManager;

import org.springframework.data.redis.core.StringRedisTemplate;

@EnableCaching

@SpringBootApplication

public class SpringRedisApplication implements CommandLineRunner {

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

@Autowired

private StringRedisTemplate stringRedisTemplate;

@Autowired

private SomeLongBusiness someLongBusiness;

public static void main(String[] args) {

SpringApplication.run(SpringRedisApplication.class, args);

}

@Bean

CacheManager cacheManager(StringRedisTemplate stringRedisTemplate) {

return new RedisCacheManager(stringRedisTemplate);

}

@Bean

SomeLongBusiness someLongBusiness() {

return new SomeLongBusinessImpl();

}

@Override

public void run(String... strings) throws Exception {

// Messaging Demonstration

logger.info("Sending message.....");

stringRedisTemplate.opsForValue().set("message", "Hello, World");

final String message = stringRedisTemplate.opsForValue().get("message");

logger.info("Message From Redis Server {}", message);

// Caching Demonstration

logger.info("Heavy work is starting for the first time");

final String firstResult = someLongBusiness.doSomeHeavyWork(message);

logger.info("First (Takes 5 sec): {}", firstResult);

final String secondResult = someLongBusiness.doSomeHeavyWork(message);

logger.info("Second: {}", secondResult);

final String thirdResult = someLongBusiness.doSomeHeavyWork("Different Message");

logger.info("Third (Takes 5 sec): {}", thirdResult);

final String forthResult = someLongBusiness.doSomeHeavyWork("Different Message");

logger.info("Forth: {}", forthResult);

}

Son

Böylelikle hem mesajlaşma hem de cahce’leme yapan uygulamamızı geliştirmiş olduk. Öncelikle “vagrant up” ile sanal makinemizi ayağa kaldırıp uygulamamızı çalıştırıyoruz. İlk çalıştırmamızda aşağıdakine benzer çıktılar almamız gerekiyor.

2015-07-12 15:26:38.513  INFO 984 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2015-07-12 15:26:38.518  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Sending message.....
2015-07-12 15:26:38.562  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Message From Redis Server Hello, World
2015-07-12 15:26:38.563  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Heavy work is starting for the first time
2015-07-12 15:26:43.582  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : First (Takes 5 sec): Result: Hello, World
2015-07-12 15:26:43.583  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Second: Result: Hello, World
2015-07-12 15:26:48.591  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Third (Takes 5 sec): Result: Different Message
2015-07-12 15:26:48.593  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Forth: Result: Different Message
2015-07-12 15:26:48.595  INFO 984 --- [           main] c.b.redis.SpringRedisApplication         : Started SpringRedisApplication in 11.089 seconds (JVM running for 11.428)

2015-07-12 15:26:38.513 INFO 984 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup

2015-07-12 15:26:38.518 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Sending message.....

2015-07-12 15:26:38.562 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Message From Redis Server Hello, World

2015-07-12 15:26:38.563 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Heavy work is starting for the first time

2015-07-12 15:26:43.582 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : First (Takes 5 sec): Result: Hello, World

2015-07-12 15:26:43.583 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Second: Result: Hello, World

2015-07-12 15:26:48.591 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Third (Takes 5 sec): Result: Different Message

2015-07-12 15:26:48.593 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Forth: Result: Different Message

2015-07-12 15:26:48.595 INFO 984 --- [ main] c.b.redis.SpringRedisApplication : Started SpringRedisApplication in 11.089 seconds (JVM running for 11.428)

İkinciye çalıştırdığımız da ise hiç bir bekleme yapmayacaktır ve bu sefer aşağıdakine benzer çıktılar alacağız.

2015-07-12 15:27:23.530  INFO 987 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2015-07-12 15:27:23.535  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Sending message.....
2015-07-12 15:27:23.579  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Message From Redis Server Hello, World
2015-07-12 15:27:23.580  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Heavy work is starting for the first time
2015-07-12 15:27:23.585  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : First (Takes 5 sec): Result: Hello, World
2015-07-12 15:27:23.586  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Second: Result: Hello, World
2015-07-12 15:27:23.588  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Third (Takes 5 sec): Result: Different Message
2015-07-12 15:27:23.589  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Forth: Result: Different Message
2015-07-12 15:27:23.591  INFO 987 --- [           main] c.b.redis.SpringRedisApplication         : Started SpringRedisApplication in 1.122 seconds (JVM running for 1.496)

2015-07-12 15:27:23.530 INFO 987 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup

2015-07-12 15:27:23.535 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Sending message.....

2015-07-12 15:27:23.579 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Message From Redis Server Hello, World

2015-07-12 15:27:23.580 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Heavy work is starting for the first time

2015-07-12 15:27:23.585 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : First (Takes 5 sec): Result: Hello, World

2015-07-12 15:27:23.586 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Second: Result: Hello, World

2015-07-12 15:27:23.588 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Third (Takes 5 sec): Result: Different Message

2015-07-12 15:27:23.589 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Forth: Result: Different Message

2015-07-12 15:27:23.591 INFO 987 --- [ main] c.b.redis.SpringRedisApplication : Started SpringRedisApplication in 1.122 seconds (JVM running for 1.496)

Redis kullandığımızdan cache’lediğimiz veriler farklı çalıştırmalarda da saklanmış oluyor. Bu aslında bakarsanız, clustered ortamlarda çok işinize yarayacak bir durum. Böylelikle aynı işlem farklı makinelerde de olsa tekrar tekrar yapılmamış oluyor.