{ "id": "java-lettuce", "title": "Redis pub/sub with Lettuce", "url": "https://redis.io/docs/latest/develop/use-cases/pub-sub/java-lettuce/", "summary": "Implement Redis pub/sub messaging in Java with Lettuce", "tags": [ "docs", "develop", "stack", "oss", "rs", "rc" ], "last_updated": "2026-05-14T08:58:05-05:00", "children": [], "page_type": "content", "content_hash": "a5462855c43625f46a3b2de2643a27dfe3133135e584882921cde38d3f8f0839", "sections": [ { "id": "overview", "title": "Overview", "role": "overview", "text": "This guide shows you how to implement a Redis-backed pub/sub broadcaster in Java with the [Lettuce](https://redis.io/docs/latest/develop/clients/lettuce) client library. It includes a small local web server built on the JDK's `com.sun.net.httpserver` so you can publish messages to named channels, add and remove subscribers live, and watch Redis fan out each message to every interested listener." }, { "id": "overview", "title": "Overview", "role": "overview", "text": "Pub/sub lets your application broadcast events — chat messages, cache invalidation signals, presence updates, notifications — to many consumers without per-pair wiring. The publisher names a *channel*; every client currently subscribed to that channel receives the message, in publish order, with sub-millisecond fan-out.\n\nThat gives you:\n\n* Many-to-many event delivery with no message storage cost in Redis\n* Exact-match subscriptions (`SUBSCRIBE orders:new`) for known topics\n* Pattern subscriptions (`PSUBSCRIBE notifications:*`) for whole topic hierarchies\n* Live server-side introspection through `PUBSUB CHANNELS`, `PUBSUB NUMSUB`, and `PUBSUB NUMPAT`\n* At-most-once delivery: subscribers that are offline when a message is published miss it, so durable state should live in keys or a Stream, not in the pub/sub channel itself\n\nIn this example, the publisher side calls `PUBLISH` with a JSON-encoded body and counts how many subscribers Redis reported delivering to. Each in-process subscriber owns its own pub/sub connection and a Lettuce listener that pumps incoming messages into a callback." }, { "id": "how-it-works", "title": "How it works", "role": "content", "text": "The flow looks like this:\n\n1. The application calls `hub.subscribe(name, channels)` or `hub.psubscribe(name, patterns)`\n2. The helper opens a dedicated `StatefulRedisPubSubConnection`, attaches a `RedisPubSubListener`, and issues `SUBSCRIBE` or `PSUBSCRIBE` on it\n3. The application (or another process) calls `hub.publish(channel, message)`\n4. Redis fans the message out over every subscribing client's open socket\n5. Each subscriber's listener wraps the raw message as a `ReceivedMessage`, appends it to a per-subscriber ring buffer, and increments the received counter\n6. The publisher receives the integer subscriber count back from `PUBLISH`, which is the number of clients Redis delivered to right then\n\nPattern subscriptions match channels by glob (`*`, `?`, `[abc]`). A single message that matches both an exact subscription and a pattern subscription is delivered twice — once through `RedisPubSubListener.message(channel, msg)` and once through `RedisPubSubListener.message(pattern, channel, msg)`." }, { "id": "the-pub-sub-hub-helper", "title": "The pub/sub hub helper", "role": "content", "text": "The `RedisPubSubHub` class wraps the publish, subscribe, and introspection operations\n([source](https://github.com/redis/docs/blob/main/content/develop/use-cases/pub-sub/java-lettuce/RedisPubSubHub.java)):\n\n[code example]" }, { "id": "data-model", "title": "Data model", "role": "content", "text": "Pub/sub has no Redis keyspace footprint of its own — channels are server-side routing entries, not stored values. The hub keeps its own bookkeeping in process memory:\n\n[code example]\n\nThe implementation uses:\n\n* [`PUBLISH`](https://redis.io/docs/latest/commands/publish) to fan a JSON-encoded message out to every subscriber of a channel\n* [`SUBSCRIBE`](https://redis.io/docs/latest/commands/subscribe) for exact-match subscribers\n* [`PSUBSCRIBE`](https://redis.io/docs/latest/commands/psubscribe) for glob-style pattern subscribers\n* [`PUBSUB CHANNELS`](https://redis.io/docs/latest/commands/pubsub-channels) to list the channels with at least one active exact-match subscriber\n* [`PUBSUB NUMSUB`](https://redis.io/docs/latest/commands/pubsub-numsub) to count subscribers per channel\n* [`PUBSUB NUMPAT`](https://redis.io/docs/latest/commands/pubsub-numpat) to count active pattern subscriptions server-wide\n* Lettuce's `RedisPubSubListener` interface to dispatch messages without writing a thread loop by hand — messages are delivered on a Netty event-loop thread" }, { "id": "publishing-messages", "title": "Publishing messages", "role": "content", "text": "`publish()` JSON-encodes the message body, calls `PUBLISH`, and updates the per-channel publish counter:\n\n[code example]\n\nThe integer returned by `PUBLISH` is what Redis itself reports — the number of subscribers (direct and pattern) that received the message in that call. It's a useful sanity check that the channel name is actually being listened to: a steady stream of `0`s means you have a typo somewhere or your subscriber crashed.\n\nPublishing reuses the shared `StatefulRedisConnection`, which is thread-safe for individual commands, so concurrent HTTP handlers can publish without coordination." }, { "id": "subscribing-to-channels", "title": "Subscribing to channels", "role": "content", "text": "`subscribe()` creates a named in-process `Subscription` that owns its own pub/sub connection:\n\n[code example]\n\nInside the `Subscription` constructor, the helper opens a dedicated pub/sub connection, registers a listener, then issues `SUBSCRIBE`:\n\n[code example]\n\nA few details matter here:\n\n* Each `Subscription` gets its own `StatefulRedisPubSubConnection` (and therefore its own Redis socket). Lettuce switches a pub/sub connection into subscribe-only mode after the first `SUBSCRIBE` or `PSUBSCRIBE`, so sharing one across business-logic subscribers would couple their lifetimes — closing one would close the channel for the others.\n* `RedisPubSubListener` overloads `message()` twice: the two-argument form for plain `SUBSCRIBE` deliveries and the three-argument form for `PSUBSCRIBE` deliveries that carry the originating pattern. The helper routes both into a single `record()` method that writes into a bounded ring buffer.\n* Messages arrive on a Netty event-loop thread, not on the calling HTTP handler thread. The buffer is guarded with a `synchronized` block so a polling `/state` request can read it safely while a publish is in flight.\n* The constructor uses Lettuce's `sync()` API (not `async()`) so it blocks until Redis acknowledges the SUBSCRIBE for every channel before the `Subscription` is handed back to the caller. With the unawaited `async()` variant, a `PUBLISH` issued immediately after subscribing could race ahead of the acknowledgement and the first message would be lost." }, { "id": "pattern-subscriptions-with-psubscribe", "title": "Pattern subscriptions with PSUBSCRIBE", "role": "content", "text": "`psubscribe()` works the same way but routes messages through `PSUBSCRIBE` so each binding is a glob, not a literal channel name:\n\n[code example]\n\nWhen a published channel matches a pattern, Lettuce dispatches through the three-argument `message(String pattern, String channel, String body)` overload and the helper records both the matched channel and the original pattern:\n\n[code example]\n\nThat distinction is useful for routing: a pattern subscriber can do one thing for the whole hierarchy (e.g., increment a counter) and dispatch on the specific channel within its callback (e.g., \"invalidate this region's cache\")." }, { "id": "inspecting-active-subscribers", "title": "Inspecting active subscribers", "role": "content", "text": "Redis exposes a small set of pub/sub introspection commands that report on subscriber state without traversing any keyspace:\n\n[code example]\n\nLettuce exposes these as ordinary commands on `RedisCommands`: `pubsubChannels(pattern)`, `pubsubNumsub(channels...)`, and `pubsubNumpat()`. The helper runs each one against the shared `StatefulRedisConnection`.\n\n`PUBSUB CHANNELS` only reports channels with at least one exact-match subscriber — pattern subscribers do not appear here. That's a deliberate Redis design choice: a glob like `*` would otherwise show up as a subscriber to every conceivable channel. `PUBSUB NUMPAT` covers the pattern side as a single global count." }, { "id": "stats-and-history", "title": "Stats and history", "role": "content", "text": "`stats()` reports publish and receive counters plus the size of the subscription registry:\n\n[code example]\n\n`delivered_total` is what Redis itself counted; `received_total` is what this process's in-memory subscribers saw. In a single-process demo they should track each other closely — a sustained divergence usually means a listener threw, or a subscriber's pub/sub connection dropped while a publisher kept publishing. (Pub/sub is at-most-once: if your subscriber wasn't connected at publish time, the message is gone.)" }, { "id": "prerequisites", "title": "Prerequisites", "role": "content", "text": "* Redis 6.2 or later running locally on the default port (6379). Earlier versions still work for plain `PUBLISH`/`SUBSCRIBE`; `PUBSUB NUMPAT` is older than that.\n* JDK 11 or later.\n* The Lettuce JAR (6.1 or later) and its Netty + Reactor dependencies on your classpath. Get them from [Maven Central](https://repo1.maven.org/maven2/io/lettuce/lettuce-core/), or via Maven/Gradle in a project setup." }, { "id": "running-the-demo", "title": "Running the demo", "role": "content", "text": "" }, { "id": "get-the-source-files", "title": "Get the source files", "role": "content", "text": "The demo consists of two Java files. Download them from the [`java-lettuce` source folder](https://github.com/redis/docs/tree/main/content/develop/use-cases/pub-sub/java-lettuce) on GitHub, or grab them with `curl`:\n\n[code example]\n\nYou also need a `lib/` directory containing the Lettuce client and its runtime dependencies — at minimum:\n\n* `lettuce-core-6.x.jar`\n* `netty-buffer-4.1.x.jar`, `netty-codec-4.1.x.jar`, `netty-common-4.1.x.jar`, `netty-handler-4.1.x.jar`, `netty-resolver-4.1.x.jar`, `netty-transport-4.1.x.jar`, `netty-transport-native-unix-common-4.1.x.jar`\n* `reactor-core-3.x.jar`, `reactive-streams-1.0.x.jar`\n\nThe simplest way to collect them is with Maven. Create a minimal `pom.xml` declaring `io.lettuce:lettuce-core` as the only dependency, then run `mvn dependency:copy-dependencies -DoutputDirectory=lib`." }, { "id": "start-the-demo-server", "title": "Start the demo server", "role": "content", "text": "From the directory containing `RedisPubSubHub.java`, `DemoServer.java`, and `lib/`:\n\n[code example]\n\nYou should see:\n\n[code example]\n\nOpen [http://127.0.0.1:8099](http://127.0.0.1:8099) in a browser. You can:\n\n* Publish messages of any text to any channel name in any batch size.\n* Add named subscribers that listen on either a specific channel (`orders:new`) or a glob pattern (`notifications:*`). A single subscriber can listen on multiple targets — enter them comma-separated.\n* Watch each subscriber's incoming-message panel update every 800 ms.\n* See the server-side view: `PUBSUB CHANNELS` lists exact-match channels with subscribers, `PUBSUB NUMSUB` gives per-channel counts, and `PUBSUB NUMPAT` counts active pattern subscriptions.\n* Click **Reset** to drop every subscription, zero the counters, and re-seed the three default subscribers.\n\nIf your Redis server is running elsewhere, start the demo with `--redis-host` and `--redis-port`." }, { "id": "production-usage", "title": "Production usage", "role": "content", "text": "" }, { "id": "pub-sub-is-at-most-once-pair-it-with-durable-state-if-you-need-replay", "title": "Pub/sub is at-most-once — pair it with durable state if you need replay", "role": "content", "text": "A subscriber that's offline when a message is published misses it permanently. For events you can't afford to lose, write the durable record (the order row, the cache key version, the audit log entry) to its primary store, then `PUBLISH` a notification so live consumers can pick it up immediately. On reconnect, consumers reconcile by reading the durable store, not by waiting for missed pub/sub messages. If you actually need replay or at-least-once delivery, switch to [Redis Streams](https://redis.io/docs/latest/develop/data-types/streams) with consumer groups." }, { "id": "use-a-separate-statefulredispubsubconnection-per-subscriber", "title": "Use a separate `StatefulRedisPubSubConnection` per subscriber", "role": "content", "text": "Lettuce switches a pub/sub connection into subscribe-only mode after `SUBSCRIBE` or `PSUBSCRIBE`: ordinary commands (`GET`, `HSET`, etc.) on that connection will block or fail. Always create the pub/sub connection from `RedisClient.connectPubSub()` — separate from the connection you use for `PUBLISH` and other commands — and give every business-logic subscriber its own. Sharing one pub/sub connection across subscribers couples their lifetimes (closing one closes the channel for the others) and serialises listener invocations on a single Netty event-loop thread." }, { "id": "don-t-do-heavy-work-inside-the-listener-callback", "title": "Don't do heavy work inside the listener callback", "role": "content", "text": "`RedisPubSubListener.message()` runs on a Netty event-loop thread. If your listener blocks (synchronous HTTP call, big computation, slow JDBC write), it parks an I/O thread that should be handling other connections, and the next message on the same socket waits behind it. For heavier work, the listener should hand the message off to an `ExecutorService` worker pool, a `BlockingQueue`, or — for true durable handoff — a [Redis Streams](https://redis.io/docs/latest/develop/data-types/streams) consumer group." }, { "id": "choose-a-topic-naming-convention-up-front", "title": "Choose a topic naming convention up front", "role": "content", "text": "A flat namespace gets ugly fast — `email`, `email_high_priority`, `email_high_priority_billing`. Pick a colon-separated hierarchy (`notifications:billing:invoice`, `cache:invalidate:products:p-001`) so consumers can subscribe at the right level: a billing service uses `notifications:billing:*`, the audit logger uses `notifications:*`. Glob patterns are evaluated for every published message, so don't go wild with multiple wildcards on hot paths — `*:*:*` matches everything and costs more than a flat `notifications:*` would." }, { "id": "tune-the-subscriber-buffer-for-your-traffic-shape", "title": "Tune the subscriber buffer for your traffic shape", "role": "content", "text": "The demo caps each subscriber's in-memory message buffer at 50 entries. That's right for showing the recent activity in a UI, but a real subscriber typically processes each message and discards it — the buffer is only there for human inspection. If you keep a buffer, make sure it's bounded; an unbounded ring on a chatty pattern subscriber will eventually OOM the process." }, { "id": "sharded-pub-sub-on-a-redis-cluster", "title": "Sharded pub/sub on a Redis Cluster", "role": "content", "text": "On a Redis Cluster, plain `PUBLISH` fans every message out to every node via the cluster bus, which becomes a hotspot at high throughput. Redis 7.0 added [sharded pub/sub](https://redis.io/docs/latest/develop/pubsub#sharded-pubsub): channels are hashed to slots, and `SPUBLISH` / `SSUBSCRIBE` only touch the shard that owns the slot. Lettuce exposes these as `spublish()` and `ssubscribe()` on the cluster connection. If you're scaling pub/sub on a cluster, prefer the sharded commands and pick channel names whose hash distribution matches your traffic." }, { "id": "inspect-pub-sub-state-directly-in-redis", "title": "Inspect pub/sub state directly in Redis", "role": "content", "text": "Because pub/sub has no keyspace, `KEYS`/`SCAN` won't show you anything. Use the introspection commands instead:\n\n[code example]\n\n`redis-cli` in subscribe mode only exits with `Ctrl-C` — it can't issue any other commands while subscribed." }, { "id": "learn-more", "title": "Learn more", "role": "related", "text": "This example uses the following Redis commands:\n\n* [`PUBLISH`](https://redis.io/docs/latest/commands/publish) to fan a message out to every subscriber of a channel.\n* [`SUBSCRIBE`](https://redis.io/docs/latest/commands/subscribe) and [`UNSUBSCRIBE`](https://redis.io/docs/latest/commands/unsubscribe) for exact-match topic subscriptions.\n* [`PSUBSCRIBE`](https://redis.io/docs/latest/commands/psubscribe) and [`PUNSUBSCRIBE`](https://redis.io/docs/latest/commands/punsubscribe) for glob-style pattern subscriptions.\n* [`PUBSUB CHANNELS`](https://redis.io/docs/latest/commands/pubsub-channels) to list channels with at least one active exact-match subscriber.\n* [`PUBSUB NUMSUB`](https://redis.io/docs/latest/commands/pubsub-numsub) to count subscribers per named channel.\n* [`PUBSUB NUMPAT`](https://redis.io/docs/latest/commands/pubsub-numpat) to count active pattern subscriptions server-wide.\n\nSee the [Lettuce guide](https://redis.io/docs/latest/develop/clients/lettuce) for full client reference, including the `StatefulRedisPubSubConnection` and `RedisPubSubListener` types used in this example." } ], "examples": [ { "id": "the-pub-sub-hub-helper-ex0", "language": "java", "code": "import io.lettuce.core.RedisClient;\nimport io.lettuce.core.RedisURI;\nimport io.lettuce.core.api.StatefulRedisConnection;\n\nimport java.util.Arrays;\n\nRedisClient client = RedisClient.create(\n RedisURI.builder().withHost(\"localhost\").withPort(6379).build());\nStatefulRedisConnection connection = client.connect();\nRedisPubSubHub hub = new RedisPubSubHub(client, connection);\n\n// Exact-match subscriber.\nhub.subscribe(\"orders-listener\", Arrays.asList(\"orders:new\"));\n\n// Pattern subscriber covering an entire topic hierarchy.\nhub.psubscribe(\"all-notifications\", Arrays.asList(\"notifications:*\"));\n\n// Publish — returns Redis' delivered count for this PUBLISH.\njava.util.Map payload = new java.util.LinkedHashMap<>();\npayload.put(\"order_id\", 42);\npayload.put(\"total\", 199.0);\nint delivered = hub.publish(\"orders:new\", payload);\nSystem.out.printf(\"Redis delivered to %d subscriber(s)%n\", delivered);\n\n// Look at what each subscriber received.\nfor (RedisPubSubHub.Subscription sub : hub.subscriptions()) {\n System.out.println(sub.name() + \" \" + sub.receivedTotal() + \" messages\");\n for (RedisPubSubHub.ReceivedMessage m : sub.messages(5)) {\n System.out.println(\" \" + m.channel + \" \" + m.payload);\n }\n}\n\nhub.unsubscribe(\"orders-listener\");\nhub.shutdown(); // closes every remaining subscription\nconnection.close();\nclient.shutdown();", "section_id": "the-pub-sub-hub-helper" }, { "id": "data-model-ex0", "language": "text", "code": "RedisPubSubHub (in-process)\n subscriptions Map\n publishedTotal AtomicLong\n deliveredTotal AtomicLong\n channelPublished Map\n\nSubscription (in-process, one per subscriber)\n name String\n targets List\n isPattern boolean\n buffer Deque (capped, default 50)\n received long\n psConnection StatefulRedisPubSubConnection\n listener RedisPubSubListener", "section_id": "data-model" }, { "id": "publishing-messages-ex0", "language": "java", "code": "public int publish(String channel, Object message) {\n String payload = JsonCodec.encode(message);\n long delivered = connection.sync().publish(channel, payload);\n publishedTotal.incrementAndGet();\n deliveredTotal.addAndGet(delivered);\n channelPublished.merge(channel, 1L, Long::sum);\n return (int) delivered;\n}", "section_id": "publishing-messages" }, { "id": "subscribing-to-channels-ex0", "language": "java", "code": "public Subscription subscribe(String name, List channels) {\n return register(name, channels, false);\n}", "section_id": "subscribing-to-channels" }, { "id": "subscribing-to-channels-ex1", "language": "java", "code": "this.psConnection = client.connectPubSub();\n\nthis.psConnection.addListener(new RedisPubSubListener() {\n @Override public void message(String channel, String msg) {\n record(channel, null, msg);\n }\n @Override public void message(String pattern, String channel, String msg) {\n record(channel, pattern, msg);\n }\n @Override public void subscribed(String channel, long count) {}\n @Override public void psubscribed(String pattern, long count) {}\n @Override public void unsubscribed(String channel, long count) {}\n @Override public void punsubscribed(String pattern, long count) {}\n});\n\nif (isPattern) {\n psConnection.sync().psubscribe(targets.toArray(new String[0]));\n} else {\n psConnection.sync().subscribe(targets.toArray(new String[0]));\n}", "section_id": "subscribing-to-channels" }, { "id": "pattern-subscriptions-with-psubscribe-ex0", "language": "java", "code": "hub.psubscribe(\"all-notifications\", Arrays.asList(\"notifications:*\"));\nhub.psubscribe(\"cache-invalidator\", Arrays.asList(\"cache:invalidate:*\"));", "section_id": "pattern-subscriptions-with-psubscribe" }, { "id": "pattern-subscriptions-with-psubscribe-ex1", "language": "java", "code": "@Override\npublic void message(String pattern, String channel, String msg) {\n record(channel, pattern, msg); // exact subscriptions pass null for pattern\n}", "section_id": "pattern-subscriptions-with-psubscribe" }, { "id": "inspecting-active-subscribers-ex0", "language": "java", "code": "hub.activeChannels(\"*\"); // PUBSUB CHANNELS *\nhub.channelSubscriberCounts(Arrays.asList(\"orders:new\")); // PUBSUB NUMSUB ...\nhub.patternSubscriberCount(); // PUBSUB NUMPAT", "section_id": "inspecting-active-subscribers" }, { "id": "stats-and-history-ex0", "language": "java", "code": "public Map stats() {\n List subs = subscriptions();\n long received = 0;\n for (Subscription sub : subs) received += sub.receivedTotal();\n Map out = new LinkedHashMap<>();\n out.put(\"published_total\", publishedTotal.get());\n out.put(\"delivered_total\", deliveredTotal.get()); // sum of PUBLISH return values\n out.put(\"received_total\", received);\n out.put(\"active_subscriptions\", (long) subs.size());\n out.put(\"channel_published\", new LinkedHashMap<>(channelPublished));\n out.put(\"pattern_subscriptions\", patternSubscriberCount());\n return out;\n}", "section_id": "stats-and-history" }, { "id": "get-the-source-files-ex0", "language": "bash", "code": "mkdir pub-sub-demo && cd pub-sub-demo\nBASE=https://raw.githubusercontent.com/redis/docs/main/content/develop/use-cases/pub-sub/java-lettuce\ncurl -O $BASE/RedisPubSubHub.java\ncurl -O $BASE/DemoServer.java", "section_id": "get-the-source-files" }, { "id": "start-the-demo-server-ex0", "language": "bash", "code": "javac -cp 'lib/*' RedisPubSubHub.java DemoServer.java\njava -cp '.:lib/*' DemoServer --port 8099 --redis-host localhost --redis-port 6379", "section_id": "start-the-demo-server" }, { "id": "start-the-demo-server-ex1", "language": "text", "code": "Redis pub/sub demo server listening on http://127.0.0.1:8099\nUsing Redis at localhost:6379\nSeeded 3 default subscription(s)", "section_id": "start-the-demo-server" }, { "id": "inspect-pub-sub-state-directly-in-redis-ex0", "language": "bash", "code": "# Which channels currently have at least one exact-match subscriber?\nredis-cli pubsub channels '*'\n\n# How many subscribers does each channel have?\nredis-cli pubsub numsub orders:new notifications:billing chat:lobby\n\n# How many active pattern subscriptions across the whole server?\nredis-cli pubsub numpat\n\n# Subscribe interactively from the CLI to watch traffic on a pattern\nredis-cli psubscribe 'orders:*'", "section_id": "inspect-pub-sub-state-directly-in-redis" } ] }