jedis

Redis cache and key/value data store for Jooby. exports a Jedis service.

dependency

<dependency>
  <groupId>org.jooby</groupId>
  <artifactId>jooby-jedis</artifactId>
  <version>1.6.6</version>
</dependency>

usage

It is pretty straightforward:

# define a database URI 
db = "redis://localhost:6379"

{
  use(new Redis());

   get("/:key/:value", req -> {
     try (Jedis jedis = require(Jedis.class)) {
       jedis.set(req.param("key").value(), req.param("value").value());
       return jedis.get(req.param("key").value());
     }
   });
}

configuration

This module creates a [JedisPool]. A default pool is created with a max of 128 instances.

The pool can be customized from your application.conf:

db = "redis://localhost:6379"

# increase pool size to 200 
jedis.pool.maxTotal = 200

two or more redis connections

In case you need two or more Redis connection, just do:

{
  use(new Redis()); // default is "db"
  use(new Redis("db1"));

  get("/:key/:value", req -> {
    try (Jedis jedis = require("db1", Jedis.class)) {
      jedis.set(req.param("key").value(), req.param("value").value());
      return jedis.get(req.param("key").value());
    }
  });
}

application.conf:

db = "redis://localhost:6379/0"

db1 = "redis://localhost:6379/1"

Pool configuration for db1 is inherited from jedis.pool. If you need to tweak the pool configuration for db1 just do:

db1 = "redis://localhost:6379/1"

# ONLY 10 for db1 
jedis.db1.maxTotal = 10

For more information about Jedis checkout the wiki

redis session store

dependency

<dependency>
  <groupId>org.jooby</groupId>
  <artifactId>jooby-jedis</artifactId>
  <version>1.6.6</version>
</dependency>

usage

{
  use(new Redis());

  session(RedisSessionStore.class);

  get("/", req -> {
   req.session().set("name", "jooby");
  });
}

The name attribute and value will be stored in a Redis. Sessions are persisted as hashes.

options

timeout

By default, a Redis session will expire after 30 minutes. Changing the default timeout is as simple as:


# 8 hours session.timeout = 8h

# 15 seconds 
session.timeout = 15

# 120 minutes 
session.timeout = 120m

# no timeout 
session.timeout = -1

key prefix

Default redis key prefix is sessions. Sessions in [redis] will look like: sessions:ID

It’s possible to change the default key setting the jedis.sesssion.prefix properties

That’s all folks! Enjoy it!

TBD: Object mapping? https://github.com/xetorthio/johm?

jedis.conf

These are the default properties for jedis:

# jedis default config 
# jedis 
jedis.timeout = 2s

# pool config 
jedis.pool.maxTotal = 128

jedis.pool.maxIdle = 10

jedis.pool.minIdle = 10

jedis.pool.lifo = true

jedis.pool.maxWait = -1

jedis.pool.minEvictableIdle = 30m

jedis.pool.softMinEvictableIdle = 30m

jedis.pool.numTestsPerEvictionRun = 3

jedis.pool.evictionPolicyClassName = org.apache.commons.pool2.impl.DefaultEvictionPolicy

jedis.pool.testOnBorrow = false

jedis.pool.testOnReturn = false

jedis.pool.testWhileIdle = false

jedis.pool.timeBetweenEvictionRuns = -1

jedis.pool.blockWhenExhausted = true

jedis.pool.jmxEnabled = false

jedis.pool.jmxNamePrefix = redis-pool

# session store, key prefix and timeout in seconds 
jedis.session.prefix = sessions

jedis.session.timeout = ${session.timeout}

jedis.sentinel.hosts = []

jedis.sentinel.master = "master"

jedis.password = ""