rpc.turbo.annotation.TurboService Maven / Gradle / Ivy
package rpc.turbo.annotation;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* 服务接口声明，以及服务接口、方法配置，
* 当接口中包含公开的默认方法时自动注册为failover
* 所有public的方法返回值类型都必须为CompletableFuture.
*
* @author Hank
*
*/
@Documented
@Retention(RUNTIME)
@Target({ TYPE, METHOD })
public @interface TurboService {
public static final int DEFAULT_WEIGHT = 100;
public static final String DEFAULT_GROUP = "DEFAULT_GROUP";
public static final String DEFAULT_APP = "DEFAULT_APP";
public static final String DEFAULT_VERSION = "1.0.0";
public static final long DEFAULT_TIME_OUT = 5 * 1000L;
public static final boolean DEFAULT_IGNORE = false;
/**
* for METHOD and TYPE, RPC服务方法版本
* 仅第一位为实际使用，第一位不一样时表示是不兼容的方法调用
* method有则用method的，method没有则使用class的，都没有则使用默认值1.0.0
*
* @return
*/
String version();
/**
* for METHOD and TYPE, millseconds, 当等于-1时程序会自动处理为默认值5000
* method有则用method的，method没有则使用class的，class没有则使用默认值5000
*
* @return
*/
long timeout() default -1;
/**
* for METHOD and TYPE，忽略，不对外提供服务
*
* @return
*/
boolean ignore() default DEFAULT_IGNORE;
/**
*
* for METHOD and TYPE, 仅设置接口无效，只有Method上设置了才会启用,
* 支持GET、POST
*
*
* @RPCService(rest = "/user", version = "1.2.1")
* public class UserService {
*
* @RPCService(rest = "/create", version = "1.2.1")
* public CompletableFuture<Boolean> createUser(User user);
*
* @RPCService(rest = "/get", version = "2.2.1")
* public CompletableFuture<User> getUser(long id);
* }
*
*
* 通过HTTP GET http://host:port/group/app/user/get?v=2&id=1 请求;
* v=2必须为第一个参数，不能修改为?id=1&v=2;
*
* 通过HTTP POST http://host:port/group/app/user/get?v=2请求, body内容为{"id": 1}.
*
* @return
*/
String rest() default "";
}