Retrofit介绍

最新推荐文章于 2022-03-26 19:50:57 发布

時咣℡¹⁴³³²²³

最新推荐文章于 2022-03-26 19:50:57 发布

阅读量154

点赞数

分类专栏：学习 android 安卓文章标签： java android http

本文链接：https://blog.csdn.net/weixin_43976155/article/details/123487328

版权

android 同时被 3 个专栏收录

12 篇文章 0 订阅

订阅专栏

安卓

12 篇文章 0 订阅

订阅专栏

学习

11 篇文章 0 订阅

订阅专栏

Retrofit

官方文档：http://square.github.io/retrofit/

源码和例子，Github地址：https://github.com/square/retrofit

一、介绍

官网介绍：A type-safe HTTP client for Android and Java。Retrofit是一个类型安全的Android和Java网络Http请求框架。

1.1、请求方法

每个方法必须含有HTTP注解（请求方法和相对URL地址）。有5个内置的注解：GET, POST, PUT, DELETE, and HEAD。相对URL地址在注解中指定。

@GET("top250")

同样，可以在URL上指定查询参数。

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

1.2、URL操作

一个请求的URL可以使用替换块和参数来进行URL的动态的替换。替换块的格式：{字符串}。需要替换的部分需要使用相同的字符串和@Path注解。

@GET("{type}250")
Call<MovieEntity> getTopMovie(@Path("type") String type,@Query("start") int start, @Query("count") int count);

同样可以添加查询参数

@GET("top250")
Call<MovieEntity> getTopMovie(@Query("start") int start, @Query("count") int count);

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

@GET("{type}250")
Call<MovieEntity> getTopMovie(@Path("type") String type,@QueryMap Map<String,Integer> options);

Map<String,Integer> options = new HashMap<>();
options.put("start",1);
options.put("count",2);
Call<MovieEntity> topMovie = movieService.getTopMovie("top",options);

如果是POST请求，可以指定Http请求的请求体，使用@Body注解

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

表单@FormUrlEncoded 表示请求体是一个表单数据，表示发送form-encoded的数据。每个键值对需要使用@Filed来标注

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

文件上传@Multipart表示文件上传，表示发送form-encoded的数据。每个键值对需要使用@Part来标注

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

1.3、请求主体

使用@Body可以将一个对象作为HTTP的请求主体。

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

1.4、FORM ENCODED 和 MULTIPART

方法同样可以声明表单编码和复合数据。

表单编码数据发送当存在@FormUrlEncoded注解。每个键值对的key为@Filed的部分，Value为Object。

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

使用@Multipart来实现Multipart的请求。使用@Part注解来声明内容。

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

Multipart parts使用Retrofit的转换器，或者实现RequestBody。

请求头操作

使用@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,头就会被忽略掉。另外,valeu会进行toString。

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

如果请求头需要应用在每个请求上，请使用’OkHttp interceptor’

二、Retrofit的使用

2.1、配置依赖

在module的build.gradle中添加

// Retrofit
api "com.squareup.retrofit2:retrofit:2.3.0"
api "com.squareup.retrofit2:converter-gson:2.3.0"
api "com.squareup.retrofit2:adapter-rxjava2:2.3.0"
    
// OkHttp3
api "com.squareup.okhttp3:okhttp:3.10.0"
api "com.squareup.okhttp3:logging-interceptor:3.10.0"

// RxJava2
api "io.reactivex.rxjava2:rxjava:2.1.9"
api "io.reactivex.rxjava2:rxandroid:2.0.2"

// RxLifecycle
api "com.trello.rxlifecycle2:rxlifecycle:2.2.1"
api "com.trello.rxlifecycle2:rxlifecycle-android:2.2.1"
api "com.trello.rxlifecycle2:rxlifecycle-components:2.2.1"

2.2、实现

1、接口定义

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

2、创建Retrofit实例

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

3、调用接口

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

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

4、调用接口

// 请求数据，并且处理response
call.enqueue(new Callback<Repo>() {
    @Override
    public void onResponse(Response<Repo> author) {
        System.out.println("name： " + author.getName());
    }
    @Override
    public void onFailure(Throwable t) {
    }
});

每个Call实例可以执行同步或者异步请求。每个实例只能使用一次，但是可以使用clone()方法创建一个新的实例来操作。

在Android中，callback会在UI线程中执行，在JVM上，callback会在请求执行的线程上执行。

三、Retrofit的配置

1、数据解析器
Retrofit默认返回的是ResponseBody数据，如果不做特殊处理则需要自己处理转换。如果返回数据为JSON格式，通过添加Gson解析器可直接把JSON格式数据转换为实体类。

数据解析器	Gradle依赖
Gson	com.squareup.retrofit2:converter-gson:2.0.2
Jackson	com.squareup.retrofit2:converter-jackson:2.0.2
Simple XML	com.squareup.retrofit2:converter-simplexml:2.0.2
Protobuf	com.squareup.retrofit2:converter-protobuf:2.0.2
Moshi	com.squareup.retrofit2:converter-moshi:2.0.2
Wire	com.squareup.retrofit2:converter-wire:2.0.2
Scalars	com.squareup.retrofit2:converter-scalars:2.0.2

使用方式

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
                .build();

2、网络请求设配器
使用时如使用的是 Android 默认的 CallAdapter，则不需要添加网络请求适配器的依赖，否则则需要按照需求进行添加 Retrofit 提供的 CallAdapter

网络请求设配器	Gradle依赖
guava	com.squareup.retrofit2:adapter-guava:2.0.2
Java8	com.squareup.retrofit2:adapter-java8:2.0.2
rxjava	com.squareup.retrofit2:adapter-rxjava:2.0.2

使用方式

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava平台
                .build();