Проект spring-boot объединяет лучшие практики Retrofit, самый элегантный клиентский инструмент HTTP!

все знаютokhttpэтоsquareкомпания с открытым исходным кодомjavaВерсияhttpКлиентские инструменты. По факту,squareКомпания также открыла исходный кодokhttpдополнительно инкапсулированныйretrofitинструменты дляподдержка через接口способ инициироватьhttpпросить.Если вы все еще используете его непосредственно в своем проектеRestTemplateилиokhttpили на основе того, что они инкапсулируютHttpUtils, то вы можете попробовать использоватьRetrofit.

retrofit-spring-boot-starterДостигнутоRetrofitиspring-bootФреймворк быстро интегрируется и поддерживает некоторые функциональные улучшения, что значительно упрощаетspring-bootпод проектhttpРазработка вызова интерфейса. Далее проходим непосредственно черезretrofit-spring-boot-starter,приди и посмотриspring-bootотправка проектаhttpНасколько прост запрос.

retrofitЧиновник не предоставилspring-bootбыстрая интеграцияstarter.retrofit-spring-boot-starterОн упакован автором, используется в производственной среде и очень стабилен.Колёса сделать не просто, прошу вас, ребята, звёздитесь.

Исходный код проекта:retrofit-spring-boot-starter

импортировать зависимости

<dependency>
    <groupId>com.github.lianjiatech</groupId>
    <artifactId>retrofit-spring-boot-starter</artifactId>
    <version>2.0.2</version>
</dependency>

настроить`@RetrofitScan`аннотация

Вы можете дать@Configurationконфигурация класса@RetrofitScan, или настроить непосредственно наspring-bootв классе запуска следующим образом:

@SpringBootApplication
@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
public class RetrofitTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(RetrofitTestApplication.class, args);
    }
}

определить http-интерфейс

должен использоваться интерфейс@RetrofitClientТег аннотации! Для получения информации, связанной с http, обратитесь к официальной документации:Официальная документация по обновлению.

@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

вводить с помощью

Внедрить интерфейс в другие сервисы для использования.

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

    public void test() {
        // 通过httpApi发起http请求
    }
}

Пока вы проходите вышеуказанные шаги, вы можете добиться отправки через интерфейсhttpЗапросил, это действительно просто. если тыspring-bootиспользуется в проектеmybatis, я полагаю, что вы будете более знакомы с этим использованием. Далее продолжаем знакомитьretrofit-spring-boot-starterБолее продвинутые функции.

Аннотированные перехватчики

Много раз мы хотим, чтобы некоторые http-запросы под определенным интерфейсом выполняли унифицированную логику обработки перехвата. Можно использовать в это времяАннотированные перехватчики. Используемые шаги в основном делятся на 2 этапа:

наследоватьBasePathMatchInterceptorНаписать обработчик перехвата;
используется в интерфейсе@InterceptЭтикетка.

Ниже сВставьте временную метку за указанным URL-адресом запроса.В качестве примера мы покажем, как использовать аннотированные перехватчики.

наследовать`BasePathMatchInterceptor`Написать обработчик перехвата

@Component
public class TimeStampInterceptor extends BasePathMatchInterceptor {

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl url = request.url();
        long timestamp = System.currentTimeMillis();
        HttpUrl newUrl = url.newBuilder()
                .addQueryParameter("timestamp", String.valueOf(timestamp))
                .build();
        Request newRequest = request.newBuilder()
                .url(newUrl)
                .build();
        return chain.proceed(newRequest);
    }
}

используется в интерфейсе`@Intercept`метка

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

