org.jooby.jedis

Class Redis

java.lang.Object

org.jooby.jedis.Redis

All Implemented Interfaces:

Jooby.Module

public class Redis
extends Object
implements Jooby.Module

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

usage

It is pretty straightforward:

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

 {
   use(new Redis());

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

pool 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 = req.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

That's all folks! Enjoy it!

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

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Redis() A new Redis instance, with a default database name of: db.
Redis(String name) Creates a new Redis instance and connect to the provided database.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Redis	named() Bind JedisPool and Jedis services with a Named annotation.
Redis	unnamed() Bind JedisPool and Jedis services without a Named annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Redis

public Redis(String name)

Creates a new Redis instance and connect to the provided database. Please note, the name is a property in your application.conf file with Redis URI.

 {
   use(new Redis("db1"));
 }
 

application.conf

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

Default database name is: db

Parameters:

name - A database name.

Redis

public Redis()

A new Redis instance, with a default database name of: db.

Method Detail

named

public Redis named()

Bind JedisPool and Jedis services with a Named annotation.

Returns:

This module.

unnamed

public Redis unnamed()

Bind JedisPool and Jedis services without a Named annotation.

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module