Retrofit的基本了解和简单使用

2024年1月22日 107次阅读 来源: 路过的人

Retrofit简介：

一款基于异步线程的网络请求框架，一款android安全类型的http客户端，支持线程安全，开发者无需关注线程问题，同样是基于链式编程思想的- 一款网络请求器。底层集成谷歌自身的Okhttp，它本身不具备http标准网络访问基础，它需要依okhttp进行网络访问，另外从Android4.4开始- HttpURLConnection的底层实现采用的是okHttp，最重要的时Retrofit完美支持 Rxjava，这里关于Retrofit的好处不做过多介绍。

官方介绍

一、简介

Retrofit可将HTTP API转换为Java接口

public interface GitHubService {@GET("users/{user}/repos")Call<List<Repo>> listRepos(@Path("user") String user);}

Retrofit类生成GitHubService接口的实现。

Retrofit retrofit = new Retrofit.Builder().baseUrl("https://api.github.com/").build();GitHubService service = retrofit.create(GitHubService.class);

每个来自创建GitHub服务的调用都可以向远程Web服务器发出同步或异步HTTP请求。

Call<List<Repo>> repos = service.listRepos("octocat");

使用注解描述HTTP请求：

*URL支持参数替换和查询参数

*对象转换为请求体（例如，JSON，协议缓冲区）

*多部分请求体和文件上传

二、API声明

通过接口方法及其参数的注解指导如何处理请求。

请求方法

每个方法必须具有提供请求方法和相对URL的HTTP注解。 有五个内置注解：GET，POST，PUT，DELETE和HEAD。 资源的相对URL在注解中指定。
@GET(“users/list”)
还可以在URL中指定查询参数。
@GET(“users/list?sort=desc”)

网址操作

可以使用替换块和方法上的参数动态更新请求URL。 替换块是由{和}包围的字母数字字符串。 相应的参数必须使用相同的字符串用@Path注解。

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId);

也可以添加查询参数。

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort)

对于复杂的查询参数组合，可以使用Map。

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

请求主体

可以指定一个带有@Body对象用作注解的HTTP请求主体。

@POST("users/new")Call<User> createUser(@Body User user);

注：该对象也将使用Retrofit实例上指定的转换器进行转换。 如果没有添加转换器，则只能使用RequestBody。

方法也可以声明为发送表单编码和多部分数据。

当方法上存在@FormUrlEncoded时，将发送表单编码的数据。 每个键值对都使用包含名称的@Field和提供值的对象进行注解。

@FormUrlEncoded@POST("user/edit")Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

当方法上存在@Multipart时，将使用多部分请求。 部分是被声明使用@Part注解。

@Multipart@PUT("user/photo")Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

多部分使用Retrofit的转换器，或者它们可以实现RequestBody来处理自己的序列化。

header操作

可以使用@Headers注解为方法设置静态头。

@Headers("Cache-Control: max-age=640000")@GET("widget/list")Call<List<Widget>> widgetList();
@Headers({"Accept: application/vnd.github.v3.full+json","User-Agent: Retrofit-Sample-App"})@GET("users/{username}")Call<User> getUser(@Path("username") String username);

请注意，头不会相互覆盖。 具有相同名称的所有头将包含在请求中。
请求头可以使用@Header注解动态更新。 必须向@Header提供相应的参数。 如果值为null，则将省略标题。 否则，toString将使用被调用的值做为结果。

@GET("user")Call<User> getUser(@Header("Authorization") String authorization)

头需要被添加到每个请求中，可被当做一个特定的OkHttp拦截器使用

同步 VS 异步

Call实例可以同步或异步执行。 每个实例只能使用一次，但调用clone（）将创建一个可以使用的新实例。
在Android上，回调将在主线程上执行。 在JVM上，回调将发生在执行HTTP请求的同一线程上。

三、Retrofit配置

Retrofit是将API接口转换为可调用对象的类。 默认情况下，Retrofit将为您的平台提供正常默认值，但允许自定义。

Converters（转换器）

默认情况下，Retrofit只能将HTTP主体反序列化为OkHttp的ResponseBody类型，并且它只能接受@Body的RequestBody类型
但是添加Converters可以支持其他类型，六个同级模块适应流行的序列化库，为您提供方便。
Gson: com.squareup.retrofit2:converter-gson
Jackson: com.squareup.retrofit2:converter-jackson
Moshi: com.squareup.retrofit2:converter-moshi
Protobuf: com.squareup.retrofit2:converter-protobuf
Wire: com.squareup.retrofit2:converter-wire
Simple XML: com.squareup.retrofit2:converter-simplexml

下面是一个使用GsonConverterFactory类来生成GitHubService接口的实现的示例，该接口使用Gson进行反序列化。

Retrofit retrofit = new Retrofit.Builder().baseUrl("https://api.github.com").addConverterFactory(GsonConverterFactory.create()).build();
GitHubService service = retrofit.create(GitHubService.class);

自定义转换器

如果您需要与使用Retrofit不支持模型即用的内容格式（例如YAML，txt，自定义格式）的API进行通信，或者您希望使用其他库来实现现有格式，则可以轻松创建 你自己的转换器。 创建一个扩展Converter.Factory类的类，并在构建适配器时传递实例。

支持Retrofit需要至少Java 7或Android 2.3。

如果在项目中使用Proguard（混淆），请在配置中添加以下行：

# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on RoboVM on iOS. Will not be used at runtime.
-dontnote retrofit2.Platform$IOS$MainThreadExecutor
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions

Retrofit API

使用声明：

Retrofit1.X与Retrofot2.X在初始化，网络请求、回调等有较大差异，本文是基于
Retrofit2.X。

1.添加依赖

    compile 'com.squareup.retrofit2:retrofit:2.1.0'
    compile 'com.squareup.retrofit2:converter-gson:2.1.0'
    compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'

备注：这里Retrofit2的各个版本号必须一致

2.创建Retrofit回调的接口

public interface WeatherApi {
    @GET("/microservice/weather?citypinyin=beijing")
    Call<WeatherBean> getWeather();
}

备注：@GET里面的是baseUrl的后缀，用于拼接完整的Url

3.初始化Retrofit实例

        String baseUrl = "http://apistore.baidu.com/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build();

4.用Retrofit创建接口的代理对象，操作接口方法

        WeatherApi weatherApi = retrofit.create(WeatherApi.class);
        Call<WeatherBean> weatherCall = weatherApi.getWeather();

备注：步骤3中的addConverterFactory(GsonConverterFactory.create())是对于
Call<T>中T的转换， 默认是Call<ResponseBody>转化成你自己的Call<Poju>

5.执行回调获取数据（同步/异步–execute/enqueue）

weatherCall.enqueue(new Callback<WeatherBean>() {
            @Override
            public void onResponse(Call<WeatherBean> call, Response<WeatherBean> response) {
                String weather = response.body().retData.weather;
                tv.setText(weather);
            }

            @Override
            public void onFailure(Call<WeatherBean> call, Throwable t) {

            }
        });

此篇简单介绍了Retrofit的简介和基本使用，下一篇会介绍对其接口中注解的理
解以及配合Okhttp实现网络响应信息拦截
代码托管地址

    原文作者：路过的人
    原文地址: https://www.jianshu.com/p/d7e9e0cc49ee
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