程序包 org.springframework.cache.annotation

注释类型 CachePut

  • @Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@Documented
public @interface CachePut
    Annotation indicating that a method (or all methods on a class) triggers a cache put operation.

    In contrast to the @Cacheable annotation, this annotation does not cause the advised method to be skipped. Rather, it always causes the method to be invoked and its result to be stored in the associated cache. Note that Java8's Optional return types are automatically handled and its content is stored in the cache if present.

    This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.

    从以下版本开始:
    3.1
    作者:
    Costin Leau, Phillip Webb, Stephane Nicoll, Sam Brannen
    另请参阅:
    CacheConfig

      • cacheNames

        @AliasFor("value")
String[] cacheNames
        Names of the caches to use for the cache put operation.

        Names may be used to determine the target cache (or caches), matching the qualifier value or bean name of a specific bean definition.

        从以下版本开始:
        4.2
        另请参阅:
        value(), CacheConfig.cacheNames()
        默认值:
        {}

      • key

        String key
        Spring Expression Language (SpEL) expression for computing the key dynamically.

        Default is "", meaning all method parameters are considered as a key, unless a custom keyGenerator() has been set.

        The SpEL expression evaluates against a dedicated context that provides the following meta-data:

        • #result for a reference to the result of the method invocation. For supported wrappers such as Optional, #result refers to the actual object, not the wrapper
        • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
        • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
        • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
        默认值:
        ""

      • condition

        String condition
        Spring Expression Language (SpEL) expression used for making the cache put operation conditional.

        Default is "", meaning the method result is always cached.

        The SpEL expression evaluates against a dedicated context that provides the following meta-data:

        • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
        • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
        • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
        默认值:
        ""

      • unless

        String unless
        Spring Expression Language (SpEL) expression used to veto the cache put operation.

        Unlike condition(), this expression is evaluated after the method has been called and can therefore refer to the result.

        Default is "", meaning that caching is never vetoed.

        The SpEL expression evaluates against a dedicated context that provides the following meta-data:

        • #result for a reference to the result of the method invocation. For supported wrappers such as Optional, #result refers to the actual object, not the wrapper
        • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
        • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
        • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
        从以下版本开始:
        3.2
        默认值:
        ""