|
| 1 | +== Redis |
| 2 | + |
| 3 | +Redis using https://lettuce.io[Lettuce] library. |
| 4 | + |
| 5 | +=== Usage |
| 6 | + |
| 7 | +1) Add the dependency: |
| 8 | + |
| 9 | +[dependency, artifactId="jooby-redis"] |
| 10 | +. |
| 11 | + |
| 12 | +2) Set redis property |
| 13 | + |
| 14 | +.application.conf |
| 15 | +[source, properties] |
| 16 | +---- |
| 17 | +redis = "redis://localhost:6379" |
| 18 | +---- |
| 19 | + |
| 20 | +3) Install and use Redis |
| 21 | + |
| 22 | +.Java |
| 23 | +[source, java, role="primary"] |
| 24 | +---- |
| 25 | +import io.jooby.redis.RedisModule; |
| 26 | +import io.lettuce.core.api.StatefulRedisConnection; |
| 27 | +
|
| 28 | +{ |
| 29 | + install(new RedisModule()); <1> |
| 30 | +
|
| 31 | + get("/", ctx -> { |
| 32 | + StatefulRedisConnection redis = require(StatefulRedisConnection.class); <2> |
| 33 | + // work with redis |
| 34 | + }); |
| 35 | +} |
| 36 | +---- |
| 37 | + |
| 38 | +.Kotlin |
| 39 | +[source, kt, role="secondary"] |
| 40 | +---- |
| 41 | +import io.jooby.redis.RedisModule |
| 42 | +import io.lettuce.core.api.StatefulRedisConnection |
| 43 | +
|
| 44 | +{ |
| 45 | + install(RedisModule()) <1> |
| 46 | + |
| 47 | + get("/") { |
| 48 | + val redis = require(StatefulRedisConnection::class) <2> |
| 49 | + // work with Database |
| 50 | + } |
| 51 | +} |
| 52 | +---- |
| 53 | + |
| 54 | +<1> Install Redis |
| 55 | +<2> Use Redis |
| 56 | + |
| 57 | +The `io.lettuce.core.pubsub.StatefulRedisPubSubConnection` is also available. |
| 58 | + |
| 59 | +=== Redis URI |
| 60 | + |
| 61 | +Redis URI are allowed to pass it directly or from application configuration file: |
| 62 | + |
| 63 | +---- |
| 64 | +{ |
| 65 | + new RedisModule("redis://localhost:6379"); |
| 66 | +} |
| 67 | +---- |
| 68 | + |
| 69 | +Or read it from configuration: |
| 70 | + |
| 71 | +---- |
| 72 | +{ |
| 73 | + new RedisModule("redis"); |
| 74 | +} |
| 75 | +---- |
| 76 | + |
| 77 | +Either `redis` or `redis.uri` must be present in your application configuration file and must be a |
| 78 | +https://lettuce.io/core/release/reference/index.html#redisuri.uri-syntax[valid Redis URI]. |
| 79 | + |
| 80 | +=== Multiple Connections |
| 81 | + |
| 82 | +Support for multiple connection is done using multiple configuration keys: |
| 83 | + |
| 84 | +.Java |
| 85 | +[source, java, role="primary"] |
| 86 | +---- |
| 87 | +import io.jooby.redis.RedisModule; |
| 88 | +import io.lettuce.core.api.StatefulRedisConnection; |
| 89 | +
|
| 90 | +{ |
| 91 | + install(new RedisModule("foo")); |
| 92 | +
|
| 93 | + install(new RedisModule("bar")); |
| 94 | +
|
| 95 | + get("/", ctx -> { |
| 96 | + StatefulRedisConnection foo = require(StatefulRedisConnection.class, "foo"); |
| 97 | + // work with redis |
| 98 | + }); |
| 99 | +} |
| 100 | +---- |
| 101 | + |
| 102 | +.Kotlin |
| 103 | +[source, kt, role="secondary"] |
| 104 | +---- |
| 105 | +import io.jooby.redis.RedisModule |
| 106 | +import io.lettuce.core.api.StatefulRedisConnection |
| 107 | +
|
| 108 | +{ |
| 109 | + install(RedisModule("foo")) |
| 110 | +
|
| 111 | + install(RedisModule("bar")) |
| 112 | + |
| 113 | + get("/") { |
| 114 | + val redis = require(StatefulRedisConnection::class, "bar") |
| 115 | + // work with Database |
| 116 | + } |
| 117 | +} |
| 118 | +---- |
| 119 | + |
| 120 | +Where `foo` and `bar` are redis URI in your application configuration file: |
| 121 | + |
| 122 | +.application.conf |
| 123 | +[source, properties] |
| 124 | +---- |
| 125 | +foo = "redis://server1:6379" |
| 126 | +
|
| 127 | +bar = "redis://server2:6379" |
| 128 | +---- |
| 129 | + |
| 130 | +=== HTTP Session |
| 131 | + |
| 132 | +The Redis module provides a HTTP Session Store. |
| 133 | + |
| 134 | +.Usage |
| 135 | +[source, java, role="primary"] |
| 136 | +---- |
| 137 | +import io.jooby.redis.RedisModule; |
| 138 | +import io.jooby.redis.RedisSessionStore; |
| 139 | +
|
| 140 | +import io.lettuce.core.api.StatefulRedisConnection; |
| 141 | +
|
| 142 | +{ |
| 143 | + install(new RedisModule()); <1> |
| 144 | +
|
| 145 | + setSessionStore(new RedisSessionStore(require(StatefulRedisConnection.class))); <2> |
| 146 | +
|
| 147 | + get("/", ctx -> { |
| 148 | + Session httpSession = ctx.session(); <3> |
| 149 | + // HTTP session is backed by Redis |
| 150 | + }); |
| 151 | +} |
| 152 | +---- |
| 153 | + |
| 154 | +.Kotlin |
| 155 | +[source, kt, role="secondary"] |
| 156 | +---- |
| 157 | +import io.jooby.redis.RedisModule |
| 158 | +import io.jooby.redis.RedisSessionStore |
| 159 | +
|
| 160 | +import io.lettuce.core.api.StatefulRedisConnection |
| 161 | +
|
| 162 | +{ |
| 163 | + install(RedisModule()) <1> |
| 164 | + |
| 165 | + sessionStore = RedisSessionStore(require(StatefulRedisConnection::class)) <2> |
| 166 | +
|
| 167 | + get("/") { |
| 168 | + val httpSession = ctx.session() <3> |
| 169 | + // HTTP session is backed by Redis |
| 170 | + } |
| 171 | +} |
| 172 | +---- |
| 173 | + |
| 174 | +<1> Install Redis module |
| 175 | +<2> Configure session store to use Redis |
| 176 | +<3> Session data is persisted in Redis |
| 177 | + |
| 178 | +More Options: |
| 179 | + |
| 180 | +- javadoc:redis.RedisSessionStore[setTimeout, java.time.Duraction]: Set session timeout. Default is: `30 minutes` |
| 181 | +- javadoc:redis.RedisSessionStore[setNamespace, java.lang.String]: Set key prefix. Default is: `sessions` |
| 182 | +- javadoc:redis.RedisSessionStore[setToken, io.jooby.SessionToken]: Set session token. Default is a cookie token: `jooby.sid` |
0 commit comments