package com.jarvis.cache.annotation;

import com.jarvis.cache.type.CacheOpType;

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;

/**
 * 缓存注解
 *
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
@Documented
public @interface Cache {

    /**
     * 魔术模式
     *
     * @return Magic
     */
    Magic magic() default @Magic(key = "");

    /**
     * 缓存的过期时间，单位：秒，如果为0则表示永久缓存
     *
     * @return 时间
     */
    int expire();

    /**
     * 动态获取缓存过期时间的表达式，当其执行结果为null或小于0的整数时，会使用expire
     *
     * @return 时间
     */
    String expireExpression() default "";

    /**
     * 预警自动刷新时间(单位：秒)，必须满足 0 < alarmTime < expire才有效 当缓存在alarmTime
     * 时间内即将过期的话，会自动刷新缓存内容；
     *
     * @return 时间
     */
    int alarmTime() default 0;

    /**
     * 自定义缓存Key，支持表达式
     *
     * @return String 自定义缓存Key
     */
    String key();

    /**
     * 设置哈希表中的字段，如果设置此项，则用哈希表进行存储，支持表达式
     *
     * @return String
     */
    String hfield() default "";

    /**
     * 是否启用自动加载缓存， 缓存时间必须大于120秒时才有效
     * 如果magic为true时，会强制关闭自动加载功能
     *
     * @return boolean
     */
    boolean autoload() default false;

    /**
     * 是否总是缓存（常驻内存）
     *       默认不开启;
     *       如果开启则缓存的有效期为永久,高频/低频/后台刷新异常则均不影响缓存的生命周期
     * @return boolean
     */
    boolean alwaysCache() default false;

    /**
     * 自动缓存的条件，可以为空，返回 true 或者 false，如果设置了此值，autoload() 就失效，例如：null !=
     * #args[0].keyword，当第一个参数的keyword属性为null时设置为自动加载。
     *
     * @return String 表达式
     */
    String autoloadCondition() default "";

    /**
     * 当autoload为true时，缓存数据在 requestTimeout
     * 秒之内没有使用了，就不进行自动加载数据,如果requestTimeout为0时，会一直自动加载
     *
     * @return long 请求过期
     */
    long requestTimeout() default 36000L;

    /**
     * 缓存的条件表达式，可以为空，返回 true 或者 false，只有为 true 才进行缓存
     *
     * @return String
     */
    String condition() default "";

    /**
     * 缓存的操作类型：默认是READ_WRITE，先缓存取数据，如果没有数据则从DAO中获取并写入缓存；如果是WRITE则从DAO取完数据后，写入缓存
     *
     * @return CacheOpType
     */
    CacheOpType opType() default CacheOpType.READ_WRITE;

    /**
     * 并发等待时间(毫秒),等待正在DAO中加载数据的线程返回的等待时间。
     *
     * @return 时间
     */
    int waitTimeOut() default 500;

    /**
     * 扩展缓存
     *
     * @return ExCache[]
     */
    ExCache[] exCache() default @ExCache(expire = -1, key = "");

    /**
     * 分布式锁的缓存时间（单位：秒），在设置分布式锁的前提下，如果此项值大于0，则会使用分布式锁，如果小于等于0，则不会使用分布式锁。
     *
     * @return 分布式锁的缓存时间
     */
    int lockExpire() default 10;

    /**
     * 是否开启锁降级
     *      默认不开启;
     *      如果开启，当分布式锁抛异常时不使用分布式锁
     */
    boolean openLockDown() default false;

    /**
     * 是否打开对参数进行深度复制,默认是true,是为了避免外部改变参数值。如果确保不被修改，最好是设置为false,这样性能会更高。
     *
     * @return 是否打开对参数进行深度复制
     */
    boolean argumentsDeepCloneEnable() default true;

    /**
     * 拿来主义是通过本地缓存实现的，如果要修改数据，需要对返回值进行深度复制
     * @return
     */
    boolean resultDeepCloneEnable() default true;
}