初探 Retrofit (入门)
Retrofit 是什么?
简单来说是用来做网络请求的,适用于 android 但又不仅是 android ,java 工程也是可以用的。
官网传送:http://square.github.io/retrofit/
github 传送:https://github.com/square/retrofit
Retrofit 有什么特点?
现有的网络请求工具或者框架很多,为什么还会出现 retrofit 呢?官网解释「A type-safe HTTP client for Android and Java」,用了之后就能体会到了。 retrofit 的另外一个特点是使用注解,带来的好处是
简化了代码,提高开发效率。同时 retrofit 还将请求接口以 interface 方法呈现,写起来简洁明了。
Retrofit 怎么用?
retrofit 其实是对 okhttp 做了一层封装,用过 okhttp 的或多或少都对其做过封装,但可能有简有繁,我之所以想要了解 retrofit 也是因为它帮我们做了封装,让我们摆脱繁冗的“搬砖作业”,集中在业务逻辑或者用户体验等方面。所以别看 retrofit 是个新东西,其实和我们自己做的本质上差不多,只是实现上更简练和升华。
我已 android 项目为例,简单介绍使用。
1 implementation 'com.squareup.retrofit2:retrofit:2.4.0'
首页是要添加依赖,目前最新版本是 2.4.0,大家可以根据情况更改版本号。
2 添加 Interface ,用来编写请求 api 用。一般请求用的比较多的是 POST 和 GET 方式,其他的我就先不考虑了。我的理解是这个 interface 是可以写下所有接口服务方法的,所以我就打算写在一个 interface 里,一来方便管理查找,二来省去很多文件。
public interface ApiServiceFactory {
// post 请求,入参有多个字段
@POST("你要用的接口地址")
Call<SampleModel> loginReq(@Body LoginReq req);
// post 请求,入参有一个或者多个字段
@POST("你要用的接口地址")
Call<SampleModel> checkVersion(@Body Map<String, Object> version);
// get 请求,用作下载文件
@GET
Call<ResponseBody> getApk(@Url String url);
}
上面是我写的 interface,里面有三个方法,两个 post 请求,一个 get 请求。具体 post 请求怎么写呢?往下看
先写方法,照葫芦画瓢就行,填上想要的返回体,方法入参中,@Body 是固定用来表示 post 请求的请求入参的,后面跟着请求体就行。
加上请求方式的注解。
这样一个请求服务就写好了。
上面讲的是以 post 请求为例,如果是 get 请求,把 @Body 换成 @Query 或者 @QueryMap 就行。因为 get 请求用的少,所以就不在详写。
大家留意一下,第二个请求和第一个虽都是 post 请求,但入参有点不同,我是考虑到,如果入参只有一个字段,那为此添加一个请求体,然后只有一个成员变量,有点浪费,所以我就用 Map ,里面塞这么一个字段就好了,所以才会有第二个请求的例子,当然用 Map 放多个字段也可以,只是多个字段用 Map 来处理反而没有第一个请求入参来的方便了。
第三个请求是 get 请求,但它又是用来下载文件(例如下载新版本 app)用的,特殊的地方在于返回体是 ResponseBody 这个是 Okhttp 的,方法入参里只有请求地址(文件地址)用 @Url 来标识。
3 创建 retrofit 对象,创建接口服务,并发起请求。
Retrofit retrofit = new Retrofit.Builder().baseUrl("你所要访问的服务器地址").build();
ApiServiceFactory service = retrofit.create(ApiServiceFactory.class);
Call<SampleModel> call = service.checkVersion(requestMap);
//如果是异步请求
call.enqueue(new Callback<SampleModel>() {
@Override
public void onResponse(Call<SampleModel> call, Response<SampleModel> response) {
}
@Override
public void onFailure(Call<SampleModel> call, Throwable t) {
}
});
// 如果是同步请求
Response<SampleModel> resp = call.execute();
上面的代码就是完成一个请求的过程,首先创建 retrofit,再创建 service,最后 service 调用相应的方法发起请求。
但是这里还有一点需要配置,如果按着上面发起请求的话,应该会报错,错误应该是数据转换的问题,原因是我们在创建 retrofit 对象的时候少配置了数据转换,那么我们现在配上。
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.baseUrl("你所要访问的服务器地址").build();
就是中间这句代码,让请求回调知道了,数据类型是以 gson 格式来的,不过还有其他格式,只是一般使用时以 gson,json 居多,我就用这个了。要想配置这个,还要在 gradle 里面添加
implementation 'com.squareup.retrofit2:converter-gson:2.4.0'
这样才算真正的完整了,我特意留了这个坑,因为我在写的时候故意不配,结果确实不行,所以还是加上了这些。
好了,照着上面这么操作下来,就算是会用 retrofit 了,当然真正实际在项目用起来可能没这么粗糙,深入的东西我们后面再说(例如怎么和 Rxjava 扯上关系的等等)。