Retrofit的简单使用

引入相关依赖

implementation 'com.squareup.retrofit2:retrofit:2.5.0'
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'

在实例中,使用的是Gson对Json数据进行解析。

下面的实例是对github的接口进行请求:

(1)Retrofit将我们的Http请求转换为接口

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

(2)创建Retrofit对象

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

(3)创建访问API的请求:Retrofit创建GithubService接口的一个实现

GitHubService service = retrofit.create(GitHubService.class);

(4)新创建的GitHubService中的每个Call都能向远程的服务器发送同步或者异步的请求。

 Call> call=service.listRepos("qd");

(5)向服务器发送异步请求

 call.enqueue(new Callback>() {
            @Override
            public void onResponse(Call> call, Response> response) {
                if(response.isSuccessful())
                {
                    List list=response.body();

                    if(list!=null)
                    {
                        Log.e(TAG, "List Size:"+list.size());
                    }
                }
            }

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

            }
        });

Retrofit使用注解去描述请求:


URL参数替换和查询参数支持
对象请求主体的转换(例如,JSON,协议缓冲区)
多部分请求正文和文件上传

API声明
接口方法及其参数的注释表明如何处理请求

一、请求方法
每个方法都必须有一个HTTP注解,提供请求方法和相对URL。 有五个内置注解:GET,POST,PUT,DELETE和HEAD。 资源的相对URL在注释中指定。

@GET("users/list')

我们还可以在URL中指定参数。

@GET("users/list?sort=desc")

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

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

查询参数也可以被添加

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

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

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

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

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

还将使用Retrofit实例上指定的转换器转换对象。 如果未添加转换器,则只能使用RequestBody。

四、FORM ENCODED和MULTIPART
还可以声明方法以发送表单编码和多部分数据。
当方法上存在@FormUrlEncoded时,将发送表单编码数据。 每个键值对都使用包含名称的@Field和提供值的对象进行注释。

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

当方法中存在@Multipart时,将使用多部分请求。 使用@Part注释声明部件。

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

多部件使用Retrofit的转换器之一,或者他们可以实现RequestBody来处理自己的序列化。

五、头部操纵
您可以使用@Headers批注为方法设置静态标头。

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

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

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

与查询参数类似,对于复杂的标题组合,可以使用Map。

@GET("user")
Call getUser(@HeaderMap Map headers)

可以使用OkHttp拦截器指定需要添加到每个请求的标头。

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

Retrofit配置
Retrofit是将API接口转换为可调用对象的类。 默认情况下,Retrofit将为您的平台提供合理的默认值,但它允许自定义。

一、转换器
默认情况下,Retrofit只能将HTTP主体反序列化为OkHttp的ResponseBody类型,并且它只能接受@Body的RequestBody类型。

可以添加转换器以支持其他类型。 为了您的方便,六个兄弟模块适应流行的序列化库。

  • 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
  • Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

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

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

GitHubService service = retrofit.create(GitHubService.class);

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

你可能感兴趣的:(Retrofit的简单使用)