【开源项目】Springboot整合Retrofit入门及源码分析

秋装什么

已于 2022-12-30 09:48:55 修改

阅读量263

点赞数

分类专栏：开源项目介绍文章标签： spring boot 开源 retrofit

于 2022-12-24 15:52:52 首次发布

本文链接：https://blog.csdn.net/qq_42985872/article/details/128429044

版权

开源项目介绍专栏收录该内容

53 篇文章 8 订阅

订阅专栏

Springboot整合Retrofit入门及源码分析

项目介绍

retrofit-spring-boot-starter实现了Retrofit与SpringBoot框架快速整合，并且支持了部分功能增强，从而极大的简化spring-boot项目下http接口调用开发。

快速入门

引入依赖

        <!--Retrofit依赖-->
        <dependency>
            <groupId>com.github.lianjiatech</groupId>
            <artifactId>retrofit-spring-boot-starter</artifactId>
            <version>2.3.10</version>
        </dependency>

定义http接口，添加RetrofitClient

@RetrofitClient(baseUrl = "${remote.baseUrl}")
@Intercept(handler = TokenInterceptor.class)
public interface TestApi {

    @GET("greet")
    String greet();
}

添加拦截器

@Component
public class TokenInterceptor extends BasePathMatchInterceptor {
    @Override
    protected Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        System.out.println("intercept");
        return chain.proceed(request);
    }
}

注入使用

@SpringBootTest
public class RetrofitTest {

    @Autowired
    private TestApi testApi;

    @Test
    public void t1() {
        System.out.println(testApi.greet());
    }
}

在这里插入图片描述

源码分析

启动的核心是AutoConfiguredRetrofitScannerRegistrar。该类实现了ImportBeanDefinitionRegistrar，往容器中注入类型是RetrofitFactoryBean的bean对象。

    public void registerFilters() {
        AnnotationTypeFilter annotationTypeFilter = new AnnotationTypeFilter(RetrofitClient.class);
        this.addIncludeFilter(annotationTypeFilter);
    }

    private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
        Iterator var3 = beanDefinitions.iterator();

        while(var3.hasNext()) {
            BeanDefinitionHolder holder = (BeanDefinitionHolder)var3.next();
            GenericBeanDefinition definition = (GenericBeanDefinition)holder.getBeanDefinition();
            if (log.isDebugEnabled()) {
                log.debug("Creating RetrofitClientBean with name '" + holder.getBeanName() + "' and '" + definition.getBeanClassName() + "' Interface");
            }
 definition.getConstructorArgumentValues().addGenericArgumentValue(Objects.requireNonNull(definition.getBeanClassName()));
            definition.setBeanClass(RetrofitFactoryBean.class);
        }

    }

调用请求，会获取对应的RetrofitClient，执行RetrofitFactoryBean#getObject。RetrofitFactoryBean#createRetrofit该方法创建了Retrofit的对象，Retrofit#create，根据传入的class对象生成代理。

  public <T> T create(final Class<T> service) {
    validateServiceInterface(service);
    return (T)
        Proxy.newProxyInstance(
            service.getClassLoader(),
            new Class<?>[] {service},
            new InvocationHandler() {
              private final Platform platform = Platform.get();
              private final Object[] emptyArgs = new Object[0];

              @Override
              public @Nullable Object invoke(Object proxy, Method method, @Nullable Object[] args)
                  throws Throwable {
                // If the method is a method from Object then defer to normal invocation.
                if (method.getDeclaringClass() == Object.class) {
                  return method.invoke(this, args);
                }
                args = args != null ? args : emptyArgs;
                return platform.isDefaultMethod(method)
                    ? platform.invokeDefaultMethod(method, service, proxy, args)
                    : loadServiceMethod(method).invoke(args);
              }
            });
  }