com.navercorp.arcus.spring.cache

Class ArcusCache

java.lang.Object

com.navercorp.arcus.spring.cache.ArcusCache

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.cache.Cache

public class ArcusCache
extends java.lang.Object
implements org.springframework.cache.Cache, org.springframework.beans.factory.InitializingBean

스프링 Cache의 Arcus 구현체.

Arcus의 key 구조는 prefix:subkey 입니다. prefix는 사용자가 그룹으로 생성하고자 하는 subkey들의 집합이며 ArcusCache에서는 서비스 또는 빌드 단계 등의 구분을 위해 serviceId + name으로 정의합니다. serviceCode 속성과 name는 반드시 설정되어야 합니다.

 <bean id="operationTranscoderA" class="net.spy.memcached.transcoders.SerializingTranscoder">
   <property name="charset" value="UTF-8" />
   <property name="compressionThreshold" value="400" />
 </bean>

 <bean id="operationTranscoderB" class="net.spy.memcached.transcoders.SerializingTranscoder">
   <property name="charset" value="UTF-8" />
   <property name="compressionThreshold" value="1024" />
 </bean>

 <bean id="arcusCacheManager" class="org.springframework.cache.support.SimpleCacheManager">
   <property name="caches">
     <list>
       <bean p:name="member" p:timeoutMilliSeconds="500" parent="defaultArcusCache" p:operationTranscoder-ref="operationTranscoderA" />
       <bean p:name="memberList" p:expireSeconds="3000" parent="defaultArcusCache" p:operationTranscoder-ref="operationTranscoderB" />
     </list>
   </property>
 </bean>

 <bean id="defaultArcusCache" class="com.navercorp.arcus.spring.cache.ArcusCache"
 p:arcusClient-ref="arcusClient" p:timeoutMilliSeconds="500"
 p:expireSeconds="3000" abstract="true" serviceId="beta-" />
 

이렇게 설정했을때, 캐시의 키 값으로 생성되는 값은 beta-member:메서드 매개변수로 만든 문자열이 됩니다.

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

org.springframework.cache.Cache.ValueRetrievalException, org.springframework.cache.Cache.ValueWrapper

Constructor Summary

Constructors

Constructor and Description
ArcusCache()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	clear()
java.lang.String	createArcusKey(java.lang.Object key) serviceId, prefix, name 값을 사용하여 아커스 키를 생성합니다. serviceId는 필수값이며, prefix 또는 name 둘 중에 하나가 반드시 있어야 합니다. name과 prefix값이 모두 있다면 prefix 값을 사용합니다.
void	evict(java.lang.Object key)
org.springframework.cache.Cache.ValueWrapper	get(java.lang.Object key)
<T> T	get(java.lang.Object key, java.util.concurrent.Callable<T> valueLoader)
<T> T	get(java.lang.Object key, java.lang.Class<T> type)
net.spy.memcached.ArcusClientPool	getArcusClient()
int	getExpireSeconds()
KeyLockProvider	getKeyLockProvider()
java.lang.String	getName()
java.lang.Object	getNativeCache()
net.spy.memcached.transcoders.Transcoder<java.lang.Object>	getOperationTranscoder()
java.lang.String	getPrefix()
java.lang.String	getServiceId()
long	getTimeoutMilliSeconds()
boolean	isWantToGetException() Deprecated.
void	put(java.lang.Object key, java.lang.Object value)
org.springframework.cache.Cache.ValueWrapper	putIfAbsent(java.lang.Object key, java.lang.Object value)
void	setArcusClient(net.spy.memcached.ArcusClientPool arcusClient)
void	setExpireSeconds(int expireSeconds)
void	setKeyLockProvider(KeyLockProvider keyLockProvider)
void	setName(java.lang.String name)
void	setOperationTranscoder(net.spy.memcached.transcoders.Transcoder<java.lang.Object> operationTranscoder)
void	setPrefix(java.lang.String prefix)
void	setServiceId(java.lang.String serviceId)
void	setTimeoutMilliSeconds(long timeoutMilliseconds)
void	setWantToGetException(boolean wantToGetException) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArcusCache

