io.microsphere.spring.cache.annotation.TTLCachePut Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 io.microsphere.spring.cache.annotation;
import io.microsphere.spring.cache.intereptor.TTLCacheResolver;
import org.springframework.cache.annotation.CacheConfig;
import org.springframework.cache.annotation.CachePut;
import org.springframework.core.annotation.AliasFor;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;
/**
* {@link CachePut @CachePut} with TTL
*
* @author Mercy
* @since 1.0.0
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@CachePut(cacheResolver = TTLCacheResolver.BEAN_NAME)
public @interface TTLCachePut {
/**
* Alias for {@link #cacheNames}.
*/
@AliasFor(annotation = CachePut.class)
String[] value() default {};
/**
* Names of the caches in which method invocation results are stored.
* Names may be used to determine the target cache (or caches), matching
* the qualifier value or bean name of a specific bean definition.
*
* @see #value
* @see CacheConfig#cacheNames
* @since 4.2
*/
@AliasFor(annotation = CachePut.class)
String[] cacheNames() default {};
/**
* Spring Expression Language (SpEL) expression for computing the key dynamically.
*
Default is {@code ""}, meaning all method parameters are considered as a key,
* unless a custom {@link #keyGenerator} has been configured.
*
The SpEL expression evaluates against a dedicated context that provides the
* following meta-data:
*
* - {@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.
* - Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available.
*
- Method arguments can be accessed by index. For instance the second argument
* can be accessed via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments
* can also be accessed by name if that information is available.
*
*/
@AliasFor(annotation = CachePut.class)
String key() default "";
/**
* The bean name of the custom {@link org.springframework.cache.interceptor.KeyGenerator}
* to use.
* Mutually exclusive with the {@link #key} attribute.
*
* @see CacheConfig#keyGenerator
*/
@AliasFor(annotation = CachePut.class)
String keyGenerator() default "";
/**
* The bean names of the custom {@link org.springframework.cache.CacheManager}
*/
String[] cacheManagers() default {};
/**
* Spring Expression Language (SpEL) expression used for making the method
* caching conditional. Cache the result if the condition evaluates to
* {@code true}.
*
Default is {@code ""}, meaning the method result is always cached.
*
The SpEL expression evaluates against a dedicated context that provides the
* following meta-data:
*
* - {@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.
* - Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available.
*
- Method arguments can be accessed by index. For instance the second argument
* can be accessed via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments
* can also be accessed by name if that information is available.
*
*/
@AliasFor(annotation = CachePut.class)
String condition() default "";
/**
* Spring Expression Language (SpEL) expression used to veto method caching.
* Veto caching the result if the condition evaluates to {@code true}.
* Unlike {@link #condition}, this expression is evaluated after the method
* has been called and can therefore refer to the {@code result}.
*
Default is {@code ""}, meaning that caching is never vetoed.
*
The SpEL expression evaluates against a dedicated context that provides the
* following meta-data:
*
* - {@code #result} for a reference to the result of the method invocation. For
* supported wrappers such as {@code Optional}, {@code #result} refers to the actual
* object, not the wrapper
* - {@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.
* - Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available.
*
- Method arguments can be accessed by index. For instance the second argument
* can be accessed via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments
* can also be accessed by name if that information is available.
*
*
* @since 3.2
*/
@AliasFor(annotation = CachePut.class)
String unless() default "";
/**
* The expire time for cacheable entry
*/
long expire();
/**
* The {@link TimeUnit timeunit} of expire
*/
TimeUnit timeUnit() default TimeUnit.MILLISECONDS;
}