Retrofit是一个基于okhttp再封装的网络请求框架,其独特的注解式构建模式十分适合对MVP模式下的项目进行搭建。
首先是创建一个Retrofit对象,正如介绍上说的,它是基于okhttp进行再封装,因此一些特殊的设置需要直接使用到okhttp进行配置后使用。如网络请求超时时间,网络拦截器等等。如下:
//初始化okht
OkHttpClient okHttpClientLong = new OkHttpClient.Builder()
//连接主机超时时间
.connectTimeout(10, TimeUnit.SECONDS)
//从主机读取超时时间
.readTimeout(120, TimeUnit.SECONDS)
//上传到主机的超时时间
.writeTimeout(120, TimeUnit.SECONDS)
.build();
//初始化Retrofit对象
retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.client(okHttpClient)
.addConverterFactory(GsonConverterFactory.create())
.build();
有了Retrofit对象之后需要对不同的网络请求写对应请求方法,Retrofit的网络请求方法不同于一般的书写方式,而是通过定义一个interface,在该接口中使用注解完成对网络请求的设置。
首先最基础的便是网络请求方式,通过对方法名进行注解@GET或者@POST进行网络请求方法的定义。在注解中写入需要请求的url地址,需要注意一点,这里的URL可以是不完整的URL,当它不是一个完整的URL时,Retrofit会自动将其与之前创建Retrofit时设置的baseURL进行拼接。
网络请求方法中,通常需要一个Call的返回值,该返回值用于之后进行网络连接的创建和回调监听。并且Call对象是一个泛型对象,一般默认情况需要传人Okhttp的ResponseBody,这里就体现出来Retrofit另一个强大的功能点:转换器,通过设置不同的转换器可以得到不同的返回结果,常见的可以设置Gson转换器:GsonConverter,通过GsonConverterFactory.create()进行创建。有了Gson转换器后可以将网络请求的返回直接Json字符串直接转换成对应的实体类对象。
但是这样虽然很方便,但是如果没有一个强大的后台支持我建议你还是老老实实的使用ResponseBody进行手动解析,因为直接转换成实体类如果实体类和Json有丝毫的不匹配,便会导致解析出错,并且难以判断具体原因。(不要问我怎么知道的)
@GET("xxxx.xxxx")
Call<ResponseBody> getData();
除开这些常规的使用方法,以下是一些使用的进阶注解使用:
@Query(“id”)int Id,写在请求方法参数中,实现常规的请求行请求参数设置,即?id= Id格式。
@Body 写在请求方法参数中,实现POST请求体参数。通常传入RequestBody对象。
@Path(“path”) 写在请求方法参数中,可替换URL中{path}的对应值,即可以动态修改请求行参数。
其中请求体的常规定义方法如下:
//初始化分块请求体对象
MultipartBody.Builder builder = new MultipartBody.Builder();
//声明类型
builder.setType(MultipartBody.FORM);
//创建单个请求体,第一个参数为请求体文件的打开方式,第二个为文件的对象,通常是byte[]或者File对象
RequestBody music = RequestBody.create(MediaType.parse("audio/aac"), file);
//将单个请求体添加到分块请求体中,并且指定分块名称(重要)和文件名称(不重要)
builder.addFormDataPart("music", "music.aac", music);
//完成构建请求体
builder.build()