Package icu.easyj.web.cache304.annotation

Annotation Interface Cache304

@Retention(RUNTIME) @Target({TYPE,METHOD}) @Documented public @interface Cache304
304缓存注解
Author:
wangliang181230
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    cacheDays
    缓存天数 说明：缓存有效天数，有效时间延长至24点失效，也就是该缓存是以天为单位做缓存，不跨天。
    例子：1=今天晚上24失效；2=明天晚上24点失效。
    优先级：该配置优先级比value高，cacheDays > 0时才生效
    long
    cacheSeconds
    缓存有效时间
    单位：秒
    说明：当 value <= 0 时，使用默认值：1天
    同义于：value()
    long
    limitMaxAge
    限制`maxAge`的值，避免服务端因为设置错误，设置了一个非常大的值，导致客户端缓存过久，使得这些用户一直读取着错误的缓存。
    设置了上限值后，单个客户端每过半天会有一个请求发送到服务端，由服务端决定是否响应304，并继续延续半天客户端缓存。
    boolean
    useCacheIfException
    为true时：如果controller出现异常，但客户端存在缓存，则响应304，让客户端继续使用缓存。
    boolean
    useMaxAge
    响应头中是否使用“Cache-Control: max-age=xxx”
    值域：true=是|false=否
    Cache-Control响应头是告诉客户端该缓存的有效时间，单位：秒
    在缓存有效时间内，客户端甚至不会发送已缓存的请求。所以，建议设置为true
    某些特殊请求，如果想要由服务器端控制其304缓存机制，才需要设置为false
    long
    value
    缓存有效时间
    单位：秒
    说明：当 value <= 0 时，使用默认值：1天
    同义于：cacheSeconds()

  • Element Details

    • value

      @AliasFor("cacheSeconds") long value
      缓存有效时间
      单位：秒
      说明：当 value <= 0 时，使用默认值：1天
      同义于：cacheSeconds()
      Returns:
      cacheSeconds 缓存秒数
      Default:
      -1L

    • cacheSeconds

      @AliasFor("value") long cacheSeconds
      缓存有效时间
      单位：秒
      说明：当 value <= 0 时，使用默认值：1天
      同义于：value()
      Returns:
      cacheSeconds 缓存秒数
      Default:
      -1L

    • cacheDays

      int cacheDays
      缓存天数 说明：缓存有效天数，有效时间延长至24点失效，也就是该缓存是以天为单位做缓存，不跨天。
      例子：1=今天晚上24失效；2=明天晚上24点失效。
      优先级：该配置优先级比value高，cacheDays > 0时才生效
      Returns:
      cacheDays 缓存天数
      Default:
      -1

    • useMaxAge

      boolean useMaxAge
      响应头中是否使用“Cache-Control: max-age=xxx”
      值域：true=是|false=否
      Cache-Control响应头是告诉客户端该缓存的有效时间，单位：秒
      在缓存有效时间内，客户端甚至不会发送已缓存的请求。所以，建议设置为true
      某些特殊请求，如果想要由服务器端控制其304缓存机制，才需要设置为false
      Returns:
      useMaxAge 是否使用`Cache-Control:max-age`响应头
      Default:
      true

    • limitMaxAge

      long limitMaxAge
      限制`maxAge`的值，避免服务端因为设置错误，设置了一个非常大的值，导致客户端缓存过久，使得这些用户一直读取着错误的缓存。
      设置了上限值后，单个客户端每过半天会有一个请求发送到服务端，由服务端决定是否响应304，并继续延续半天客户端缓存。
      Returns:
      limitMaxAge maxAge上限值
      Default:
      -1L

    • useCacheIfException

      boolean useCacheIfException
      为true时：如果controller出现异常，但客户端存在缓存，则响应304，让客户端继续使用缓存。
      Returns:
      useCacheIfException 异常时是否响应304
      Default:
      false