Class RedisCacher

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Middleware

services.moleculer.cacher.Cacher

services.moleculer.cacher.DistributedCacher

services.moleculer.cacher.RedisCacher

All Implemented Interfaces:

io.lettuce.core.event.EventBus, MetricConstants, MoleculerLifecycle

public class RedisCacher
extends DistributedCacher
implements io.lettuce.core.event.EventBus

Redis-based distributed cache. Supports SSL, clustering and password authentication. It's the one of the fastest distributed cache. Supports global and entry-level TTL configuration.

Required dependency:

// https://mvnrepository.com/artifact/biz.paluch.redis/lettuce
compile group: 'biz.paluch.redis', name: 'lettuce', version: '4.5.0.Final'

See Also:

• MemoryCacher

Field Summary

Fields

Modifier and Type	Field	Description
protected RedisGetSetClient	client
protected MetricCounter	counterClean
protected MetricCounter	counterDel
protected MetricCounter	counterFound
protected MetricCounter	counterGet
protected MetricCounter	counterSet
protected ExecutorService	executor
protected io.lettuce.core.SetArgs	expiration
protected String	password
protected ScheduledExecutorService	scheduler
protected boolean	secure
protected Serializer	serializer
protected final AtomicInteger	status
protected static final int	STATUS_CONNECTED
protected static final int	STATUS_CONNECTING
protected static final int	STATUS_DISCONNECTED
protected static final int	STATUS_DISCONNECTING
protected static final int	STATUS_STOPPED
protected int	ttl
protected String[]	urls

Fields inherited from class DistributedCacher

CONTENT, hashers, maxParamsLength

Fields inherited from class Cacher

debug, metrics

Fields inherited from class MoleculerComponent

broker, logger, name

Fields inherited from interface MetricConstants

MOLECULER_CACHER_CLEAN_TIME, MOLECULER_CACHER_CLEAN_TIME_DESC, MOLECULER_CACHER_CLEAN_TOTAL, MOLECULER_CACHER_CLEAN_TOTAL_DESC, MOLECULER_CACHER_DEL_TIME, MOLECULER_CACHER_DEL_TIME_DESC, MOLECULER_CACHER_DEL_TOTAL, MOLECULER_CACHER_DEL_TOTAL_DESC, MOLECULER_CACHER_EXPIRED_TOTAL, MOLECULER_CACHER_EXPIRED_TOTAL_DESC, MOLECULER_CACHER_FOUND_TOTAL, MOLECULER_CACHER_FOUND_TOTAL_DESC, MOLECULER_CACHER_GET_TIME, MOLECULER_CACHER_GET_TIME_DESC, MOLECULER_CACHER_GET_TOTAL, MOLECULER_CACHER_GET_TOTAL_DESC, MOLECULER_CACHER_SET_TIME, MOLECULER_CACHER_SET_TIME_DESC, MOLECULER_CACHER_SET_TOTAL, MOLECULER_CACHER_SET_TOTAL_DESC, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL_DESC, MOLECULER_EVENT_BROADCAST_TOTAL, MOLECULER_EVENT_BROADCAST_TOTAL_DESC, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL_DESC, MOLECULER_EVENT_EMIT_TOTAL, MOLECULER_EVENT_EMIT_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_ACTIVE, MOLECULER_EVENT_RECEIVED_ACTIVE_DESC, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_TIME, MOLECULER_EVENT_RECEIVED_TIME_DESC, MOLECULER_EVENT_RECEIVED_TOTAL, MOLECULER_EVENT_RECEIVED_TOTAL_DESC, MOLECULER_EXECUTOR, MOLECULER_REQUEST_ACTIVE, MOLECULER_REQUEST_ACTIVE_DESC, MOLECULER_REQUEST_ERROR_TOTAL, MOLECULER_REQUEST_ERROR_TOTAL_DESC, MOLECULER_REQUEST_LEVELS, MOLECULER_REQUEST_LEVELS_DESC, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL_DESC, MOLECULER_REQUEST_TIME, MOLECULER_REQUEST_TIME_DESC, MOLECULER_REQUEST_TIMEOUT_TOTAL, MOLECULER_REQUEST_TIMEOUT_TOTAL_DESC, MOLECULER_REQUEST_TOTAL, MOLECULER_REQUEST_TOTAL_DESC, MOLECULER_SCHEDULER, MOLECULER_TRANSIT_CONNECTED, MOLECULER_TRANSIT_CONNECTED_DESC, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL_DESC, MOLECULER_TRANSIT_REQUESTS_ACTIVE, MOLECULER_TRANSIT_REQUESTS_ACTIVE_DESC, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL_DESC

Constructor Summary

Constructors

Constructor	Description
RedisCacher()
RedisCacher(String... urls)
RedisCacher(String password, int defaultTtl, boolean secure, String... urls)

Method Summary

