io.github.ximutech.spore.SporeClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spore-spring-boot-starter Show documentation
spore-spring-boot-starter
The newest version!
package io.github.ximutech.spore;

import io.github.ximutech.spore.decoder.ErrorDecoder;
import io.github.ximutech.spore.okhttp.OkHttpClientRegistry;
import retrofit2.CallAdapter;
import retrofit2.Converter;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SporeClient {
    /**
     * 基础URL
     * 可以直接使用url
     * 也可以指定为属性键，例如：$ {propertyKey}
     * 如果baseUrl没有配置，则必须配置serviceId，path可选配置。
     *
     * @return 基础Url
     */
    String baseUrl() default "";
    /**
     * 服务id
     * 用于微服务之前的http调用
     * 可以指定为属性键，例如：$ {propertyKey}
     *
     * @return 服务id
     */
    String serviceId() default "";
    /**
     * 服务路径前缀
     *
     * @return 服务路径前缀
     */
    String path() default "";

    /*========= sourceOkHttpClient为空时超时时间才生效   ===========*/
    /**
     * 请求超时时间 单位:毫秒
     *
     * @return connectTimeoutMs
     */
    long connectTimeoutMs() default Constants.INVALID_TIMEOUT_VALUE;
    /**
     * 读取超时时间 单位:毫秒
     *
     * @return readTimeoutMs
     */
    long readTimeoutMs() default Constants.INVALID_TIMEOUT_VALUE;
    /**
     * 写入超时时间 单位:毫秒
     *
     * @return writeTimeoutMs
     */
    long writeTimeoutMs() default Constants.INVALID_TIMEOUT_VALUE;
    /**
     * 调用超时时间 单位:毫秒
     *
     * @return callTimeoutMs
     */
    long callTimeoutMs() default Constants.INVALID_TIMEOUT_VALUE;


    /**
     * OkHttpClient，根据该名称到#{@link OkHttpClientRegistry}查找对应的OkHttpClient来构建当前接口的OkhttpClient。
     *
     * @return okHttpClient
     */
    String okHttpClient() default "";

    /**
     * 是否提前验证Service接口方法
     *
     * @return validateEagerly
     */
    boolean validateEagerly() default false;

    /**
     * 当前接口采用的错误解码器，当请求发生异常或者收到无效响应结果的时候，将HTTP相关信息解码到异常中，无效响应由业务自己判断。
     * 一般情况下，每个服务对应的无效响应各不相同，可以自定义对应的{@link ErrorDecoder}，然后配置在这里。
     * 
     * The error decoder used in the current interface will decode HTTP related information into the exception when an exception occurs in the request or an invalid response result is received.
     * The invalid response is determined by the business itself.
     * In general, the invalid response corresponding to each service is different, you can customize the corresponding {@link ErrorDecoder}, and then configure it here.
     *
     * @return 错误解码器
     */
    Class errorDecoder() default ErrorDecoder.DefaultErrorDecoder.class;

    /**
     * 适用于当前接口的转换器工厂，优先级比全局转换器工厂更高。转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。
     * 

     * Converter factory for the current interface, higher priority than global converter factory.
     * The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.
     *
     * @return 转换器工厂
     */
    Class[] converterFactories() default {};

    /**
     * 适用于当前接口的调用适配器工厂，优先级比全局调用适配器工厂更高。转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。
     * 
     * callAdapter factory for the current interface, higher priority than global callAdapter factory.
     * The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.
     *
     * @return 调用适配器工厂
     */
    Class[] callAdapterFactories() default {};
}