[java] Ehcache와 Spring Integration의 연동 방법에 대해 설명해주세요.

30 Nov 2023

java

Ehcache는 자바의 메모리 기반 캐싱 라이브러리로써, 자주 사용되는 데이터를 메모리에 저장하여 애플리케이션의 성능을 향상시킬 수 있습니다. Spring Integration은 Spring 프레임워크에서 제공하는 기능을 통해 다양한 시스템 간의 통합을 지원합니다. 이번 포스트에서는 Ehcache와 Spring Integration을 연동하는 방법에 대해 알아보겠습니다.

1. 의존성 추가

Ehcache와 Spring Integration을 연동하기 위해 프로젝트의 의존성에 다음과 같은 라이브러리를 추가해야 합니다.

<dependencies>
    <!-- Ehcache -->
    <dependency>
        <groupId>org.ehcache</groupId>
        <artifactId>ehcache</artifactId>
        <version>3.8.1</version>
    </dependency>
    <!-- Spring Integration -->
    <dependency>
        <groupId>org.springframework.integration</groupId>
        <artifactId>spring-integration-core</artifactId>
        <version>5.5.0</version>
    </dependency>
</dependencies>

2. Ehcache 설정

Ehcache의 설정 파일을 생성하고 캐시 설정을 합니다. 보통 ehcache.xml 파일을 사용합니다. 아래는 ehcache.xml의 예시입니다.

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.ehcache.org/v3"
    xsi:schemaLocation="http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core-3.0.xsd">

    <cache alias="myCache">
        <heap unit="entries">100</heap>
    </cache>

</config>

3. Spring Integration 캐시 어댑터 설정

Spring Integration에서는 CacheAdapter라는 추상 클래스를 통해 Ehcache를 쉽게 사용할 수 있도록 지원합니다. CacheAdapter를 상속받는 클래스를 생성하고, 필요한 메소드를 구현합니다.

import org.ehcache.Cache;
import org.ehcache.CacheManager;
import org.springframework.integration.cache.CacheAdapter;

public class EhcacheAdapter extends CacheAdapter<String, Object> {

    private final Cache<String, Object> cache;

    public EhcacheAdapter(CacheManager cacheManager) {
        this.cache = cacheManager.getCache("myCache", String.class, Object.class);
    }

    @Override
    public Object get(Object key) {
        return cache.get((String) key);
    }

    @Override
    public void put(String key, Object value, int timeToLiveSeconds) {
        cache.put(key, value);
    }

    // 필요한 메소드 추가 구현

}

4. Spring Integration 구성

Spring Integration의 구성 파일(applicationContext.xml 또는 Java Config)에서 Ehcache를 사용할 수 있도록 설정합니다.

<bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
    <property name="cacheManager">
        <bean class="org.ehcache.jsr107.EhcacheCachingProvider" factory-method="createCachingProvider">
            <constructor-arg>
                <value>org.ehcache.jsr107.Jsr107CachingProvider</value>
            </constructor-arg>
        </bean>
    </property>
</bean>

<bean id="cacheAdapter" class="com.example.EhcacheAdapter">
    <constructor-arg ref="cacheManager" />
</bean>

<integration:bridge id="ehcacheBridge" input-channel="cacheChannel" output-channel="resultsChannel" />

<integration:gateway id="cacheGateway" service-interface="org.springframework.integration.util.GenericHandler"
    default-request-channel="cacheChannel" default-reply-channel="resultsChannel" />

<integration:service-activator input-channel="resultsChannel" ref="cacheAdapter" method="handleResult" />

5. 사용 예시

Ehcache와 Spring Integration이 연동된 예시를 살펴보겠습니다.

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.messaging.MessageChannel;
import org.springframework.integration.cache.CacheRequest;
import org.springframework.integration.cache.CacheResponse;

public class MyCacheService {

    @Autowired
    private MessageChannel cacheChannel;

    public Object getFromCache(String key) {
        CacheRequest cacheRequest = new CacheRequest(key);
        cacheChannel.send(MessageBuilder.withPayload(cacheRequest).build());
        CacheResponse cacheResponse = (CacheResponse) cacheChannel.receive().getPayload();
        return cacheResponse.getResult();
    }

    public void putToCache(String key, Object value) {
        CacheRequest cacheRequest = new CacheRequest(key, value);
        cacheChannel.send(MessageBuilder.withPayload(cacheRequest).build());
    }

}

위의 코드에서 cacheChannel은 Spring Integration의 MessageChannel을 통해 캐시 데이터를 요청하고 응답을 받는 채널입니다. getFromCache 메소드에서는 CacheRequest를 생성하여 cacheChannel로 전송하고, CacheResponse를 받아서 결과를 반환합니다. putToCache 메소드에서는 CacheRequest를 생성하여 cacheChannel로 전송합니다.

이와 같이 Ehcache와 Spring Integration을 연동하면 캐시 데이터의 자동 관리와 편리한 통합을 할 수 있습니다.

더 자세한 내용은 다음 참고 자료를 확인해주세요.

Ehcache 공식 문서: https://www.ehcache.org/documentation/3.8/
Spring Integration 공식 문서: https://docs.spring.io/spring-integration/docs/5.5.0/reference/html/index.html