Modifier and Type	Method	Description
io.datatree.Promise	clean(String match)	Cleans this cache.
protected void	connect()
io.datatree.Promise	del(String key)	Deletes a content from this cache.
protected io.datatree.Promise	disconnect()
reactor.core.publisher.Flux<io.lettuce.core.event.Event>	get()
io.datatree.Promise	get(String key)	Gets a cached content by a key.
io.datatree.Promise	getCacheKeys()	Lists all keys of cached entries.
String	getPassword()
Serializer	getSerializer()
int	getTtl()
String[]	getUrls()
boolean	isSecure()
void	publish(io.lettuce.core.event.Event event)
protected void	reconnect()
io.datatree.Promise	set(String key, io.datatree.Tree value, int ttl)	Sets a content by key into the cache.
void	setPassword(String password)
void	setSecure(boolean useSSL)
void	setSerializer(Serializer serializer)
void	setTtl(int ttl)
void	setUrls(String... urls)
void	started(ServiceBroker broker)	Initializes cacher instance.
void	stopped()

Methods inherited from class DistributedCacher

getCacheKey, getMaxParamsLength, setMaxParamsLength

Methods inherited from class Cacher

appendToKey, appendTree, install, isCachingDisabledByTheContext, isDebug, logClean, serializeKey, setDebug

Methods inherited from class MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class Object

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

Field Details

STATUS_DISCONNECTING

protected static final int STATUS_DISCONNECTING

See Also:

• Constant Field Values

STATUS_DISCONNECTED

protected static final int STATUS_DISCONNECTED

See Also:

• Constant Field Values

STATUS_CONNECTING

protected static final int STATUS_CONNECTING

See Also:

• Constant Field Values

STATUS_CONNECTED

protected static final int STATUS_CONNECTED

See Also:

• Constant Field Values

STATUS_STOPPED

protected static final int STATUS_STOPPED

See Also:

• Constant Field Values

status

protected final AtomicInteger status

password

protected String password

ttl

protected int ttl

secure

protected boolean secure

urls

protected String[] urls

client

protected RedisGetSetClient client

serializer

protected Serializer serializer

executor

protected ExecutorService executor

scheduler

protected ScheduledExecutorService scheduler

expiration

protected io.lettuce.core.SetArgs expiration

counterGet

protected MetricCounter counterGet

counterSet

protected MetricCounter counterSet

counterDel

protected MetricCounter counterDel

counterClean

protected MetricCounter counterClean

counterFound

protected MetricCounter counterFound

Constructor Details

RedisCacher

public RedisCacher()

RedisCacher

public RedisCacher(String... urls)

RedisCacher

public RedisCacher(String password,
 int defaultTtl,
 boolean secure,
 String... urls)

Method Details

started

public void started(ServiceBroker broker)
             throws Exception

Initializes cacher instance.

Specified by:

started in interface MoleculerLifecycle

Overrides:

started in class Cacher

Parameters:

broker - parent ServiceBroker

Throws:

Exception

connect

protected void connect()

disconnect

protected io.datatree.Promise disconnect()

reconnect

protected void reconnect()

stopped

public void stopped()

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class MoleculerComponent

get

public io.datatree.Promise get(String key)

Description copied from class: Cacher

Gets a cached content by a key.

Specified by:

get in class Cacher

Parameters:

key - cache key

Returns:

Promise with cached value (or null, the returned Promise also can be null)

set

public io.datatree.Promise set(String key,
 io.datatree.Tree value,
 int ttl)

Description copied from class: Cacher

Sets a content by key into the cache.

Specified by:

set in class Cacher

Parameters:

key - cache key

value - new value

ttl - optional TTL of entry (0 == use default TTL)

Returns:

Promise with empty value

del

public io.datatree.Promise del(String key)

Description copied from class: Cacher

Deletes a content from this cache.

Specified by:

del in class Cacher

Parameters:

key - cache key

Returns:

Promise with empty value

clean

public io.datatree.Promise clean(String match)

Description copied from class: Cacher

Cleans this cache. Removes every key by a match string. The default match string is "**".

Specified by:

clean in class Cacher

Parameters:

match - regex

Returns:

Promise with empty value

getCacheKeys

public io.datatree.Promise getCacheKeys()

Lists all keys of cached entries.

Specified by:

getCacheKeys in class Cacher

Returns:

a Tree object with a "keys" array.

publish

public void publish(io.lettuce.core.event.Event event)

Specified by:

publish in interface io.lettuce.core.event.EventBus

get

public reactor.core.publisher.Flux<io.lettuce.core.event.Event> get()

Specified by:

get in interface io.lettuce.core.event.EventBus

getUrls

public String[] getUrls()

setUrls

public void setUrls(String... urls)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

isSecure

public boolean isSecure()

setSecure

public void setSecure(boolean useSSL)

getTtl

public int getTtl()

setTtl

public void setTtl(int ttl)

getSerializer

public Serializer getSerializer()

setSerializer

public void setSerializer(Serializer serializer)