-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for
CacheRequestHandlerAdvice
* Fix `AbstractMessageProcessingTransformer` to react for the `AbstractIntegrationMessageBuilder` invocation result and don't wrap it into the `Message` * Demonstrate functionality in the `CacheRequestHandlerAdviceTests`
- Loading branch information
1 parent
06d3213
commit 44139fb
Showing
3 changed files
with
424 additions
and
2 deletions.
There are no files selected for viewing
267 changes: 267 additions & 0 deletions
267
...c/main/java/org/springframework/integration/handler/advice/CacheRequestHandlerAdvice.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,267 @@ | ||
/* | ||
* Copyright 2019 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 | ||
* | ||
* http://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.integration.handler.advice; | ||
|
||
import java.lang.reflect.Method; | ||
import java.util.ArrayList; | ||
import java.util.Arrays; | ||
import java.util.List; | ||
import java.util.function.Function; | ||
import java.util.stream.Collectors; | ||
|
||
import org.springframework.beans.factory.SmartInitializingSingleton; | ||
import org.springframework.cache.CacheManager; | ||
import org.springframework.cache.interceptor.CacheAspectSupport; | ||
import org.springframework.cache.interceptor.CacheErrorHandler; | ||
import org.springframework.cache.interceptor.CacheEvictOperation; | ||
import org.springframework.cache.interceptor.CacheOperation; | ||
import org.springframework.cache.interceptor.CacheOperationInvoker; | ||
import org.springframework.cache.interceptor.CachePutOperation; | ||
import org.springframework.cache.interceptor.CacheResolver; | ||
import org.springframework.cache.interceptor.CacheableOperation; | ||
import org.springframework.expression.EvaluationContext; | ||
import org.springframework.expression.Expression; | ||
import org.springframework.integration.expression.ExpressionUtils; | ||
import org.springframework.integration.expression.FunctionExpression; | ||
import org.springframework.integration.handler.AbstractReplyProducingMessageHandler; | ||
import org.springframework.integration.support.AbstractIntegrationMessageBuilder; | ||
import org.springframework.lang.Nullable; | ||
import org.springframework.messaging.Message; | ||
import org.springframework.util.Assert; | ||
import org.springframework.util.ObjectUtils; | ||
import org.springframework.util.ReflectionUtils; | ||
|
||
/** | ||
* The {@link AbstractRequestHandlerAdvice} implementation for caching | ||
* {@link AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)} results. | ||
* Supports all the cache operations - cacheable, put, evict. | ||
* By default only cacheable is applied for the provided {@code cacheNames}. | ||
* The default cache {@code key} is {@code payload} of the request message. | ||
* | ||
* @author Artem Bilan | ||
* | ||
* @since 5.2 | ||
* | ||
* @see AbstractReplyProducingMessageHandler.RequestHandler | ||
* @see CacheAspectSupport | ||
* @see CacheOperation | ||
*/ | ||
public class CacheRequestHandlerAdvice extends AbstractRequestHandlerAdvice | ||
implements SmartInitializingSingleton { | ||
|
||
private static final Method HANDLE_REQUEST_METHOD = | ||
ReflectionUtils.findMethod(AbstractReplyProducingMessageHandler.RequestHandler.class, | ||
"handleRequestMessage", Message.class); | ||
|
||
private final IntegrationCacheAspect delegate = new IntegrationCacheAspect(); | ||
|
||
private final String[] cacheNames; | ||
|
||
private final List<CacheOperation> cacheOperations = new ArrayList<>(); | ||
|
||
private Expression keyExpression = new FunctionExpression<Message<?>>(Message::getPayload); | ||
|
||
/** | ||
* Create a {@link CacheRequestHandlerAdvice} instance based on the provided name of caches | ||
* and {@link CacheableOperation} as default one. | ||
* This can be overridden by the {@link #setCacheOperations}. | ||
* @param cacheNames the name of caches to use in the advice. | ||
* @see #setCacheOperations | ||
*/ | ||
public CacheRequestHandlerAdvice(String... cacheNames) { | ||
this.cacheNames = cacheNames; | ||
CacheableOperation.Builder builder = new CacheableOperation.Builder(); | ||
builder.setName(toString()); | ||
this.cacheOperations.add(builder.build()); | ||
} | ||
|
||
/** | ||
* Configure a set of {@link CacheOperation} which are going to be applied to the | ||
* {@link AbstractReplyProducingMessageHandler.RequestHandler#handleRequestMessage(Message)} | ||
* method via {@link IntegrationCacheAspect}. | ||
* This is similar to the technique provided by the | ||
* {@link org.springframework.cache.annotation.Caching} annotation. | ||
* @param cacheOperations the array of {@link CacheOperation} to use. | ||
* @see org.springframework.cache.annotation.Caching | ||
*/ | ||
public void setCacheOperations(CacheOperation... cacheOperations) { | ||
Assert.notEmpty(cacheOperations, "'cacheOperations' must not be empty"); | ||
Assert.notNull(cacheOperations, "'cacheOperations' must not be null"); | ||
this.cacheOperations.clear(); | ||
this.cacheOperations.addAll(Arrays.asList(cacheOperations)); | ||
} | ||
|
||
/** | ||
* Configure a common {@link CacheManager} if some {@link CacheOperation} comes without it. | ||
* See {@link org.springframework.cache.annotation.CacheConfig} annotation for similar approach. | ||
* @param cacheManager the {@link CacheManager} to use. | ||
* @see org.springframework.cache.annotation.CacheConfig | ||
*/ | ||
public void setCacheManager(CacheManager cacheManager) { | ||
this.delegate.setCacheManager(cacheManager); | ||
} | ||
|
||
/** | ||
* Configure a common {@link CacheResolver} if some {@link CacheOperation} comes without it. | ||
* See {@link org.springframework.cache.annotation.CacheConfig} for similar approach. | ||
* @param cacheResolver the {@link CacheResolver} to use. | ||
* @see org.springframework.cache.annotation.CacheConfig | ||
*/ | ||
public void setCacheResolver(CacheResolver cacheResolver) { | ||
this.delegate.setCacheResolver(cacheResolver); | ||
} | ||
|
||
/** | ||
* Set the {@link CacheErrorHandler} instance to use to handle errors | ||
* thrown by the cache provider. | ||
* @see CacheAspectSupport#setErrorHandler(CacheErrorHandler) | ||
*/ | ||
public void setErrorHandler(CacheErrorHandler errorHandler) { | ||
Assert.notNull(errorHandler, "'errorHandler' must not be null"); | ||
this.delegate.setErrorHandler(errorHandler); | ||
} | ||
|
||
/** | ||
* Configure an expression in SpEL style to evaluate a cache key at runtime | ||
* against a request message. | ||
* @param keyExpression the expression to use for cache key generation. | ||
*/ | ||
public void setKeyExpressionString(String keyExpression) { | ||
Assert.hasText(keyExpression, "'keyExpression' must not be empty"); | ||
setKeyExpression(EXPRESSION_PARSER.parseExpression(keyExpression)); | ||
} | ||
|
||
/** | ||
* Configure a {@link Function} to evaluate a cache key at runtime | ||
* against a request message. | ||
* @param keyFunction the {@link Function} to use for cache key generation. | ||
*/ | ||
public void setKeyFunction(Function<Message<?>, ?> keyFunction) { | ||
Assert.notNull(keyFunction, "'keyFunction' must not be null"); | ||
setKeyExpression(new FunctionExpression<>(keyFunction)); | ||
} | ||
|
||
/** | ||
* Configure a SpEL expression to evaluate a cache key at runtime | ||
* against a request message. | ||
* @param keyExpression the expression to use for cache key generation. | ||
*/ | ||
public void setKeyExpression(Expression keyExpression) { | ||
Assert.notNull(keyExpression, "'keyExpression' must not be null"); | ||
this.keyExpression = keyExpression; | ||
} | ||
|
||
|
||
@Override | ||
public void afterSingletonsInstantiated() { | ||
this.delegate.afterSingletonsInstantiated(); | ||
} | ||
|
||
@Override | ||
protected void onInit() { | ||
List<CacheOperation> cacheOperations; | ||
if (!ObjectUtils.isEmpty(this.cacheNames)) { | ||
cacheOperations = this.cacheOperations.stream() | ||
.filter((operation) -> ObjectUtils.isEmpty(operation.getCacheNames())) | ||
.map((operation) -> { | ||
CacheOperation.Builder builder; | ||
if (operation instanceof CacheableOperation) { | ||
CacheableOperation cacheableOperation = (CacheableOperation) operation; | ||
CacheableOperation.Builder cacheableBuilder = new CacheableOperation.Builder(); | ||
cacheableBuilder.setSync(cacheableOperation.isSync()); | ||
String unless = cacheableOperation.getUnless(); | ||
if (unless != null) { | ||
cacheableBuilder.setUnless(unless); | ||
} | ||
builder = cacheableBuilder; | ||
} | ||
else if (operation instanceof CacheEvictOperation) { | ||
CacheEvictOperation.Builder cacheEvictBuilder = new CacheEvictOperation.Builder(); | ||
CacheEvictOperation cacheEvictOperation = (CacheEvictOperation) operation; | ||
cacheEvictBuilder.setBeforeInvocation(cacheEvictOperation.isBeforeInvocation()); | ||
cacheEvictBuilder.setCacheWide(cacheEvictOperation.isCacheWide()); | ||
builder = cacheEvictBuilder; | ||
} | ||
else { | ||
CachePutOperation cachePutOperation = (CachePutOperation) operation; | ||
CachePutOperation.Builder cachePutBuilder = new CachePutOperation.Builder(); | ||
String unless = cachePutOperation.getUnless(); | ||
if (unless != null) { | ||
cachePutBuilder.setUnless(unless); | ||
} | ||
builder = cachePutBuilder; | ||
} | ||
|
||
builder.setName(operation.getName()); | ||
builder.setCacheManager(operation.getCacheManager()); | ||
builder.setCacheNames(this.cacheNames); | ||
builder.setCacheResolver(operation.getCacheResolver()); | ||
builder.setCondition(operation.getCondition()); | ||
builder.setKey(operation.getKey()); | ||
builder.setKeyGenerator(operation.getKeyGenerator()); | ||
return builder.build(); | ||
}) | ||
.collect(Collectors.toList()); | ||
} | ||
else { | ||
cacheOperations = this.cacheOperations; | ||
} | ||
|
||
this.delegate.setBeanFactory(getBeanFactory()); | ||
EvaluationContext evaluationContext = ExpressionUtils.createStandardEvaluationContext(getBeanFactory()); | ||
this.delegate.setKeyGenerator((target, method, params) -> | ||
this.keyExpression.getValue(evaluationContext, params[0])); // NOSONAR | ||
this.delegate.setCacheOperationSources((method, targetClass) -> cacheOperations); | ||
this.delegate.afterPropertiesSet(); | ||
|
||
} | ||
|
||
@Nullable | ||
@Override | ||
protected Object doInvoke(ExecutionCallback callback, Object target, Message<?> message) { | ||
CacheOperationInvoker operationInvoker = | ||
() -> { | ||
|
||
Object result = callback.execute(); | ||
// Drop MessageBuilder optimization in favor of Serializable support in cache implementation. | ||
if (result instanceof AbstractIntegrationMessageBuilder<?>) { | ||
return ((AbstractIntegrationMessageBuilder<?>) result).build(); | ||
} | ||
else { | ||
return result; | ||
} | ||
|
||
}; | ||
|
||
return this.delegate.execute(operationInvoker, target, HANDLE_REQUEST_METHOD, // NOSONAR | ||
new Object[] { message }); | ||
} | ||
|
||
private static class IntegrationCacheAspect extends CacheAspectSupport { | ||
|
||
IntegrationCacheAspect() { | ||
} | ||
|
||
@Nullable | ||
@Override | ||
public Object execute(CacheOperationInvoker invoker, Object target, Method method, Object[] args) { | ||
return super.execute(invoker, target, method, args); | ||
} | ||
|
||
} | ||
|
||
} |
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
Oops, something went wrong.