public ArcusCache()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.springframework.cache.Cache

getNativeCache

public java.lang.Object getNativeCache()

Specified by:

getNativeCache in interface org.springframework.cache.Cache

get

public org.springframework.cache.Cache.ValueWrapper get(java.lang.Object key)

Specified by:

get in interface org.springframework.cache.Cache

get

public <T> T get(java.lang.Object key,
                 java.lang.Class<T> type)

Specified by:

get in interface org.springframework.cache.Cache

get

public <T> T get(java.lang.Object key,
                 java.util.concurrent.Callable<T> valueLoader)

Specified by:

get in interface org.springframework.cache.Cache

put

public void put(java.lang.Object key,
                java.lang.Object value)

Specified by:

put in interface org.springframework.cache.Cache

putIfAbsent

public org.springframework.cache.Cache.ValueWrapper putIfAbsent(java.lang.Object key,
                                                                java.lang.Object value)

Specified by:

putIfAbsent in interface org.springframework.cache.Cache

Parameters:

key - key

value - value

Returns:

지정된 키에 대한 캐시 아이템이 존재하지 않았으며 지정된 값을 캐시에 저장하였다면 null을 리턴, 캐시 아이템이 이미 존재하였다면 지정된 키에 대한 값을 불러와 리턴한다. 값을 불러올 때 비원자적으로 수행되기 때문에 중간에 다른 캐시 연산 수행으로 인하여 새로운 값이 리턴 될 수 있으며 혹은 캐시 만료로 인해 ValueWrapper의 내부 value가 null이 되어 리턴될 수 있다.

evict

public void evict(java.lang.Object key)

Specified by:

evict in interface org.springframework.cache.Cache

clear

public void clear()

Specified by:

clear in interface org.springframework.cache.Cache

createArcusKey

public java.lang.String createArcusKey(java.lang.Object key)

serviceId, prefix, name 값을 사용하여 아커스 키를 생성합니다. serviceId는 필수값이며, prefix 또는 name 둘 중에 하나가 반드시 있어야 합니다. name과 prefix값이 모두 있다면 prefix 값을 사용합니다.

키 생성 로직은 다음과 같습니다.

serviceId + (prefix | name) + ":" + key.toString();

만약 전체 키의 길이가 250자를 넘을 경우에는 key.toString() 대신 그 값을 MD5로 압축한 값을 사용합니다.

Parameters:

key - key

Returns:

입력받은 키를 기반으로 캐시 용도의 키를 생성하고 이를 리턴한다. 입력받은 키의 타입에 따라 다른 형태의 캐시 키를 생성할 수 있다

setName

public void setName(java.lang.String name)

setExpireSeconds

public void setExpireSeconds(int expireSeconds)

setTimeoutMilliSeconds

public void setTimeoutMilliSeconds(long timeoutMilliseconds)

setArcusClient

public void setArcusClient(net.spy.memcached.ArcusClientPool arcusClient)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

getServiceId

public java.lang.String getServiceId()

setServiceId

public void setServiceId(java.lang.String serviceId)

isWantToGetException

@Deprecated
public boolean isWantToGetException()

Deprecated.

setWantToGetException

@Deprecated
public void setWantToGetException(boolean wantToGetException)

Deprecated.

getExpireSeconds

public int getExpireSeconds()

getTimeoutMilliSeconds

public long getTimeoutMilliSeconds()

getArcusClient

public net.spy.memcached.ArcusClientPool getArcusClient()

getOperationTranscoder

public net.spy.memcached.transcoders.Transcoder<java.lang.Object> getOperationTranscoder()

setOperationTranscoder

public void setOperationTranscoder(net.spy.memcached.transcoders.Transcoder<java.lang.Object> operationTranscoder)

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

getKeyLockProvider

public KeyLockProvider getKeyLockProvider()

setKeyLockProvider

public void setKeyLockProvider(KeyLockProvider keyLockProvider)