-
Notifications
You must be signed in to change notification settings - Fork 620
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GH-1455: AdviceChain on Stream Listener Container
Resolves #1455 Add an advice chain to the stream listener container and its factory. Add a `StreamMessageRecoverer` for native stream messages. Add a retry interceptor to work with native stream messages. **cherry-pick to 2.4.x** * Add since to new setter.
- Loading branch information
1 parent
9d49f20
commit bf32231
Showing
13 changed files
with
427 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
...-stream/src/main/java/org/springframework/rabbit/stream/retry/StreamMessageRecoverer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright 2022 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.rabbit.stream.retry; | ||
|
|
||
| import org.springframework.amqp.core.Message; | ||
| import org.springframework.amqp.rabbit.retry.MessageRecoverer; | ||
|
|
||
| import com.rabbitmq.stream.MessageHandler.Context; | ||
|
|
||
| /** | ||
| * Implementations of this interface can handle failed messages after retries are | ||
| * exhausted. | ||
| * | ||
| * @author Gary Russell | ||
| * @since 2.4.5 | ||
| * | ||
| */ | ||
| @FunctionalInterface | ||
| public interface StreamMessageRecoverer extends MessageRecoverer { | ||
|
|
||
| @Override | ||
| default void recover(Message message, Throwable cause) { | ||
| } | ||
|
|
||
| /** | ||
| * Callback for message that was consumed but failed all retry attempts. | ||
| * | ||
| * @param message the message to recover. | ||
| * @param context the context. | ||
| * @param cause the cause of the error. | ||
| */ | ||
| void recover(com.rabbitmq.stream.Message message, Context context, Throwable cause); | ||
|
|
||
| } |
79 changes: 79 additions & 0 deletions
79
.../org/springframework/rabbit/stream/retry/StreamRetryOperationsInterceptorFactoryBean.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * Copyright 2022 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.rabbit.stream.retry; | ||
|
|
||
| import org.springframework.amqp.rabbit.config.StatelessRetryOperationsInterceptorFactoryBean; | ||
| import org.springframework.amqp.rabbit.retry.MessageRecoverer; | ||
| import org.springframework.rabbit.stream.listener.StreamListenerContainer; | ||
| import org.springframework.retry.RetryOperations; | ||
| import org.springframework.retry.interceptor.MethodInvocationRecoverer; | ||
| import org.springframework.retry.support.RetryTemplate; | ||
|
|
||
| import com.rabbitmq.stream.Message; | ||
| import com.rabbitmq.stream.MessageHandler.Context; | ||
|
|
||
| /** | ||
| * Convenient factory bean for creating a stateless retry interceptor for use in a | ||
| * {@link StreamListenerContainer} when consuming native stream messages, giving you a | ||
| * large amount of control over the behavior of a container when a listener fails. To | ||
| * control the number of retry attempt or the backoff in between attempts, supply a | ||
| * customized {@link RetryTemplate}. Stateless retry is appropriate if your listener can | ||
| * be called repeatedly between failures with no side effects. The semantics of stateless | ||
| * retry mean that a listener exception is not propagated to the container until the retry | ||
| * attempts are exhausted. When the retry attempts are exhausted it can be processed using | ||
| * a {@link StreamMessageRecoverer} if one is provided. | ||
| * | ||
| * @author Gary Russell | ||
| * | ||
| * @see RetryOperations#execute(org.springframework.retry.RetryCallback,org.springframework.retry.RecoveryCallback) | ||
| */ | ||
| public class StreamRetryOperationsInterceptorFactoryBean extends StatelessRetryOperationsInterceptorFactoryBean { | ||
|
|
||
| @Override | ||
| protected MethodInvocationRecoverer<?> createRecoverer() { | ||
| return (args, cause) -> { | ||
| StreamMessageRecoverer messageRecoverer = (StreamMessageRecoverer) getMessageRecoverer(); | ||
| Object arg = args[0]; | ||
| if (arg instanceof org.springframework.amqp.core.Message) { | ||
| return super.recover(args, cause); | ||
| } | ||
| else { | ||
| if (messageRecoverer == null) { | ||
| this.logger.warn("Message(s) dropped on recovery: " + arg, cause); | ||
| } | ||
| else { | ||
| messageRecoverer.recover((Message) arg, (Context) args[1], cause); | ||
| } | ||
| return null; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Set a {@link StreamMessageRecoverer} to call when retries are exhausted. | ||
| * @param messageRecoverer the recoverer. | ||
| */ | ||
| public void setStreamMessageRecoverer(StreamMessageRecoverer messageRecoverer) { | ||
| super.setMessageRecoverer(messageRecoverer); | ||
| } | ||
|
|
||
| @Override | ||
| public void setMessageRecoverer(MessageRecoverer messageRecoverer) { | ||
| throw new UnsupportedOperationException("Use setStreamMessageRecoverer() instead"); | ||
| } | ||
|
|
||
| } |
4 changes: 4 additions & 0 deletions
4
spring-rabbit-stream/src/main/java/org/springframework/rabbit/stream/retry/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /** | ||
| * Provides classes supporting retries. | ||
| */ | ||
| package org.springframework.rabbit.stream.retry; |
Oops, something went wrong.