выше@InterceptПредставление конфигурации: InterceptHttpApiпод интерфейсом/api/**по пути (исключить/api/test/savePerson) запросы, обработчик перехвата используетTimeStampInterceptor.

Расширенный аннотированный перехватчик

Иногда нам нужноАннотация перехватаДинамически передавать некоторые параметры, а затем использовать этот параметр при выполнении перехвата. На данный момент мы можем расширить реализациюПользовательская аннотация перехвата.自定义拦截注解должен использовать@InterceptMarkотметка иПримечания должны включатьinclude()、exclude()、handler()атрибутивная информация. Используемые шаги в основном делятся на 3 этапа:

Пользовательская аннотация перехвата
наследоватьBasePathMatchInterceptorНаписать обработчик перехвата
Используйте пользовательские аннотации перехвата на интерфейсах;

Например, нам нужноДинамически добавить в заголовок запросаaccessKeyId,accessKeySecretИнформация о подписи может инициировать HTTP-запросы в обычном режиме., в настоящее время вы можете ** настроить аннотацию подписанного перехватчика@Sign**реализовать. Ниже для настройки@SignАннотация перехвата используется в качестве примера для иллюстрации.

настроить`@Sign`аннотация

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {
    /**
     * 密钥key
     * 支持占位符形式配置。
     *
     * @return
     */
    String accessKeyId();

    /**
     * 密钥
     * 支持占位符形式配置。
     *
     * @return
     */
    String accessKeySecret();

    /**
     * 拦截器匹配路径
     *
     * @return
     */
    String[] include() default {"/**"};

    /**
     * 拦截器排除匹配，排除指定路径拦截
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * 处理该注解的拦截器类
     * 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

расширять自定义拦截注解Следует отметить 2 момента:

自定义拦截注解должен использовать@InterceptMarkотметка.
Примечания должны включатьinclude()、exclude()、handler()информация о собственности.

выполнить`SignInterceptor`

@Component
public class SignInterceptor extends BasePathMatchInterceptor {

    private String accessKeyId;

    private String accessKeySecret;

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("accessKeyId", accessKeyId)
                .addHeader("accessKeySecret", accessKeySecret)
                .build();
        return chain.proceed(newReq);
    }
}

вышесказанноеaccessKeyIdиaccessKeySecretЗначения полей будут основаны на@SignаннотированныйaccessKeyId()иaccessKeySecret()значение автоматически вводится, если@SignЕсли указанная строка имеет форму заполнителя, значение свойства конфигурации будет взято для внедрения.. Кроме того,accessKeyIdиaccessKeySecretПоле должно быть предоставленоsetterметод.

используется в интерфейсе`@Sign`

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

Таким образом, информация о подписи может быть автоматически добавлена к запросу указанного URL-адреса.

Управление пулом соединений

По умолчанию всеRetrofitОтправленный http-запрос будет использоватьmax-idle-connections=5 keep-alive-second=300Пул соединений по умолчанию для . Конечно, мы также можем настроить несколько пользовательских пулов соединений в файле конфигурации, а затем передать@RetrofitClientизpoolNameатрибут для указания использования. Например, мы хотим использовать все запросы под интерфейсомpoolName=test1Пул соединений, код реализован следующим образом:

Настройте пул соединений.

retrofit:
    # 连接池配置
    pool:
        test1:
        max-idle-connections: 3
        keep-alive-second: 100
        test2:
        max-idle-connections: 5
        keep-alive-second: 50

пройти через@RetrofitClientизpoolNameсвойство, чтобы указать используемый пул соединений.

@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

печать журнала

Во многих случаях мы хотим регистрировать http-запросы. пройти через@RetrofitClientизlogLevelиlogStrategyможно указать уровень печати журнала и политику печати журнала для каждого интерфейса.retrofit-spring-boot-starterПоддерживается 5 уровней печати журнала (ERROR, WARN, INFO, DEBUG, TRACE),дефолтINFO; поддерживает 4 стратегии печати журнала (NONE, BASIC, HEADERS, BODY),дефолтBASIC. Значения четырех стратегий печати журнала следующие:

NONE: Нет логов.
BASIC: Регистрирует строки запроса и ответа.
HEADERS: регистрирует строки запросов и ответов и их соответствующие заголовки.
BODY: регистрирует строки запросов и ответов, а также их соответствующие заголовки и тела (если они есть).

retrofit-spring-boot-starterиспользуется по умолчаниюDefaultLoggingInterceptorВыполните настоящую функцию печати журнала, нижний слойokhttpоригинальныйHttpLoggingInterceptor. Конечно, вы также можете настроить и реализовать свой собственный перехватчик печати журнала, просто унаследовавBaseLoggingInterceptor(Подробнее см.DefaultLoggingInterceptorреализации), а затем настроить его в файле конфигурации.

retrofit:
  # 日志打印拦截器
  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor

Средство форматирования сообщений об исключениях HTTP

Когда возникает исключение HTTP-запроса, исходная информация об исключении может быть неудобна для чтения, поэтомуretrofit-spring-boot-starterпри условииHttp异常信息格式化器, используется для украшения выходных параметров HTTP-запроса, используется по умолчаниюDefaultHttpExceptionMessageFormatterОтформатируйте данные запроса. Вы также можете настроить его, просто наследуяBaseHttpExceptionMessageFormatter, а затем выполните соответствующую настройку.

retrofit:
  # Http异常信息格式化器
  http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter

Адаптер вызова CallAdapter

RetrofitАдаптер может быть вызванCallAdapterFactoryбудетCall<T>Объект адаптирован к возвращаемому типу метода интерфейса.retrofit-spring-boot-starterРазвернуть 2 видаCallAdapterFactoryвыполнить:

BodyCallAdapterFactory
- Включено по умолчанию и может быть настроеноretrofit.enable-body-call-adapter=falseзакрытие
- Выполните HTTP-запрос синхронно и адаптируйте содержимое тела ответа к экземпляру типа возвращаемого значения метода интерфейса.
- КромеRetrofit.Call<T>,Retrofit.Response<T>,java.util.concurrent.CompletableFuture<T>Кроме того, этот адаптер могут использовать другие типы возврата.
ResponseCallAdapterFactory
- Включено по умолчанию и может быть настроеноretrofit.enable-response-call-adapter=falseзакрытие
- Синхронно выполните HTTP-запрос и адаптируйте содержимое тела ответа кRetrofit.Response<T>возвращение.
- Если возвращаемый тип методаRetrofit.Response<T>, вы можете использовать адаптер.

Retrofit автоматически выбирает соответствующий метод на основе типа возвращаемого значения метода.CallAdapterFactoryВыполните процесс адаптации! Плюс дооснащение по умолчаниюCallAdapterFactory, который поддерживает различные формы типов возвращаемых значений метода:

Call<T>: Возврат напрямую без выполнения обработки адаптацииCall<T>объект
CompletableFuture<T>: адаптировать содержимое тела ответа кCompletableFuture<T>возврат объекта
Void: не обращайте внимания на возвращаемый тип, можно использоватьVoid. Если код состояния http не равен 2xx, выдайте ошибку напрямую!
Response<T>: адаптировать содержимое ответа кResponse<T>возврат объекта
Любой другой тип Java: адаптируйте содержимое тела ответа к соответствующему объекту типа Java и верните его.Если код состояния http не 2xx, выдайте ошибку напрямую!

    /**
     * Call<T>
     * 不执行适配处理，直接返回Call<T>对象
     * @param id
     * @return
     */
    @GET("person")
    Call<Result<Person>> getPersonCall(@Query("id") Long id);

    /**
     *  CompletableFuture<T>
     *  将响应体内容适配成CompletableFuture<T>对象返回
     * @param id
     * @return
     */
    @GET("person")
    CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);

    /**
     * Void
     * 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！
     * @param id
     * @return
     */
    @GET("person")
    Void getPersonVoid(@Query("id") Long id);

    /**
     *  Response<T>
     *  将响应内容适配成Response<T>对象返回
     * @param id
     * @return
     */
    @GET("person")
    Response<Result<Person>> getPersonResponse(@Query("id") Long id);

    /**
     * 其他任意Java类型
     * 将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！
     * @param id
     * @return
     */
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

