com.github.df.restypass.annotation.RestyService Maven / Gradle / Ivy

Go to download
package com.github.df.restypass.annotation;

import com.github.df.restypass.lb.LoadBalancer;
import com.github.df.restypass.lb.RoundRobinLoadBalancer;

import java.lang.annotation.*;

/**
 * 标注为RestyService的注解
 * Created by darrenfu on 17-6-20.
 */
@SuppressWarnings("unused")
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface RestyService {

    /**
     * 服务名称
     */
    String serviceName() default "";

    /**
     * 降级服务类
     * 优先级低于降级服务Bean：fallbackBean
     */
    Class fallbackClass() default Noop.class;

    /**
     * 降级服务bean的名称（Spring管理的Bean）
     * 优先级高于降级服务类:fallbackClass
     */
    String fallbackBean() default "";

    /**
     * 降级服务是否启用
     * 默认启用
     */
    boolean fallbackEnabled() default true;

    /**
     * 失败后是否重试
     * 默认重试一次
     */
    int retry() default 1;

    /**
     * 断路器是否启用
     * 默认启用
     */
    boolean circuitBreakEnabled() default true;

    /**
     * 是否强制短路
     * 默认false
     */
    boolean forceBreakEnabled() default false;


    /**
     * 负载均衡器
     * 负载均衡应该是函数式，无状态，无依赖
     */
    Class loadBalancer() default RoundRobinLoadBalancer.class;


    /**
     * 流量限制  允许的每秒请求数
     * -1无限制
     */
    int limit() default -1;


    /**
     * 连接超时时间 ms
     */
    int connectTimeout() default 5000;

    /**
     * 响应请求超时时间 ms
     */
    int requestTimeout() default 60000;

    //TODO: Factory 配置
//  非Spring环境则可自定义工厂类实现组件定制
//    Class factory() default DefaultRestyPassFactory.class;

    /**
     * 路由版本
     */
    String[] version() default "";


    /**
     * 啥也不干的类
     */
    class Noop {
        public static Noop noop = new Noop();
    }
}