Мы также можем наследоватьCallAdapter.FactoryРасширьте свои собственныеCallAdapter; тогда обычайCallAdapterFactoryнастроен какspringизbean!

пользовательская конфигурацияCallAdapter.Factoryболее высокий приоритет!

Преобразователь транскодера данных

RetrofiиспользоватьConverterбудет@BodyАннотированный объект преобразуется в тело запроса, а данные тела ответа преобразуются вJavaобъект, вы можете выбрать один из следующихConverter:

Gson: com.squareup.Retrofit:converter-gson
Jackson: com.squareup.Retrofit:converter-jackson
Moshi: com.squareup.Retrofit:converter-moshi
Protobuf: com.squareup.Retrofit:converter-protobuf
Wire: com.squareup.Retrofit:converter-wire
Simple XML: com.squareup.Retrofit:converter-simplexml

retrofit-spring-boot-starterПо умолчанию для преобразования сериализации используется jackson!Если вам нужно использовать другие методы сериализации, внесите в проект соответствующие зависимости, а затем поставьте соответствующиеConverterFactoryВы можете настроить его как Spring bean.

Мы также можем наследоватьConverter.FactoryРасширьте свои собственныеConverter; тогда обычайConverter.Factoryнастроен какspringизbean!

пользовательская конфигурацияConverter.Factoryболее высокий приоритет!

Глобальный перехватчик BaseGlobalInterceptor

Если нам нужно выполнить унифицированную обработку перехвата на http запросах всей системы, мы можем настроить реализацию глобального перехватчикаBaseGlobalInterceptor, и настроен какspringсерединаbean! Например, нам нужно вывести исходную информацию на http-запросы, инициированные по всей системе.

@Component
public class SourceInterceptor extends BaseGlobalInterceptor {
    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("source", "test")
                .build();
        return chain.proceed(newReq);
    }
}

Эпилог

На данный момент внедрение самого изящного http-клиента в рамках проекта spring-boot завершено, более подробную информацию можно найти в официальной документации:retrofitа такжеretrofit-spring-boot-starter. Интерпретацию принципа реализации можно посмотретьРеализуйте свой собственный облегченный инструмент HTTP-вызовов на основе Retrofit..

Нелегко быть оригинальным. Если вы считаете, что статья написана хорошо, пожалуйста, поставьте лайк 👍 и поддержите ее~

Добро пожаловать в мой проект с открытым исходным кодом:Облегченная среда вызовов HTTP для SpringBoot